3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to buiuld it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
306 * @brief Elementary's API
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
322 /* Standard headers for standard system calls etc. */
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
343 # ifdef ELM_LIBINTL_H
344 # include <libintl.h>
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
358 # define alloca _alloca
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
386 # include <Ethumb_Client.h>
398 # ifdef ELEMENTARY_BUILD
400 # define EAPI __declspec(dllexport)
403 # endif /* ! DLL_EXPORT */
405 # define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
410 # define EAPI __attribute__ ((visibility("default")))
417 #endif /* ! _WIN32 */
420 /* allow usage from c++ */
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
428 typedef struct _Elm_Version
436 EAPI extern Elm_Version *elm_version;
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
443 * @defgroup General General
445 * @brief General Elementary API. Functions that don't relate to
446 * Elementary objects specifically.
448 * Here are documented functions which init/shutdown the library,
449 * that apply to generic Elementary objects, that deal with
450 * configuration, et cetera.
452 * @ref general_functions_example_page "This" example contemplates
453 * some of these functions.
457 * @addtogroup General
462 * Defines couple of standard Evas_Object layers to be used
463 * with evas_object_layer_set().
465 * @note whenever extending with new values, try to keep some padding
466 * to siblings so there is room for further extensions.
468 typedef enum _Elm_Object_Layer
470 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
478 /**************************************************************************/
479 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
482 * Emitted when any Elementary's policy value is changed.
484 EAPI extern int ELM_EVENT_POLICY_CHANGED;
487 * @typedef Elm_Event_Policy_Changed
489 * Data on the event when an Elementary policy has changed
491 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
494 * @struct _Elm_Event_Policy_Changed
496 * Data on the event when an Elementary policy has changed
498 struct _Elm_Event_Policy_Changed
500 unsigned int policy; /**< the policy identifier */
501 int new_value; /**< value the policy had before the change */
502 int old_value; /**< new value the policy got */
506 * Policy identifiers.
508 typedef enum _Elm_Policy
510 ELM_POLICY_QUIT, /**< under which circunstances the application
511 * should quit automatically. @see
515 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
518 typedef enum _Elm_Policy_Quit
520 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
522 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
524 * window is closed */
525 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
527 typedef enum _Elm_Focus_Direction
531 } Elm_Focus_Direction;
533 typedef enum _Elm_Text_Format
535 ELM_TEXT_FORMAT_PLAIN_UTF8,
536 ELM_TEXT_FORMAT_MARKUP_UTF8
540 * Line wrapping types.
542 typedef enum _Elm_Wrap_Type
544 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552 * @typedef Elm_Object_Item
553 * An Elementary Object item handle.
556 typedef struct _Elm_Object_Item Elm_Object_Item;
560 * Called back when a widget's tooltip is activated and needs content.
561 * @param data user-data given to elm_object_tooltip_content_cb_set()
562 * @param obj owner widget.
563 * @param tooltip The tooltip object (affix content to this!)
565 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
568 * Called back when a widget's item tooltip is activated and needs content.
569 * @param data user-data given to elm_object_tooltip_content_cb_set()
570 * @param obj owner widget.
571 * @param tooltip The tooltip object (affix content to this!)
572 * @param item context dependent item. As an example, if tooltip was
573 * set on Elm_List_Item, then it is of this type.
575 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
577 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
585 /**************************************************************************/
589 * Initialize Elementary
591 * @param[in] argc System's argument count value
592 * @param[in] argv System's pointer to array of argument strings
593 * @return The init counter value.
595 * This function initializes Elementary and increments a counter of
596 * the number of calls to it. It returs the new counter's value.
598 * @warning This call is exported only for use by the @c ELM_MAIN()
599 * macro. There is no need to use this if you use this macro (which
600 * is highly advisable). An elm_main() should contain the entry
601 * point code for your application, having the same prototype as
602 * elm_init(), and @b not being static (putting the @c EAPI symbol
603 * in front of its type declaration is advisable). The @c
604 * ELM_MAIN() call should be placed just after it.
607 * @dontinclude bg_example_01.c
611 * See the full @ref bg_example_01_c "example".
613 * @see elm_shutdown().
616 EAPI int elm_init(int argc, char **argv);
619 * Shut down Elementary
621 * @return The init counter value.
623 * This should be called at the end of your application, just
624 * before it ceases to do any more processing. This will clean up
625 * any permanent resources your application may have allocated via
626 * Elementary that would otherwise persist.
628 * @see elm_init() for an example
632 EAPI int elm_shutdown(void);
635 * Run Elementary's main loop
637 * This call should be issued just after all initialization is
638 * completed. This function will not return until elm_exit() is
639 * called. It will keep looping, running the main
640 * (event/processing) loop for Elementary.
642 * @see elm_init() for an example
646 EAPI void elm_run(void);
649 * Exit Elementary's main loop
651 * If this call is issued, it will flag the main loop to cease
652 * processing and return back to its parent function (usually your
653 * elm_main() function).
655 * @see elm_init() for an example. There, just after a request to
656 * close the window comes, the main loop will be left.
658 * @note By using the #ELM_POLICY_QUIT on your Elementary
659 * applications, you'll this function called automatically for you.
663 EAPI void elm_exit(void);
666 * Provide information in order to make Elementary determine the @b
667 * run time location of the software in question, so other data files
668 * such as images, sound files, executable utilities, libraries,
669 * modules and locale files can be found.
671 * @param mainfunc This is your application's main function name,
672 * whose binary's location is to be found. Providing @c NULL
673 * will make Elementary not to use it
674 * @param dom This will be used as the application's "domain", in the
675 * form of a prefix to any environment variables that may
676 * override prefix detection and the directory name, inside the
677 * standard share or data directories, where the software's
678 * data files will be looked for.
679 * @param checkfile This is an (optional) magic file's path to check
680 * for existence (and it must be located in the data directory,
681 * under the share directory provided above). Its presence will
682 * help determine the prefix found was correct. Pass @c NULL if
683 * the check is not to be done.
685 * This function allows one to re-locate the application somewhere
686 * else after compilation, if the developer wishes for easier
687 * distribution of pre-compiled binaries.
689 * The prefix system is designed to locate where the given software is
690 * installed (under a common path prefix) at run time and then report
691 * specific locations of this prefix and common directories inside
692 * this prefix like the binary, library, data and locale directories,
693 * through the @c elm_app_*_get() family of functions.
695 * Call elm_app_info_set() early on before you change working
696 * directory or anything about @c argv[0], so it gets accurate
699 * It will then try and trace back which file @p mainfunc comes from,
700 * if provided, to determine the application's prefix directory.
702 * The @p dom parameter provides a string prefix to prepend before
703 * environment variables, allowing a fallback to @b specific
704 * environment variables to locate the software. You would most
705 * probably provide a lowercase string there, because it will also
706 * serve as directory domain, explained next. For environment
707 * variables purposes, this string is made uppercase. For example if
708 * @c "myapp" is provided as the prefix, then the program would expect
709 * @c "MYAPP_PREFIX" as a master environment variable to specify the
710 * exact install prefix for the software, or more specific environment
711 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713 * the user or scripts before launching. If not provided (@c NULL),
714 * environment variables will not be used to override compiled-in
715 * defaults or auto detections.
717 * The @p dom string also provides a subdirectory inside the system
718 * shared data directory for data files. For example, if the system
719 * directory is @c /usr/local/share, then this directory name is
720 * appended, creating @c /usr/local/share/myapp, if it @p was @c
721 * "myapp". It is expected the application installs data files in
724 * The @p checkfile is a file name or path of something inside the
725 * share or data directory to be used to test that the prefix
726 * detection worked. For example, your app will install a wallpaper
727 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
731 * @see elm_app_compile_bin_dir_set()
732 * @see elm_app_compile_lib_dir_set()
733 * @see elm_app_compile_data_dir_set()
734 * @see elm_app_compile_locale_set()
735 * @see elm_app_prefix_dir_get()
736 * @see elm_app_bin_dir_get()
737 * @see elm_app_lib_dir_get()
738 * @see elm_app_data_dir_get()
739 * @see elm_app_locale_dir_get()
741 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
744 * Provide information on the @b fallback application's binaries
745 * directory, on scenarios where they get overriden by
746 * elm_app_info_set().
748 * @param dir The path to the default binaries directory (compile time
751 * @note Elementary will as well use this path to determine actual
752 * names of binaries' directory paths, maybe changing it to be @c
753 * something/local/bin instead of @c something/bin, only, for
756 * @warning You should call this function @b before
757 * elm_app_info_set().
759 EAPI void elm_app_compile_bin_dir_set(const char *dir);
762 * Provide information on the @b fallback application's libraries
763 * directory, on scenarios where they get overriden by
764 * elm_app_info_set().
766 * @param dir The path to the default libraries directory (compile
769 * @note Elementary will as well use this path to determine actual
770 * names of libraries' directory paths, maybe changing it to be @c
771 * something/lib32 or @c something/lib64 instead of @c something/lib,
774 * @warning You should call this function @b before
775 * elm_app_info_set().
777 EAPI void elm_app_compile_lib_dir_set(const char *dir);
780 * Provide information on the @b fallback application's data
781 * directory, on scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default data directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of data directory paths, maybe changing it to be @c
789 * something/local/share instead of @c something/share, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_data_dir_set(const char *dir);
798 * Provide information on the @b fallback application's locale
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default locale directory (compile time
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_locale_set(const char *dir);
811 * Retrieve the application's run time prefix directory, as set by
812 * elm_app_info_set() and the way (environment) the application was
815 * @return The directory prefix the application is actually using
817 EAPI const char *elm_app_prefix_dir_get(void);
820 * Retrieve the application's run time binaries prefix directory, as
821 * set by elm_app_info_set() and the way (environment) the application
824 * @return The binaries directory prefix the application is actually
827 EAPI const char *elm_app_bin_dir_get(void);
830 * Retrieve the application's run time libraries prefix directory, as
831 * set by elm_app_info_set() and the way (environment) the application
834 * @return The libraries directory prefix the application is actually
837 EAPI const char *elm_app_lib_dir_get(void);
840 * Retrieve the application's run time data prefix directory, as
841 * set by elm_app_info_set() and the way (environment) the application
844 * @return The data directory prefix the application is actually
847 EAPI const char *elm_app_data_dir_get(void);
850 * Retrieve the application's run time locale prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The locale directory prefix the application is actually
857 EAPI const char *elm_app_locale_dir_get(void);
859 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
860 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
861 EAPI int elm_quicklaunch_init(int argc, char **argv);
862 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
863 EAPI int elm_quicklaunch_sub_shutdown(void);
864 EAPI int elm_quicklaunch_shutdown(void);
865 EAPI void elm_quicklaunch_seed(void);
866 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
867 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868 EAPI void elm_quicklaunch_cleanup(void);
869 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
870 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
872 EAPI Eina_Bool elm_need_efreet(void);
873 EAPI Eina_Bool elm_need_e_dbus(void);
876 * This must be called before any other function that handle with
877 * elm_thumb objects or ethumb_client instances.
881 EAPI Eina_Bool elm_need_ethumb(void);
884 * Set a new policy's value (for a given policy group/identifier).
886 * @param policy policy identifier, as in @ref Elm_Policy.
887 * @param value policy value, which depends on the identifier
889 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
891 * Elementary policies define applications' behavior,
892 * somehow. These behaviors are divided in policy groups (see
893 * #Elm_Policy enumeration). This call will emit the Ecore event
894 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
898 * @note Currently, we have only one policy identifier/group
899 * (#ELM_POLICY_QUIT), which has two possible values.
903 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
906 * Gets the policy value set for given policy identifier.
908 * @param policy policy identifier, as in #Elm_Policy.
909 * @return The currently set policy value, for that
910 * identifier. Will be @c 0 if @p policy passed is invalid.
914 EAPI int elm_policy_get(unsigned int policy);
917 * Set a label of an object
919 * @param obj The Elementary object
920 * @param part The text part name to set (NULL for the default label)
921 * @param label The new text of the label
923 * @note Elementary objects may have many labels (e.g. Action Slider)
927 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
932 * Get a label of an object
934 * @param obj The Elementary object
935 * @param part The text part name to get (NULL for the default label)
936 * @return text of the label or NULL for any error
938 * @note Elementary objects may have many labels (e.g. Action Slider)
942 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
947 * Set a content of an object
949 * @param obj The Elementary object
950 * @param part The content part name to set (NULL for the default content)
951 * @param content The new content of the object
953 * @note Elementary objects may have many contents
957 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
962 * Get a content of an object
964 * @param obj The Elementary object
965 * @param item The content part name to get (NULL for the default content)
966 * @return content of the object or NULL for any error
968 * @note Elementary objects may have many contents
972 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
977 * Unset a content of an object
979 * @param obj The Elementary object
980 * @param item The content part name to unset (NULL for the default content)
982 * @note Elementary objects may have many contents
986 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
991 * Set a content of an object item
993 * @param it The Elementary object item
994 * @param part The content part name to unset (NULL for the default content)
995 * @param content The new content of the object item
997 * @note Elementary object items may have many contents
1001 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1006 * Get a content of an object item
1008 * @param it The Elementary object item
1009 * @param part The content part name to unset (NULL for the default content)
1010 * @return content of the object item or NULL for any error
1012 * @note Elementary object items may have many contents
1016 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1021 * Unset a content of an object item
1023 * @param it The Elementary object item
1024 * @param part The content part name to unset (NULL for the default content)
1026 * @note Elementary object items may have many contents
1030 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1035 * Set a label of an objec itemt
1037 * @param it The Elementary object item
1038 * @param part The text part name to set (NULL for the default label)
1039 * @param label The new text of the label
1041 * @note Elementary object items may have many labels
1045 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1050 * Get a label of an object
1052 * @param it The Elementary object item
1053 * @param part The text part name to get (NULL for the default label)
1054 * @return text of the label or NULL for any error
1056 * @note Elementary object items may have many labels
1060 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1062 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1069 * @defgroup Caches Caches
1071 * These are functions which let one fine-tune some cache values for
1072 * Elementary applications, thus allowing for performance adjustments.
1078 * @brief Flush all caches.
1080 * Frees all data that was in cache and is not currently being used to reduce
1081 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1082 * to calling all of the following functions:
1083 * @li edje_file_cache_flush()
1084 * @li edje_collection_cache_flush()
1085 * @li eet_clearcache()
1086 * @li evas_image_cache_flush()
1087 * @li evas_font_cache_flush()
1088 * @li evas_render_dump()
1089 * @note Evas caches are flushed for every canvas associated with a window.
1093 EAPI void elm_all_flush(void);
1096 * Get the configured cache flush interval time
1098 * This gets the globally configured cache flush interval time, in
1101 * @return The cache flush interval time
1104 * @see elm_all_flush()
1106 EAPI int elm_cache_flush_interval_get(void);
1109 * Set the configured cache flush interval time
1111 * This sets the globally configured cache flush interval time, in ticks
1113 * @param size The cache flush interval time
1116 * @see elm_all_flush()
1118 EAPI void elm_cache_flush_interval_set(int size);
1121 * Set the configured cache flush interval time for all applications on the
1124 * This sets the globally configured cache flush interval time -- in ticks
1125 * -- for all applications on the display.
1127 * @param size The cache flush interval time
1130 EAPI void elm_cache_flush_interval_all_set(int size);
1133 * Get the configured cache flush enabled state
1135 * This gets the globally configured cache flush state - if it is enabled
1136 * or not. When cache flushing is enabled, elementary will regularly
1137 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1138 * memory and allow usage to re-seed caches and data in memory where it
1139 * can do so. An idle application will thus minimise its memory usage as
1140 * data will be freed from memory and not be re-loaded as it is idle and
1141 * not rendering or doing anything graphically right now.
1143 * @return The cache flush state
1146 * @see elm_all_flush()
1148 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1151 * Set the configured cache flush enabled state
1153 * This sets the globally configured cache flush enabled state
1155 * @param size The cache flush enabled state
1158 * @see elm_all_flush()
1160 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1163 * Set the configured cache flush enabled state for all applications on the
1166 * This sets the globally configured cache flush enabled state for all
1167 * applications on the display.
1169 * @param size The cache flush enabled state
1172 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1175 * Get the configured font cache size
1177 * This gets the globally configured font cache size, in bytes
1179 * @return The font cache size
1182 EAPI int elm_font_cache_get(void);
1185 * Set the configured font cache size
1187 * This sets the globally configured font cache size, in bytes
1189 * @param size The font cache size
1192 EAPI void elm_font_cache_set(int size);
1195 * Set the configured font cache size for all applications on the
1198 * This sets the globally configured font cache size -- in bytes
1199 * -- for all applications on the display.
1201 * @param size The font cache size
1204 EAPI void elm_font_cache_all_set(int size);
1207 * Get the configured image cache size
1209 * This gets the globally configured image cache size, in bytes
1211 * @return The image cache size
1214 EAPI int elm_image_cache_get(void);
1217 * Set the configured image cache size
1219 * This sets the globally configured image cache size, in bytes
1221 * @param size The image cache size
1224 EAPI void elm_image_cache_set(int size);
1227 * Set the configured image cache size for all applications on the
1230 * This sets the globally configured image cache size -- in bytes
1231 * -- for all applications on the display.
1233 * @param size The image cache size
1236 EAPI void elm_image_cache_all_set(int size);
1239 * Get the configured edje file cache size.
1241 * This gets the globally configured edje file cache size, in number
1244 * @return The edje file cache size
1247 EAPI int elm_edje_file_cache_get(void);
1250 * Set the configured edje file cache size
1252 * This sets the globally configured edje file cache size, in number
1255 * @param size The edje file cache size
1258 EAPI void elm_edje_file_cache_set(int size);
1261 * Set the configured edje file cache size for all applications on the
1264 * This sets the globally configured edje file cache size -- in number
1265 * of files -- for all applications on the display.
1267 * @param size The edje file cache size
1270 EAPI void elm_edje_file_cache_all_set(int size);
1273 * Get the configured edje collections (groups) cache size.
1275 * This gets the globally configured edje collections cache size, in
1276 * number of collections.
1278 * @return The edje collections cache size
1281 EAPI int elm_edje_collection_cache_get(void);
1284 * Set the configured edje collections (groups) cache size
1286 * This sets the globally configured edje collections cache size, in
1287 * number of collections.
1289 * @param size The edje collections cache size
1292 EAPI void elm_edje_collection_cache_set(int size);
1295 * Set the configured edje collections (groups) cache size for all
1296 * applications on the display
1298 * This sets the globally configured edje collections cache size -- in
1299 * number of collections -- for all applications on the display.
1301 * @param size The edje collections cache size
1304 EAPI void elm_edje_collection_cache_all_set(int size);
1311 * @defgroup Scaling Widget Scaling
1313 * Different widgets can be scaled independently. These functions
1314 * allow you to manipulate this scaling on a per-widget basis. The
1315 * object and all its children get their scaling factors multiplied
1316 * by the scale factor set. This is multiplicative, in that if a
1317 * child also has a scale size set it is in turn multiplied by its
1318 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1319 * double size, @c 0.5 is half, etc.
1321 * @ref general_functions_example_page "This" example contemplates
1322 * some of these functions.
1326 * Get the global scaling factor
1328 * This gets the globally configured scaling factor that is applied to all
1331 * @return The scaling factor
1334 EAPI double elm_scale_get(void);
1337 * Set the global scaling factor
1339 * This sets the globally configured scaling factor that is applied to all
1342 * @param scale The scaling factor to set
1345 EAPI void elm_scale_set(double scale);
1348 * Set the global scaling factor for all applications on the display
1350 * This sets the globally configured scaling factor that is applied to all
1351 * objects for all applications.
1352 * @param scale The scaling factor to set
1355 EAPI void elm_scale_all_set(double scale);
1358 * Set the scaling factor for a given Elementary object
1360 * @param obj The Elementary to operate on
1361 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1366 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1369 * Get the scaling factor for a given Elementary object
1371 * @param obj The object
1372 * @return The scaling factor set by elm_object_scale_set()
1376 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1379 * @defgroup UI-Mirroring Selective Widget mirroring
1381 * These functions allow you to set ui-mirroring on specific
1382 * widgets or the whole interface. Widgets can be in one of two
1383 * modes, automatic and manual. Automatic means they'll be changed
1384 * according to the system mirroring mode and manual means only
1385 * explicit changes will matter. You are not supposed to change
1386 * mirroring state of a widget set to automatic, will mostly work,
1387 * but the behavior is not really defined.
1392 EAPI Eina_Bool elm_mirrored_get(void);
1393 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1396 * Get the system mirrored mode. This determines the default mirrored mode
1399 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1401 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * Set the system mirrored mode. This determines the default mirrored mode
1407 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1409 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1412 * Returns the widget's mirrored mode setting.
1414 * @param obj The widget.
1415 * @return mirrored mode setting of the object.
1418 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1421 * Sets the widget's mirrored mode setting.
1422 * When widget in automatic mode, it follows the system mirrored mode set by
1423 * elm_mirrored_set().
1424 * @param obj The widget.
1425 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1427 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1434 * Set the style to use by a widget
1436 * Sets the style name that will define the appearance of a widget. Styles
1437 * vary from widget to widget and may also be defined by other themes
1438 * by means of extensions and overlays.
1440 * @param obj The Elementary widget to style
1441 * @param style The style name to use
1443 * @see elm_theme_extension_add()
1444 * @see elm_theme_extension_del()
1445 * @see elm_theme_overlay_add()
1446 * @see elm_theme_overlay_del()
1450 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1452 * Get the style used by the widget
1454 * This gets the style being used for that widget. Note that the string
1455 * pointer is only valid as longas the object is valid and the style doesn't
1458 * @param obj The Elementary widget to query for its style
1459 * @return The style name used
1461 * @see elm_object_style_set()
1465 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1468 * @defgroup Styles Styles
1470 * Widgets can have different styles of look. These generic API's
1471 * set styles of widgets, if they support them (and if the theme(s)
1474 * @ref general_functions_example_page "This" example contemplates
1475 * some of these functions.
1479 * Set the disabled state of an Elementary object.
1481 * @param obj The Elementary object to operate on
1482 * @param disabled The state to put in in: @c EINA_TRUE for
1483 * disabled, @c EINA_FALSE for enabled
1485 * Elementary objects can be @b disabled, in which state they won't
1486 * receive input and, in general, will be themed differently from
1487 * their normal state, usually greyed out. Useful for contexts
1488 * where you don't want your users to interact with some of the
1489 * parts of you interface.
1491 * This sets the state for the widget, either disabling it or
1496 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1499 * Get the disabled state of an Elementary object.
1501 * @param obj The Elementary object to operate on
1502 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1503 * if it's enabled (or on errors)
1505 * This gets the state of the widget, which might be enabled or disabled.
1509 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1512 * @defgroup WidgetNavigation Widget Tree Navigation.
1514 * How to check if an Evas Object is an Elementary widget? How to
1515 * get the first elementary widget that is parent of the given
1516 * object? These are all covered in widget tree navigation.
1518 * @ref general_functions_example_page "This" example contemplates
1519 * some of these functions.
1523 * Check if the given Evas Object is an Elementary widget.
1525 * @param obj the object to query.
1526 * @return @c EINA_TRUE if it is an elementary widget variant,
1527 * @c EINA_FALSE otherwise
1528 * @ingroup WidgetNavigation
1530 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1533 * Get the first parent of the given object that is an Elementary
1536 * @param obj the Elementary object to query parent from.
1537 * @return the parent object that is an Elementary widget, or @c
1538 * NULL, if it was not found.
1540 * Use this to query for an object's parent widget.
1542 * @note Most of Elementary users wouldn't be mixing non-Elementary
1543 * smart objects in the objects tree of an application, as this is
1544 * an advanced usage of Elementary with Evas. So, except for the
1545 * application's window, which is the root of that tree, all other
1546 * objects would have valid Elementary widget parents.
1548 * @ingroup WidgetNavigation
1550 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Get the top level parent of an Elementary widget.
1555 * @param obj The object to query.
1556 * @return The top level Elementary widget, or @c NULL if parent cannot be
1558 * @ingroup WidgetNavigation
1560 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * Get the string that represents this Elementary widget.
1565 * @note Elementary is weird and exposes itself as a single
1566 * Evas_Object_Smart_Class of type "elm_widget", so
1567 * evas_object_type_get() always return that, making debug and
1568 * language bindings hard. This function tries to mitigate this
1569 * problem, but the solution is to change Elementary to use
1570 * proper inheritance.
1572 * @param obj the object to query.
1573 * @return Elementary widget name, or @c NULL if not a valid widget.
1574 * @ingroup WidgetNavigation
1576 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 * @defgroup Config Elementary Config
1581 * Elementary configuration is formed by a set options bounded to a
1582 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1583 * "finger size", etc. These are functions with which one syncronizes
1584 * changes made to those values to the configuration storing files, de
1585 * facto. You most probably don't want to use the functions in this
1586 * group unlees you're writing an elementary configuration manager.
1592 * Save back Elementary's configuration, so that it will persist on
1595 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1598 * This function will take effect -- thus, do I/O -- immediately. Use
1599 * it when you want to apply all configuration changes at once. The
1600 * current configuration set will get saved onto the current profile
1601 * configuration file.
1604 EAPI Eina_Bool elm_config_save(void);
1607 * Reload Elementary's configuration, bounded to current selected
1610 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1613 * Useful when you want to force reloading of configuration values for
1614 * a profile. If one removes user custom configuration directories,
1615 * for example, it will force a reload with system values insted.
1618 EAPI void elm_config_reload(void);
1625 * @defgroup Profile Elementary Profile
1627 * Profiles are pre-set options that affect the whole look-and-feel of
1628 * Elementary-based applications. There are, for example, profiles
1629 * aimed at desktop computer applications and others aimed at mobile,
1630 * touchscreen-based ones. You most probably don't want to use the
1631 * functions in this group unlees you're writing an elementary
1632 * configuration manager.
1638 * Get Elementary's profile in use.
1640 * This gets the global profile that is applied to all Elementary
1643 * @return The profile's name
1646 EAPI const char *elm_profile_current_get(void);
1649 * Get an Elementary's profile directory path in the filesystem. One
1650 * may want to fetch a system profile's dir or an user one (fetched
1653 * @param profile The profile's name
1654 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1655 * or a system one (@c EINA_FALSE)
1656 * @return The profile's directory path.
1659 * @note You must free it with elm_profile_dir_free().
1661 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1664 * Free an Elementary's profile directory path, as returned by
1665 * elm_profile_dir_get().
1667 * @param p_dir The profile's path
1671 EAPI void elm_profile_dir_free(const char *p_dir);
1674 * Get Elementary's list of available profiles.
1676 * @return The profiles list. List node data are the profile name
1680 * @note One must free this list, after usage, with the function
1681 * elm_profile_list_free().
1683 EAPI Eina_List *elm_profile_list_get(void);
1686 * Free Elementary's list of available profiles.
1688 * @param l The profiles list, as returned by elm_profile_list_get().
1692 EAPI void elm_profile_list_free(Eina_List *l);
1695 * Set Elementary's profile.
1697 * This sets the global profile that is applied to Elementary
1698 * applications. Just the process the call comes from will be
1701 * @param profile The profile's name
1705 EAPI void elm_profile_set(const char *profile);
1708 * Set Elementary's profile.
1710 * This sets the global profile that is applied to all Elementary
1711 * applications. All running Elementary windows will be affected.
1713 * @param profile The profile's name
1717 EAPI void elm_profile_all_set(const char *profile);
1724 * @defgroup Engine Elementary Engine
1726 * These are functions setting and querying which rendering engine
1727 * Elementary will use for drawing its windows' pixels.
1729 * The following are the available engines:
1730 * @li "software_x11"
1733 * @li "software_16_x11"
1734 * @li "software_8_x11"
1737 * @li "software_gdi"
1738 * @li "software_16_wince_gdi"
1740 * @li "software_16_sdl"
1748 * @brief Get Elementary's rendering engine in use.
1750 * @return The rendering engine's name
1751 * @note there's no need to free the returned string, here.
1753 * This gets the global rendering engine that is applied to all Elementary
1756 * @see elm_engine_set()
1758 EAPI const char *elm_engine_current_get(void);
1761 * @brief Set Elementary's rendering engine for use.
1763 * @param engine The rendering engine's name
1765 * This sets global rendering engine that is applied to all Elementary
1766 * applications. Note that it will take effect only to Elementary windows
1767 * created after this is called.
1769 * @see elm_win_add()
1771 EAPI void elm_engine_set(const char *engine);
1778 * @defgroup Fonts Elementary Fonts
1780 * These are functions dealing with font rendering, selection and the
1781 * like for Elementary applications. One might fetch which system
1782 * fonts are there to use and set custom fonts for individual classes
1783 * of UI items containing text (text classes).
1788 typedef struct _Elm_Text_Class
1794 typedef struct _Elm_Font_Overlay
1796 const char *text_class;
1798 Evas_Font_Size size;
1801 typedef struct _Elm_Font_Properties
1805 } Elm_Font_Properties;
1808 * Get Elementary's list of supported text classes.
1810 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1813 * Release the list with elm_text_classes_list_free().
1815 EAPI const Eina_List *elm_text_classes_list_get(void);
1818 * Free Elementary's list of supported text classes.
1822 * @see elm_text_classes_list_get().
1824 EAPI void elm_text_classes_list_free(const Eina_List *list);
1827 * Get Elementary's list of font overlays, set with
1828 * elm_font_overlay_set().
1830 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1835 * For each text class, one can set a <b>font overlay</b> for it,
1836 * overriding the default font properties for that class coming from
1837 * the theme in use. There is no need to free this list.
1839 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1841 EAPI const Eina_List *elm_font_overlay_list_get(void);
1844 * Set a font overlay for a given Elementary text class.
1846 * @param text_class Text class name
1847 * @param font Font name and style string
1848 * @param size Font size
1852 * @p font has to be in the format returned by
1853 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1854 * and elm_font_overlay_unset().
1856 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1859 * Unset a font overlay for a given Elementary text class.
1861 * @param text_class Text class name
1865 * This will bring back text elements belonging to text class
1866 * @p text_class back to their default font settings.
1868 EAPI void elm_font_overlay_unset(const char *text_class);
1871 * Apply the changes made with elm_font_overlay_set() and
1872 * elm_font_overlay_unset() on the current Elementary window.
1876 * This applies all font overlays set to all objects in the UI.
1878 EAPI void elm_font_overlay_apply(void);
1881 * Apply the changes made with elm_font_overlay_set() and
1882 * elm_font_overlay_unset() on all Elementary application windows.
1886 * This applies all font overlays set to all objects in the UI.
1888 EAPI void elm_font_overlay_all_apply(void);
1891 * Translate a font (family) name string in fontconfig's font names
1892 * syntax into an @c Elm_Font_Properties struct.
1894 * @param font The font name and styles string
1895 * @return the font properties struct
1899 * @note The reverse translation can be achived with
1900 * elm_font_fontconfig_name_get(), for one style only (single font
1901 * instance, not family).
1903 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1906 * Free font properties return by elm_font_properties_get().
1908 * @param efp the font properties struct
1912 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1915 * Translate a font name, bound to a style, into fontconfig's font names
1918 * @param name The font (family) name
1919 * @param style The given style (may be @c NULL)
1921 * @return the font name and style string
1925 * @note The reverse translation can be achived with
1926 * elm_font_properties_get(), for one style only (single font
1927 * instance, not family).
1929 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1932 * Free the font string return by elm_font_fontconfig_name_get().
1934 * @param efp the font properties struct
1938 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1941 * Create a font hash table of available system fonts.
1943 * One must call it with @p list being the return value of
1944 * evas_font_available_list(). The hash will be indexed by font
1945 * (family) names, being its values @c Elm_Font_Properties blobs.
1947 * @param list The list of available system fonts, as returned by
1948 * evas_font_available_list().
1949 * @return the font hash.
1953 * @note The user is supposed to get it populated at least with 3
1954 * default font families (Sans, Serif, Monospace), which should be
1955 * present on most systems.
1957 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1960 * Free the hash return by elm_font_available_hash_add().
1962 * @param hash the hash to be freed.
1966 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1973 * @defgroup Fingers Fingers
1975 * Elementary is designed to be finger-friendly for touchscreens,
1976 * and so in addition to scaling for display resolution, it can
1977 * also scale based on finger "resolution" (or size). You can then
1978 * customize the granularity of the areas meant to receive clicks
1981 * Different profiles may have pre-set values for finger sizes.
1983 * @ref general_functions_example_page "This" example contemplates
1984 * some of these functions.
1990 * Get the configured "finger size"
1992 * @return The finger size
1994 * This gets the globally configured finger size, <b>in pixels</b>
1998 EAPI Evas_Coord elm_finger_size_get(void);
2001 * Set the configured finger size
2003 * This sets the globally configured finger size in pixels
2005 * @param size The finger size
2008 EAPI void elm_finger_size_set(Evas_Coord size);
2011 * Set the configured finger size for all applications on the display
2013 * This sets the globally configured finger size in pixels for all
2014 * applications on the display
2016 * @param size The finger size
2019 EAPI void elm_finger_size_all_set(Evas_Coord size);
2026 * @defgroup Focus Focus
2028 * An Elementary application has, at all times, one (and only one)
2029 * @b focused object. This is what determines where the input
2030 * events go to within the application's window. Also, focused
2031 * objects can be decorated differently, in order to signal to the
2032 * user where the input is, at a given moment.
2034 * Elementary applications also have the concept of <b>focus
2035 * chain</b>: one can cycle through all the windows' focusable
2036 * objects by input (tab key) or programmatically. The default
2037 * focus chain for an application is the one define by the order in
2038 * which the widgets where added in code. One will cycle through
2039 * top level widgets, and, for each one containg sub-objects, cycle
2040 * through them all, before returning to the level
2041 * above. Elementary also allows one to set @b custom focus chains
2042 * for their applications.
2044 * Besides the focused decoration a widget may exhibit, when it
2045 * gets focus, Elementary has a @b global focus highlight object
2046 * that can be enabled for a window. If one chooses to do so, this
2047 * extra highlight effect will surround the current focused object,
2050 * @note Some Elementary widgets are @b unfocusable, after
2051 * creation, by their very nature: they are not meant to be
2052 * interacted with input events, but are there just for visual
2055 * @ref general_functions_example_page "This" example contemplates
2056 * some of these functions.
2060 * Get the enable status of the focus highlight
2062 * This gets whether the highlight on focused objects is enabled or not
2065 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2068 * Set the enable status of the focus highlight
2070 * Set whether to show or not the highlight on focused objects
2071 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2074 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2077 * Get the enable status of the highlight animation
2079 * Get whether the focus highlight, if enabled, will animate its switch from
2080 * one object to the next
2083 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2086 * Set the enable status of the highlight animation
2088 * Set whether the focus highlight, if enabled, will animate its switch from
2089 * one object to the next
2090 * @param animate Enable animation if EINA_TRUE, disable otherwise
2093 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2096 * Get the whether an Elementary object has the focus or not.
2098 * @param obj The Elementary object to get the information from
2099 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2100 * not (and on errors).
2102 * @see elm_object_focus_set()
2106 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2109 * Set/unset focus to a given Elementary object.
2111 * @param obj The Elementary object to operate on.
2112 * @param enable @c EINA_TRUE Set focus to a given object,
2113 * @c EINA_FALSE Unset focus to a given object.
2115 * @note When you set focus to this object, if it can handle focus, will
2116 * take the focus away from the one who had it previously and will, for
2117 * now on, be the one receiving input events. Unsetting focus will remove
2118 * the focus from @p obj, passing it back to the previous element in the
2121 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2125 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2128 * Make a given Elementary object the focused one.
2130 * @param obj The Elementary object to make focused.
2132 * @note This object, if it can handle focus, will take the focus
2133 * away from the one who had it previously and will, for now on, be
2134 * the one receiving input events.
2136 * @see elm_object_focus_get()
2137 * @deprecated use elm_object_focus_set() instead.
2141 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2144 * Remove the focus from an Elementary object
2146 * @param obj The Elementary to take focus from
2148 * This removes the focus from @p obj, passing it back to the
2149 * previous element in the focus chain list.
2151 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2152 * @deprecated use elm_object_focus_set() instead.
2156 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2159 * Set the ability for an Element object to be focused
2161 * @param obj The Elementary object to operate on
2162 * @param enable @c EINA_TRUE if the object can be focused, @c
2163 * EINA_FALSE if not (and on errors)
2165 * This sets whether the object @p obj is able to take focus or
2166 * not. Unfocusable objects do nothing when programmatically
2167 * focused, being the nearest focusable parent object the one
2168 * really getting focus. Also, when they receive mouse input, they
2169 * will get the event, but not take away the focus from where it
2174 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2177 * Get whether an Elementary object is focusable or not
2179 * @param obj The Elementary object to operate on
2180 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2181 * EINA_FALSE if not (and on errors)
2183 * @note Objects which are meant to be interacted with by input
2184 * events are created able to be focused, by default. All the
2189 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * Set custom focus chain.
2194 * This function overwrites any previous custom focus chain within
2195 * the list of objects. The previous list will be deleted and this list
2196 * will be managed by elementary. After it is set, don't modify it.
2198 * @note On focus cycle, only will be evaluated children of this container.
2200 * @param obj The container object
2201 * @param objs Chain of objects to pass focus
2204 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2207 * Unset a custom focus chain on a given Elementary widget
2209 * @param obj The container object to remove focus chain from
2211 * Any focus chain previously set on @p obj (for its child objects)
2212 * is removed entirely after this call.
2216 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 * Get custom focus chain
2221 * @param obj The container object
2224 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2227 * Append object to custom focus chain.
2229 * @note If relative_child equal to NULL or not in custom chain, the object
2230 * will be added in end.
2232 * @note On focus cycle, only will be evaluated children of this container.
2234 * @param obj The container object
2235 * @param child The child to be added in custom chain
2236 * @param relative_child The relative object to position the child
2239 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2242 * Prepend object to custom focus chain.
2244 * @note If relative_child equal to NULL or not in custom chain, the object
2245 * will be added in begin.
2247 * @note On focus cycle, only will be evaluated children of this container.
2249 * @param obj The container object
2250 * @param child The child to be added in custom chain
2251 * @param relative_child The relative object to position the child
2254 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2257 * Give focus to next object in object tree.
2259 * Give focus to next object in focus chain of one object sub-tree.
2260 * If the last object of chain already have focus, the focus will go to the
2261 * first object of chain.
2263 * @param obj The object root of sub-tree
2264 * @param dir Direction to cycle the focus
2268 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2271 * Give focus to near object in one direction.
2273 * Give focus to near object in direction of one object.
2274 * If none focusable object in given direction, the focus will not change.
2276 * @param obj The reference object
2277 * @param x Horizontal component of direction to focus
2278 * @param y Vertical component of direction to focus
2282 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2285 * Make the elementary object and its children to be unfocusable
2288 * @param obj The Elementary object to operate on
2289 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2290 * @c EINA_FALSE for focusable.
2292 * This sets whether the object @p obj and its children objects
2293 * are able to take focus or not. If the tree is set as unfocusable,
2294 * newest focused object which is not in this tree will get focus.
2295 * This API can be helpful for an object to be deleted.
2296 * When an object will be deleted soon, it and its children may not
2297 * want to get focus (by focus reverting or by other focus controls).
2298 * Then, just use this API before deleting.
2300 * @see elm_object_tree_unfocusable_get()
2304 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2307 * Get whether an Elementary object and its children are unfocusable or not.
2309 * @param obj The Elementary object to get the information from
2310 * @return @c EINA_TRUE, if the tree is unfocussable,
2311 * @c EINA_FALSE if not (and on errors).
2313 * @see elm_object_tree_unfocusable_set()
2317 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2320 * @defgroup Scrolling Scrolling
2322 * These are functions setting how scrollable views in Elementary
2323 * widgets should behave on user interaction.
2329 * Get whether scrollers should bounce when they reach their
2330 * viewport's edge during a scroll.
2332 * @return the thumb scroll bouncing state
2334 * This is the default behavior for touch screens, in general.
2335 * @ingroup Scrolling
2337 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2340 * Set whether scrollers should bounce when they reach their
2341 * viewport's edge during a scroll.
2343 * @param enabled the thumb scroll bouncing state
2345 * @see elm_thumbscroll_bounce_enabled_get()
2346 * @ingroup Scrolling
2348 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2351 * Set whether scrollers should bounce when they reach their
2352 * viewport's edge during a scroll, for all Elementary application
2355 * @param enabled the thumb scroll bouncing state
2357 * @see elm_thumbscroll_bounce_enabled_get()
2358 * @ingroup Scrolling
2360 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2363 * Get the amount of inertia a scroller will impose at bounce
2366 * @return the thumb scroll bounce friction
2368 * @ingroup Scrolling
2370 EAPI double elm_scroll_bounce_friction_get(void);
2373 * Set the amount of inertia a scroller will impose at bounce
2376 * @param friction the thumb scroll bounce friction
2378 * @see elm_thumbscroll_bounce_friction_get()
2379 * @ingroup Scrolling
2381 EAPI void elm_scroll_bounce_friction_set(double friction);
2384 * Set the amount of inertia a scroller will impose at bounce
2385 * animations, for all Elementary application windows.
2387 * @param friction the thumb scroll bounce friction
2389 * @see elm_thumbscroll_bounce_friction_get()
2390 * @ingroup Scrolling
2392 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2395 * Get the amount of inertia a <b>paged</b> scroller will impose at
2396 * page fitting animations.
2398 * @return the page scroll friction
2400 * @ingroup Scrolling
2402 EAPI double elm_scroll_page_scroll_friction_get(void);
2405 * Set the amount of inertia a <b>paged</b> scroller will impose at
2406 * page fitting animations.
2408 * @param friction the page scroll friction
2410 * @see elm_thumbscroll_page_scroll_friction_get()
2411 * @ingroup Scrolling
2413 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2416 * Set the amount of inertia a <b>paged</b> scroller will impose at
2417 * page fitting animations, for all Elementary application windows.
2419 * @param friction the page scroll friction
2421 * @see elm_thumbscroll_page_scroll_friction_get()
2422 * @ingroup Scrolling
2424 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2427 * Get the amount of inertia a scroller will impose at region bring
2430 * @return the bring in scroll friction
2432 * @ingroup Scrolling
2434 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2437 * Set the amount of inertia a scroller will impose at region bring
2440 * @param friction the bring in scroll friction
2442 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2443 * @ingroup Scrolling
2445 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2448 * Set the amount of inertia a scroller will impose at region bring
2449 * animations, for all Elementary application windows.
2451 * @param friction the bring in scroll friction
2453 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2454 * @ingroup Scrolling
2456 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2459 * Get the amount of inertia scrollers will impose at animations
2460 * triggered by Elementary widgets' zooming API.
2462 * @return the zoom friction
2464 * @ingroup Scrolling
2466 EAPI double elm_scroll_zoom_friction_get(void);
2469 * Set the amount of inertia scrollers will impose at animations
2470 * triggered by Elementary widgets' zooming API.
2472 * @param friction the zoom friction
2474 * @see elm_thumbscroll_zoom_friction_get()
2475 * @ingroup Scrolling
2477 EAPI void elm_scroll_zoom_friction_set(double friction);
2480 * Set the amount of inertia scrollers will impose at animations
2481 * triggered by Elementary widgets' zooming API, for all Elementary
2482 * application windows.
2484 * @param friction the zoom friction
2486 * @see elm_thumbscroll_zoom_friction_get()
2487 * @ingroup Scrolling
2489 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2492 * Get whether scrollers should be draggable from any point in their
2495 * @return the thumb scroll state
2497 * @note This is the default behavior for touch screens, in general.
2498 * @note All other functions namespaced with "thumbscroll" will only
2499 * have effect if this mode is enabled.
2501 * @ingroup Scrolling
2503 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2506 * Set whether scrollers should be draggable from any point in their
2509 * @param enabled the thumb scroll state
2511 * @see elm_thumbscroll_enabled_get()
2512 * @ingroup Scrolling
2514 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2517 * Set whether scrollers should be draggable from any point in their
2518 * views, for all Elementary application windows.
2520 * @param enabled the thumb scroll state
2522 * @see elm_thumbscroll_enabled_get()
2523 * @ingroup Scrolling
2525 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2528 * Get the number of pixels one should travel while dragging a
2529 * scroller's view to actually trigger scrolling.
2531 * @return the thumb scroll threshould
2533 * One would use higher values for touch screens, in general, because
2534 * of their inherent imprecision.
2535 * @ingroup Scrolling
2537 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2540 * Set the number of pixels one should travel while dragging a
2541 * scroller's view to actually trigger scrolling.
2543 * @param threshold the thumb scroll threshould
2545 * @see elm_thumbscroll_threshould_get()
2546 * @ingroup Scrolling
2548 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2551 * Set the number of pixels one should travel while dragging a
2552 * scroller's view to actually trigger scrolling, for all Elementary
2553 * application windows.
2555 * @param threshold the thumb scroll threshould
2557 * @see elm_thumbscroll_threshould_get()
2558 * @ingroup Scrolling
2560 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2563 * Get the minimum speed of mouse cursor movement which will trigger
2564 * list self scrolling animation after a mouse up event
2567 * @return the thumb scroll momentum threshould
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2574 * Set the minimum speed of mouse cursor movement which will trigger
2575 * list self scrolling animation after a mouse up event
2578 * @param threshold the thumb scroll momentum threshould
2580 * @see elm_thumbscroll_momentum_threshould_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2586 * Set the minimum speed of mouse cursor movement which will trigger
2587 * list self scrolling animation after a mouse up event
2588 * (pixels/second), for all Elementary application windows.
2590 * @param threshold the thumb scroll momentum threshould
2592 * @see elm_thumbscroll_momentum_threshould_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2598 * Get the amount of inertia a scroller will impose at self scrolling
2601 * @return the thumb scroll friction
2603 * @ingroup Scrolling
2605 EAPI double elm_scroll_thumbscroll_friction_get(void);
2608 * Set the amount of inertia a scroller will impose at self scrolling
2611 * @param friction the thumb scroll friction
2613 * @see elm_thumbscroll_friction_get()
2614 * @ingroup Scrolling
2616 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2619 * Set the amount of inertia a scroller will impose at self scrolling
2620 * animations, for all Elementary application windows.
2622 * @param friction the thumb scroll friction
2624 * @see elm_thumbscroll_friction_get()
2625 * @ingroup Scrolling
2627 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2630 * Get the amount of lag between your actual mouse cursor dragging
2631 * movement and a scroller's view movement itself, while pushing it
2632 * into bounce state manually.
2634 * @return the thumb scroll border friction
2636 * @ingroup Scrolling
2638 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2641 * Set the amount of lag between your actual mouse cursor dragging
2642 * movement and a scroller's view movement itself, while pushing it
2643 * into bounce state manually.
2645 * @param friction the thumb scroll border friction. @c 0.0 for
2646 * perfect synchrony between two movements, @c 1.0 for maximum
2649 * @see elm_thumbscroll_border_friction_get()
2650 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2657 * Set the amount of lag between your actual mouse cursor dragging
2658 * movement and a scroller's view movement itself, while pushing it
2659 * into bounce state manually, for all Elementary application windows.
2661 * @param friction the thumb scroll border friction. @c 0.0 for
2662 * perfect synchrony between two movements, @c 1.0 for maximum
2665 * @see elm_thumbscroll_border_friction_get()
2666 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2668 * @ingroup Scrolling
2670 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2677 * @defgroup Scrollhints Scrollhints
2679 * Objects when inside a scroller can scroll, but this may not always be
2680 * desirable in certain situations. This allows an object to hint to itself
2681 * and parents to "not scroll" in one of 2 ways. If any chilkd object of a
2682 * scroller has pushed a scroll freeze or hold then it affects all parent
2683 * scrollers until all children have released them.
2685 * 1. To hold on scrolling. This means just flicking and dragging may no
2686 * longer scroll, but pressing/dragging near an edge of the scroller will
2687 * still scroll. This is automatically used by the entry object when
2690 * 2. To totally freeze scrolling. This means it stops. until
2697 * Push the scroll hold by 1
2699 * This increments the scroll hold count by one. If it is more than 0 it will
2700 * take effect on the parents of the indicated object.
2702 * @param obj The object
2703 * @ingroup Scrollhints
2705 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 * Pop the scroll hold by 1
2710 * This decrements the scroll hold count by one. If it is more than 0 it will
2711 * take effect on the parents of the indicated object.
2713 * @param obj The object
2714 * @ingroup Scrollhints
2716 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719 * Push the scroll freeze by 1
2721 * This increments the scroll freeze count by one. If it is more
2722 * than 0 it will take effect on the parents of the indicated
2725 * @param obj The object
2726 * @ingroup Scrollhints
2728 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * Pop the scroll freeze by 1
2733 * This decrements the scroll freeze count by one. If it is more
2734 * than 0 it will take effect on the parents of the indicated
2737 * @param obj The object
2738 * @ingroup Scrollhints
2740 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2743 * Lock the scrolling of the given widget (and thus all parents)
2745 * This locks the given object from scrolling in the X axis (and implicitly
2746 * also locks all parent scrollers too from doing the same).
2748 * @param obj The object
2749 * @param lock The lock state (1 == locked, 0 == unlocked)
2750 * @ingroup Scrollhints
2752 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2755 * Lock the scrolling of the given widget (and thus all parents)
2757 * This locks the given object from scrolling in the Y axis (and implicitly
2758 * also locks all parent scrollers too from doing the same).
2760 * @param obj The object
2761 * @param lock The lock state (1 == locked, 0 == unlocked)
2762 * @ingroup Scrollhints
2764 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2767 * Get the scrolling lock of the given widget
2769 * This gets the lock for X axis scrolling.
2771 * @param obj The object
2772 * @ingroup Scrollhints
2774 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 * Get the scrolling lock of the given widget
2779 * This gets the lock for X axis scrolling.
2781 * @param obj The object
2782 * @ingroup Scrollhints
2784 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 * Send a signal to the widget edje object.
2793 * This function sends a signal to the edje object of the obj. An
2794 * edje program can respond to a signal by specifying matching
2795 * 'signal' and 'source' fields.
2797 * @param obj The object
2798 * @param emission The signal's name.
2799 * @param source The signal's source.
2802 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2805 * Add a callback for a signal emitted by widget edje object.
2807 * This function connects a callback function to a signal emitted by the
2808 * edje object of the obj.
2809 * Globs can occur in either the emission or source name.
2811 * @param obj The object
2812 * @param emission The signal's name.
2813 * @param source The signal's source.
2814 * @param func The callback function to be executed when the signal is
2816 * @param data A pointer to data to pass in to the callback function.
2819 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2822 * Remove a signal-triggered callback from an widget edje object.
2824 * This function removes a callback, previoulsy attached to a
2825 * signal emitted by the edje object of the obj. The parameters
2826 * emission, source and func must match exactly those passed to a
2827 * previous call to elm_object_signal_callback_add(). The data
2828 * pointer that was passed to this call will be returned.
2830 * @param obj The object
2831 * @param emission The signal's name.
2832 * @param source The signal's source.
2833 * @param func The callback function to be executed when the signal is
2835 * @return The data pointer
2838 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2841 * Add a callback for a event emitted by widget or their children.
2843 * This function connects a callback function to any key_down key_up event
2844 * emitted by the @p obj or their children.
2845 * This only will be called if no other callback has consumed the event.
2846 * If you want consume the event, and no other get it, func should return
2847 * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
2849 * @warning Accept duplicated callback addition.
2851 * @param obj The object
2852 * @param func The callback function to be executed when the event is
2854 * @param data Data to pass in to the callback function.
2857 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2860 * Remove a event callback from an widget.
2862 * This function removes a callback, previoulsy attached to event emission
2864 * The parameters func and data must match exactly those passed to
2865 * a previous call to elm_object_event_callback_add(). The data pointer that
2866 * was passed to this call will be returned.
2868 * @param obj The object
2869 * @param func The callback function to be executed when the event is
2871 * @param data Data to pass in to the callback function.
2872 * @return The data pointer
2875 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2878 * Adjust size of an element for finger usage.
2880 * @param times_w How many fingers should fit horizontally
2881 * @param w Pointer to the width size to adjust
2882 * @param times_h How many fingers should fit vertically
2883 * @param h Pointer to the height size to adjust
2885 * This takes width and height sizes (in pixels) as input and a
2886 * size multiple (which is how many fingers you want to place
2887 * within the area, being "finger" the size set by
2888 * elm_finger_size_set()), and adjusts the size to be large enough
2889 * to accommodate the resulting size -- if it doesn't already
2890 * accommodate it. On return the @p w and @p h sizes pointed to by
2891 * these parameters will be modified, on those conditions.
2893 * @note This is kind of a low level Elementary call, most useful
2894 * on size evaluation times for widgets. An external user wouldn't
2895 * be calling, most of the time.
2899 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2902 * Get the duration for occuring long press event.
2904 * @return Timeout for long press event
2905 * @ingroup Longpress
2907 EAPI double elm_longpress_timeout_get(void);
2910 * Set the duration for occuring long press event.
2912 * @param lonpress_timeout Timeout for long press event
2913 * @ingroup Longpress
2915 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2918 * @defgroup Debug Debug
2919 * don't use it unless you are sure
2925 * Print Tree object hierarchy in stdout
2927 * @param obj The root object
2930 EAPI void elm_object_tree_dump(const Evas_Object *top);
2933 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2935 * @param obj The root object
2936 * @param file The path of output file
2939 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2946 * @defgroup Theme Theme
2948 * Elementary uses Edje to theme its widgets, naturally. But for the most
2949 * part this is hidden behind a simpler interface that lets the user set
2950 * extensions and choose the style of widgets in a much easier way.
2952 * Instead of thinking in terms of paths to Edje files and their groups
2953 * each time you want to change the appearance of a widget, Elementary
2954 * works so you can add any theme file with extensions or replace the
2955 * main theme at one point in the application, and then just set the style
2956 * of widgets with elm_object_style_set() and related functions. Elementary
2957 * will then look in its list of themes for a matching group and apply it,
2958 * and when the theme changes midway through the application, all widgets
2959 * will be updated accordingly.
2961 * There are three concepts you need to know to understand how Elementary
2962 * theming works: default theme, extensions and overlays.
2964 * Default theme, obviously enough, is the one that provides the default
2965 * look of all widgets. End users can change the theme used by Elementary
2966 * by setting the @c ELM_THEME environment variable before running an
2967 * application, or globally for all programs using the @c elementary_config
2968 * utility. Applications can change the default theme using elm_theme_set(),
2969 * but this can go against the user wishes, so it's not an adviced practice.
2971 * Ideally, applications should find everything they need in the already
2972 * provided theme, but there may be occasions when that's not enough and
2973 * custom styles are required to correctly express the idea. For this
2974 * cases, Elementary has extensions.
2976 * Extensions allow the application developer to write styles of its own
2977 * to apply to some widgets. This requires knowledge of how each widget
2978 * is themed, as extensions will always replace the entire group used by
2979 * the widget, so important signals and parts need to be there for the
2980 * object to behave properly (see documentation of Edje for details).
2981 * Once the theme for the extension is done, the application needs to add
2982 * it to the list of themes Elementary will look into, using
2983 * elm_theme_extension_add(), and set the style of the desired widgets as
2984 * he would normally with elm_object_style_set().
2986 * Overlays, on the other hand, can replace the look of all widgets by
2987 * overriding the default style. Like extensions, it's up to the application
2988 * developer to write the theme for the widgets it wants, the difference
2989 * being that when looking for the theme, Elementary will check first the
2990 * list of overlays, then the set theme and lastly the list of extensions,
2991 * so with overlays it's possible to replace the default view and every
2992 * widget will be affected. This is very much alike to setting the whole
2993 * theme for the application and will probably clash with the end user
2994 * options, not to mention the risk of ending up with not matching styles
2995 * across the program. Unless there's a very special reason to use them,
2996 * overlays should be avoided for the resons exposed before.
2998 * All these theme lists are handled by ::Elm_Theme instances. Elementary
2999 * keeps one default internally and every function that receives one of
3000 * these can be called with NULL to refer to this default (except for
3001 * elm_theme_free()). It's possible to create a new instance of a
3002 * ::Elm_Theme to set other theme for a specific widget (and all of its
3003 * children), but this is as discouraged, if not even more so, than using
3004 * overlays. Don't use this unless you really know what you are doing.
3006 * But to be less negative about things, you can look at the following
3008 * @li @ref theme_example_01 "Using extensions"
3009 * @li @ref theme_example_02 "Using overlays"
3014 * @typedef Elm_Theme
3016 * Opaque handler for the list of themes Elementary looks for when
3017 * rendering widgets.
3019 * Stay out of this unless you really know what you are doing. For most
3020 * cases, sticking to the default is all a developer needs.
3022 typedef struct _Elm_Theme Elm_Theme;
3025 * Create a new specific theme
3027 * This creates an empty specific theme that only uses the default theme. A
3028 * specific theme has its own private set of extensions and overlays too
3029 * (which are empty by default). Specific themes do not fall back to themes
3030 * of parent objects. They are not intended for this use. Use styles, overlays
3031 * and extensions when needed, but avoid specific themes unless there is no
3032 * other way (example: you want to have a preview of a new theme you are
3033 * selecting in a "theme selector" window. The preview is inside a scroller
3034 * and should display what the theme you selected will look like, but not
3035 * actually apply it yet. The child of the scroller will have a specific
3036 * theme set to show this preview before the user decides to apply it to all
3039 EAPI Elm_Theme *elm_theme_new(void);
3041 * Free a specific theme
3043 * @param th The theme to free
3045 * This frees a theme created with elm_theme_new().
3047 EAPI void elm_theme_free(Elm_Theme *th);
3049 * Copy the theme fom the source to the destination theme
3051 * @param th The source theme to copy from
3052 * @param thdst The destination theme to copy data to
3054 * This makes a one-time static copy of all the theme config, extensions
3055 * and overlays from @p th to @p thdst. If @p th references a theme, then
3056 * @p thdst is also set to reference it, with all the theme settings,
3057 * overlays and extensions that @p th had.
3059 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3061 * Tell the source theme to reference the ref theme
3063 * @param th The theme that will do the referencing
3064 * @param thref The theme that is the reference source
3066 * This clears @p th to be empty and then sets it to refer to @p thref
3067 * so @p th acts as an override to @p thref, but where its overrides
3068 * don't apply, it will fall through to @p thref for configuration.
3070 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3072 * Return the theme referred to
3074 * @param th The theme to get the reference from
3075 * @return The referenced theme handle
3077 * This gets the theme set as the reference theme by elm_theme_ref_set().
3078 * If no theme is set as a reference, NULL is returned.
3080 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3082 * Return the default theme
3084 * @return The default theme handle
3086 * This returns the internal default theme setup handle that all widgets
3087 * use implicitly unless a specific theme is set. This is also often use
3088 * as a shorthand of NULL.
3090 EAPI Elm_Theme *elm_theme_default_get(void);
3092 * Prepends a theme overlay to the list of overlays
3094 * @param th The theme to add to, or if NULL, the default theme
3095 * @param item The Edje file path to be used
3097 * Use this if your application needs to provide some custom overlay theme
3098 * (An Edje file that replaces some default styles of widgets) where adding
3099 * new styles, or changing system theme configuration is not possible. Do
3100 * NOT use this instead of a proper system theme configuration. Use proper
3101 * configuration files, profiles, environment variables etc. to set a theme
3102 * so that the theme can be altered by simple confiugration by a user. Using
3103 * this call to achieve that effect is abusing the API and will create lots
3106 * @see elm_theme_extension_add()
3108 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3110 * Delete a theme overlay from the list of overlays
3112 * @param th The theme to delete from, or if NULL, the default theme
3113 * @param item The name of the theme overlay
3115 * @see elm_theme_overlay_add()
3117 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3119 * Appends a theme extension to the list of extensions.
3121 * @param th The theme to add to, or if NULL, the default theme
3122 * @param item The Edje file path to be used
3124 * This is intended when an application needs more styles of widgets or new
3125 * widget themes that the default does not provide (or may not provide). The
3126 * application has "extended" usage by coming up with new custom style names
3127 * for widgets for specific uses, but as these are not "standard", they are
3128 * not guaranteed to be provided by a default theme. This means the
3129 * application is required to provide these extra elements itself in specific
3130 * Edje files. This call adds one of those Edje files to the theme search
3131 * path to be search after the default theme. The use of this call is
3132 * encouraged when default styles do not meet the needs of the application.
3133 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3135 * @see elm_object_style_set()
3137 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3139 * Deletes a theme extension from the list of extensions.
3141 * @param th The theme to delete from, or if NULL, the default theme
3142 * @param item The name of the theme extension
3144 * @see elm_theme_extension_add()
3146 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3148 * Set the theme search order for the given theme
3150 * @param th The theme to set the search order, or if NULL, the default theme
3151 * @param theme Theme search string
3153 * This sets the search string for the theme in path-notation from first
3154 * theme to search, to last, delimited by the : character. Example:
3156 * "shiny:/path/to/file.edj:default"
3158 * See the ELM_THEME environment variable for more information.
3160 * @see elm_theme_get()
3161 * @see elm_theme_list_get()
3163 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3165 * Return the theme search order
3167 * @param th The theme to get the search order, or if NULL, the default theme
3168 * @return The internal search order path
3170 * This function returns a colon separated string of theme elements as
3171 * returned by elm_theme_list_get().
3173 * @see elm_theme_set()
3174 * @see elm_theme_list_get()
3176 EAPI const char *elm_theme_get(Elm_Theme *th);
3178 * Return a list of theme elements to be used in a theme.
3180 * @param th Theme to get the list of theme elements from.
3181 * @return The internal list of theme elements
3183 * This returns the internal list of theme elements (will only be valid as
3184 * long as the theme is not modified by elm_theme_set() or theme is not
3185 * freed by elm_theme_free(). This is a list of strings which must not be
3186 * altered as they are also internal. If @p th is NULL, then the default
3187 * theme element list is returned.
3189 * A theme element can consist of a full or relative path to a .edj file,
3190 * or a name, without extension, for a theme to be searched in the known
3191 * theme paths for Elemementary.
3193 * @see elm_theme_set()
3194 * @see elm_theme_get()
3196 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3198 * Return the full patrh for a theme element
3200 * @param f The theme element name
3201 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3202 * @return The full path to the file found.
3204 * This returns a string you should free with free() on success, NULL on
3205 * failure. This will search for the given theme element, and if it is a
3206 * full or relative path element or a simple searchable name. The returned
3207 * path is the full path to the file, if searched, and the file exists, or it
3208 * is simply the full path given in the element or a resolved path if
3209 * relative to home. The @p in_search_path boolean pointed to is set to
3210 * EINA_TRUE if the file was a searchable file andis in the search path,
3211 * and EINA_FALSE otherwise.
3213 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3215 * Flush the current theme.
3217 * @param th Theme to flush
3219 * This flushes caches that let elementary know where to find theme elements
3220 * in the given theme. If @p th is NULL, then the default theme is flushed.
3221 * Call this function if source theme data has changed in such a way as to
3222 * make any caches Elementary kept invalid.
3224 EAPI void elm_theme_flush(Elm_Theme *th);
3226 * This flushes all themes (default and specific ones).
3228 * This will flush all themes in the current application context, by calling
3229 * elm_theme_flush() on each of them.
3231 EAPI void elm_theme_full_flush(void);
3233 * Set the theme for all elementary using applications on the current display
3235 * @param theme The name of the theme to use. Format same as the ELM_THEME
3236 * environment variable.
3238 EAPI void elm_theme_all_set(const char *theme);
3240 * Return a list of theme elements in the theme search path
3242 * @return A list of strings that are the theme element names.
3244 * This lists all available theme files in the standard Elementary search path
3245 * for theme elements, and returns them in alphabetical order as theme
3246 * element names in a list of strings. Free this with
3247 * elm_theme_name_available_list_free() when you are done with the list.
3249 EAPI Eina_List *elm_theme_name_available_list_new(void);
3251 * Free the list returned by elm_theme_name_available_list_new()
3253 * This frees the list of themes returned by
3254 * elm_theme_name_available_list_new(). Once freed the list should no longer
3255 * be used. a new list mys be created.
3257 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3259 * Set a specific theme to be used for this object and its children
3261 * @param obj The object to set the theme on
3262 * @param th The theme to set
3264 * This sets a specific theme that will be used for the given object and any
3265 * child objects it has. If @p th is NULL then the theme to be used is
3266 * cleared and the object will inherit its theme from its parent (which
3267 * ultimately will use the default theme if no specific themes are set).
3269 * Use special themes with great care as this will annoy users and make
3270 * configuration difficult. Avoid any custom themes at all if it can be
3273 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3275 * Get the specific theme to be used
3277 * @param obj The object to get the specific theme from
3278 * @return The specifc theme set.
3280 * This will return a specific theme set, or NULL if no specific theme is
3281 * set on that object. It will not return inherited themes from parents, only
3282 * the specific theme set for that specific object. See elm_object_theme_set()
3283 * for more information.
3285 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3291 /** @defgroup Win Win
3293 * @image html img/widget/win/preview-00.png
3294 * @image latex img/widget/win/preview-00.eps
3296 * The window class of Elementary. Contains functions to manipulate
3297 * windows. The Evas engine used to render the window contents is specified
3298 * in the system or user elementary config files (whichever is found last),
3299 * and can be overridden with the ELM_ENGINE environment variable for
3300 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3301 * compilation setup and modules actually installed at runtime) are (listed
3302 * in order of best supported and most likely to be complete and work to
3305 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3306 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3308 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3310 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3312 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3314 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3315 * rendering using SDL as the buffer)
3316 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3317 * GDI with software)
3318 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3319 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3320 * grayscale using dedicated 8bit software engine in X11)
3321 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3322 * X11 using 16bit software engine)
3323 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3324 * (Windows CE rendering via GDI with 16bit software renderer)
3325 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3326 * buffer with 16bit software renderer)
3328 * All engines use a simple string to select the engine to render, EXCEPT
3329 * the "shot" engine. This actually encodes the output of the virtual
3330 * screenshot and how long to delay in the engine string. The engine string
3331 * is encoded in the following way:
3333 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3335 * Where options are separated by a ":" char if more than one option is
3336 * given, with delay, if provided being the first option and file the last
3337 * (order is important). The delay specifies how long to wait after the
3338 * window is shown before doing the virtual "in memory" rendering and then
3339 * save the output to the file specified by the file option (and then exit).
3340 * If no delay is given, the default is 0.5 seconds. If no file is given the
3341 * default output file is "out.png". Repeat option is for continous
3342 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3343 * fixed to "out001.png" Some examples of using the shot engine:
3345 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3346 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3347 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3348 * ELM_ENGINE="shot:delay=2.0" elementary_test
3349 * ELM_ENGINE="shot:" elementary_test
3351 * Signals that you can add callbacks for are:
3353 * @li "delete,request": the user requested to close the window. See
3354 * elm_win_autodel_set().
3355 * @li "focus,in": window got focus
3356 * @li "focus,out": window lost focus
3357 * @li "moved": window that holds the canvas was moved
3360 * @li @ref win_example_01
3365 * Defines the types of window that can be created
3367 * These are hints set on the window so that a running Window Manager knows
3368 * how the window should be handled and/or what kind of decorations it
3371 * Currently, only the X11 backed engines use them.
3373 typedef enum _Elm_Win_Type
3375 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3376 window. Almost every window will be created with this
3378 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3379 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3380 window holding desktop icons. */
3381 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3382 be kept on top of any other window by the Window
3384 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3386 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3387 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3389 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3390 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3391 entry in a menubar is clicked. Typically used
3392 with elm_win_override_set(). This hint exists
3393 for completion only, as the EFL way of
3394 implementing a menu would not normally use a
3395 separate window for its contents. */
3396 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3397 triggered by right-clicking an object. */
3398 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3399 explanatory text that typically appear after the
3400 mouse cursor hovers over an object for a while.
3401 Typically used with elm_win_override_set() and also
3402 not very commonly used in the EFL. */
3403 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3404 battery life or a new E-Mail received. */
3405 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3406 usually used in the EFL. */
3407 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3408 object being dragged across different windows, or even
3409 applications. Typically used with
3410 elm_win_override_set(). */
3411 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3412 buffer. No actual window is created for this
3413 type, instead the window and all of its
3414 contents will be rendered to an image buffer.
3415 This allows to have children window inside a
3416 parent one just like any other object would
3417 be, and do other things like applying @c
3418 Evas_Map effects to it. This is the only type
3419 of window that requires the @c parent
3420 parameter of elm_win_add() to be a valid @c
3425 * The differents layouts that can be requested for the virtual keyboard.
3427 * When the application window is being managed by Illume, it may request
3428 * any of the following layouts for the virtual keyboard.
3430 typedef enum _Elm_Win_Keyboard_Mode
3432 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3433 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3434 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3435 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3436 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3437 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3438 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3439 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3440 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3441 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3442 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3443 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3444 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3445 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3446 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3447 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3448 } Elm_Win_Keyboard_Mode;
3451 * Available commands that can be sent to the Illume manager.
3453 * When running under an Illume session, a window may send commands to the
3454 * Illume manager to perform different actions.
3456 typedef enum _Elm_Illume_Command
3458 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3460 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3462 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3464 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3465 } Elm_Illume_Command;
3468 * Adds a window object. If this is the first window created, pass NULL as
3471 * @param parent Parent object to add the window to, or NULL
3472 * @param name The name of the window
3473 * @param type The window type, one of #Elm_Win_Type.
3475 * The @p parent paramter can be @c NULL for every window @p type except
3476 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3477 * which the image object will be created.
3479 * @return The created object, or NULL on failure
3481 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3483 * Add @p subobj as a resize object of window @p obj.
3486 * Setting an object as a resize object of the window means that the
3487 * @p subobj child's size and position will be controlled by the window
3488 * directly. That is, the object will be resized to match the window size
3489 * and should never be moved or resized manually by the developer.
3491 * In addition, resize objects of the window control what the minimum size
3492 * of it will be, as well as whether it can or not be resized by the user.
3494 * For the end user to be able to resize a window by dragging the handles
3495 * or borders provided by the Window Manager, or using any other similar
3496 * mechanism, all of the resize objects in the window should have their
3497 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3499 * @param obj The window object
3500 * @param subobj The resize object to add
3502 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3504 * Delete @p subobj as a resize object of window @p obj.
3506 * This function removes the object @p subobj from the resize objects of
3507 * the window @p obj. It will not delete the object itself, which will be
3508 * left unmanaged and should be deleted by the developer, manually handled
3509 * or set as child of some other container.
3511 * @param obj The window object
3512 * @param subobj The resize object to add
3514 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3516 * Set the title of the window
3518 * @param obj The window object
3519 * @param title The title to set
3521 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3523 * Get the title of the window
3525 * The returned string is an internal one and should not be freed or
3526 * modified. It will also be rendered invalid if a new title is set or if
3527 * the window is destroyed.
3529 * @param obj The window object
3532 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3534 * Set the window's autodel state.
3536 * When closing the window in any way outside of the program control, like
3537 * pressing the X button in the titlebar or using a command from the
3538 * Window Manager, a "delete,request" signal is emitted to indicate that
3539 * this event occurred and the developer can take any action, which may
3540 * include, or not, destroying the window object.
3542 * When the @p autodel parameter is set, the window will be automatically
3543 * destroyed when this event occurs, after the signal is emitted.
3544 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3545 * and is up to the program to do so when it's required.
3547 * @param obj The window object
3548 * @param autodel If true, the window will automatically delete itself when
3551 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3553 * Get the window's autodel state.
3555 * @param obj The window object
3556 * @return If the window will automatically delete itself when closed
3558 * @see elm_win_autodel_set()
3560 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3562 * Activate a window object.
3564 * This function sends a request to the Window Manager to activate the
3565 * window pointed by @p obj. If honored by the WM, the window will receive
3566 * the keyboard focus.
3568 * @note This is just a request that a Window Manager may ignore, so calling
3569 * this function does not ensure in any way that the window will be the
3570 * active one after it.
3572 * @param obj The window object
3574 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3576 * Lower a window object.
3578 * Places the window pointed by @p obj at the bottom of the stack, so that
3579 * no other window is covered by it.
3581 * If elm_win_override_set() is not set, the Window Manager may ignore this
3584 * @param obj The window object
3586 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3588 * Raise a window object.
3590 * Places the window pointed by @p obj at the top of the stack, so that it's
3591 * not covered by any other window.
3593 * If elm_win_override_set() is not set, the Window Manager may ignore this
3596 * @param obj The window object
3598 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3600 * Set the borderless state of a window.
3602 * This function requests the Window Manager to not draw any decoration
3603 * around the window.
3605 * @param obj The window object
3606 * @param borderless If true, the window is borderless
3608 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3610 * Get the borderless state of a window.
3612 * @param obj The window object
3613 * @return If true, the window is borderless
3615 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3617 * Set the shaped state of a window.
3619 * Shaped windows, when supported, will render the parts of the window that
3620 * has no content, transparent.
3622 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3623 * background object or cover the entire window in any other way, or the
3624 * parts of the canvas that have no data will show framebuffer artifacts.
3626 * @param obj The window object
3627 * @param shaped If true, the window is shaped
3629 * @see elm_win_alpha_set()
3631 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3633 * Get the shaped state of a window.
3635 * @param obj The window object
3636 * @return If true, the window is shaped
3638 * @see elm_win_shaped_set()
3640 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3642 * Set the alpha channel state of a window.
3644 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3645 * possibly making parts of the window completely or partially transparent.
3646 * This is also subject to the underlying system supporting it, like for
3647 * example, running under a compositing manager. If no compositing is
3648 * available, enabling this option will instead fallback to using shaped
3649 * windows, with elm_win_shaped_set().
3651 * @param obj The window object
3652 * @param alpha If true, the window has an alpha channel
3654 * @see elm_win_alpha_set()
3656 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3658 * Get the transparency state of a window.
3660 * @param obj The window object
3661 * @return If true, the window is transparent
3663 * @see elm_win_transparent_set()
3665 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3667 * Set the transparency state of a window.
3669 * Use elm_win_alpha_set() instead.
3671 * @param obj The window object
3672 * @param transparent If true, the window is transparent
3674 * @see elm_win_alpha_set()
3676 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3678 * Get the alpha channel state of a window.
3680 * @param obj The window object
3681 * @return If true, the window has an alpha channel
3683 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3685 * Set the override state of a window.
3687 * A window with @p override set to EINA_TRUE will not be managed by the
3688 * Window Manager. This means that no decorations of any kind will be shown
3689 * for it, moving and resizing must be handled by the application, as well
3690 * as the window visibility.
3692 * This should not be used for normal windows, and even for not so normal
3693 * ones, it should only be used when there's a good reason and with a lot
3694 * of care. Mishandling override windows may result situations that
3695 * disrupt the normal workflow of the end user.
3697 * @param obj The window object
3698 * @param override If true, the window is overridden
3700 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3702 * Get the override state of a window.
3704 * @param obj The window object
3705 * @return If true, the window is overridden
3707 * @see elm_win_override_set()
3709 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3711 * Set the fullscreen state of a window.
3713 * @param obj The window object
3714 * @param fullscreen If true, the window is fullscreen
3716 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3718 * Get the fullscreen state of a window.
3720 * @param obj The window object
3721 * @return If true, the window is fullscreen
3723 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3725 * Set the maximized state of a window.
3727 * @param obj The window object
3728 * @param maximized If true, the window is maximized
3730 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3732 * Get the maximized state of a window.
3734 * @param obj The window object
3735 * @return If true, the window is maximized
3737 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3739 * Set the iconified state of a window.
3741 * @param obj The window object
3742 * @param iconified If true, the window is iconified
3744 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3746 * Get the iconified state of a window.
3748 * @param obj The window object
3749 * @return If true, the window is iconified
3751 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3753 * Set the layer of the window.
3755 * What this means exactly will depend on the underlying engine used.
3757 * In the case of X11 backed engines, the value in @p layer has the
3758 * following meanings:
3759 * @li < 3: The window will be placed below all others.
3760 * @li > 5: The window will be placed above all others.
3761 * @li other: The window will be placed in the default layer.
3763 * @param obj The window object
3764 * @param layer The layer of the window
3766 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3768 * Get the layer of the window.
3770 * @param obj The window object
3771 * @return The layer of the window
3773 * @see elm_win_layer_set()
3775 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777 * Set the rotation of the window.
3779 * Most engines only work with multiples of 90.
3781 * This function is used to set the orientation of the window @p obj to
3782 * match that of the screen. The window itself will be resized to adjust
3783 * to the new geometry of its contents. If you want to keep the window size,
3784 * see elm_win_rotation_with_resize_set().
3786 * @param obj The window object
3787 * @param rotation The rotation of the window, in degrees (0-360),
3788 * counter-clockwise.
3790 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3792 * Rotates the window and resizes it.
3794 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3795 * that they fit inside the current window geometry.
3797 * @param obj The window object
3798 * @param layer The rotation of the window in degrees (0-360),
3799 * counter-clockwise.
3801 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3803 * Get the rotation of the window.
3805 * @param obj The window object
3806 * @return The rotation of the window in degrees (0-360)
3808 * @see elm_win_rotation_set()
3809 * @see elm_win_rotation_with_resize_set()
3811 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3813 * Set the sticky state of the window.
3815 * Hints the Window Manager that the window in @p obj should be left fixed
3816 * at its position even when the virtual desktop it's on moves or changes.
3818 * @param obj The window object
3819 * @param sticky If true, the window's sticky state is enabled
3821 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3823 * Get the sticky state of the window.
3825 * @param obj The window object
3826 * @return If true, the window's sticky state is enabled
3828 * @see elm_win_sticky_set()
3830 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3832 * Set if this window is an illume conformant window
3834 * @param obj The window object
3835 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3837 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3839 * Get if this window is an illume conformant window
3841 * @param obj The window object
3842 * @return A boolean if this window is illume conformant or not
3844 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3846 * Set a window to be an illume quickpanel window
3848 * By default window objects are not quickpanel windows.
3850 * @param obj The window object
3851 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3853 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3855 * Get if this window is a quickpanel or not
3857 * @param obj The window object
3858 * @return A boolean if this window is a quickpanel or not
3860 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3862 * Set the major priority of a quickpanel window
3864 * @param obj The window object
3865 * @param priority The major priority for this quickpanel
3867 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3869 * Get the major priority of a quickpanel window
3871 * @param obj The window object
3872 * @return The major priority of this quickpanel
3874 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3876 * Set the minor priority of a quickpanel window
3878 * @param obj The window object
3879 * @param priority The minor priority for this quickpanel
3881 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3883 * Get the minor priority of a quickpanel window
3885 * @param obj The window object
3886 * @return The minor priority of this quickpanel
3888 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 * Set which zone this quickpanel should appear in
3892 * @param obj The window object
3893 * @param zone The requested zone for this quickpanel
3895 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3897 * Get which zone this quickpanel should appear in
3899 * @param obj The window object
3900 * @return The requested zone for this quickpanel
3902 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3904 * Set the window to be skipped by keyboard focus
3906 * This sets the window to be skipped by normal keyboard input. This means
3907 * a window manager will be asked to not focus this window as well as omit
3908 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3910 * Call this and enable it on a window BEFORE you show it for the first time,
3911 * otherwise it may have no effect.
3913 * Use this for windows that have only output information or might only be
3914 * interacted with by the mouse or fingers, and never for typing input.
3915 * Be careful that this may have side-effects like making the window
3916 * non-accessible in some cases unless the window is specially handled. Use
3919 * @param obj The window object
3920 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3922 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3924 * Send a command to the windowing environment
3926 * This is intended to work in touchscreen or small screen device
3927 * environments where there is a more simplistic window management policy in
3928 * place. This uses the window object indicated to select which part of the
3929 * environment to control (the part that this window lives in), and provides
3930 * a command and an optional parameter structure (use NULL for this if not
3933 * @param obj The window object that lives in the environment to control
3934 * @param command The command to send
3935 * @param params Optional parameters for the command
3937 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3939 * Get the inlined image object handle
3941 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3942 * then the window is in fact an evas image object inlined in the parent
3943 * canvas. You can get this object (be careful to not manipulate it as it
3944 * is under control of elementary), and use it to do things like get pixel
3945 * data, save the image to a file, etc.
3947 * @param obj The window object to get the inlined image from
3948 * @return The inlined image object, or NULL if none exists
3950 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3952 * Set the enabled status for the focus highlight in a window
3954 * This function will enable or disable the focus highlight only for the
3955 * given window, regardless of the global setting for it
3957 * @param obj The window where to enable the highlight
3958 * @param enabled The enabled value for the highlight
3960 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3962 * Get the enabled value of the focus highlight for this window
3964 * @param obj The window in which to check if the focus highlight is enabled
3966 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
3968 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3970 * Set the style for the focus highlight on this window
3972 * Sets the style to use for theming the highlight of focused objects on
3973 * the given window. If @p style is NULL, the default will be used.
3975 * @param obj The window where to set the style
3976 * @param style The style to set
3978 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3980 * Get the style set for the focus highlight object
3982 * Gets the style set for this windows highilght object, or NULL if none
3985 * @param obj The window to retrieve the highlights style from
3987 * @return The style set or NULL if none was. Default is used in that case.
3989 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3991 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
3992 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
3993 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
3994 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
3995 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
3996 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
3997 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
3999 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4000 * (blank mouse, private mouse obj, defaultmouse)
4004 * Sets the keyboard mode of the window.
4006 * @param obj The window object
4007 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4009 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4011 * Gets the keyboard mode of the window.
4013 * @param obj The window object
4014 * @return The mode, one of #Elm_Win_Keyboard_Mode
4016 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Sets whether the window is a keyboard.
4020 * @param obj The window object
4021 * @param is_keyboard If true, the window is a virtual keyboard
4023 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4025 * Gets whether the window is a keyboard.
4027 * @param obj The window object
4028 * @return If the window is a virtual keyboard
4030 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4033 * Get the screen position of a window.
4035 * @param obj The window object
4036 * @param x The int to store the x coordinate to
4037 * @param y The int to store the y coordinate to
4039 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4045 * @defgroup Inwin Inwin
4047 * @image html img/widget/inwin/preview-00.png
4048 * @image latex img/widget/inwin/preview-00.eps
4049 * @image html img/widget/inwin/preview-01.png
4050 * @image latex img/widget/inwin/preview-01.eps
4051 * @image html img/widget/inwin/preview-02.png
4052 * @image latex img/widget/inwin/preview-02.eps
4054 * An inwin is a window inside a window that is useful for a quick popup.
4055 * It does not hover.
4057 * It works by creating an object that will occupy the entire window, so it
4058 * must be created using an @ref Win "elm_win" as parent only. The inwin
4059 * object can be hidden or restacked below every other object if it's
4060 * needed to show what's behind it without destroying it. If this is done,
4061 * the elm_win_inwin_activate() function can be used to bring it back to
4062 * full visibility again.
4064 * There are three styles available in the default theme. These are:
4065 * @li default: The inwin is sized to take over most of the window it's
4067 * @li minimal: The size of the inwin will be the minimum necessary to show
4069 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4070 * possible, but it's sized vertically the most it needs to fit its\
4073 * Some examples of Inwin can be found in the following:
4074 * @li @ref inwin_example_01
4079 * Adds an inwin to the current window
4081 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4082 * Never call this function with anything other than the top-most window
4083 * as its parameter, unless you are fond of undefined behavior.
4085 * After creating the object, the widget will set itself as resize object
4086 * for the window with elm_win_resize_object_add(), so when shown it will
4087 * appear to cover almost the entire window (how much of it depends on its
4088 * content and the style used). It must not be added into other container
4089 * objects and it needs not be moved or resized manually.
4091 * @param parent The parent object
4092 * @return The new object or NULL if it cannot be created
4094 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4096 * Activates an inwin object, ensuring its visibility
4098 * This function will make sure that the inwin @p obj is completely visible
4099 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4100 * to the front. It also sets the keyboard focus to it, which will be passed
4103 * The object's theme will also receive the signal "elm,action,show" with
4106 * @param obj The inwin to activate
4108 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Set the content of an inwin object.
4112 * Once the content object is set, a previously set one will be deleted.
4113 * If you want to keep that old content object, use the
4114 * elm_win_inwin_content_unset() function.
4116 * @param obj The inwin object
4117 * @param content The object to set as content
4119 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4121 * Get the content of an inwin object.
4123 * Return the content object which is set for this widget.
4125 * The returned object is valid as long as the inwin is still alive and no
4126 * other content is set on it. Deleting the object will notify the inwin
4127 * about it and this one will be left empty.
4129 * If you need to remove an inwin's content to be reused somewhere else,
4130 * see elm_win_inwin_content_unset().
4132 * @param obj The inwin object
4133 * @return The content that is being used
4135 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137 * Unset the content of an inwin object.
4139 * Unparent and return the content object which was set for this widget.
4141 * @param obj The inwin object
4142 * @return The content that was being used
4144 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 /* X specific calls - won't work on non-x engines (return 0) */
4151 * Get the Ecore_X_Window of an Evas_Object
4153 * @param obj The object
4155 * @return The Ecore_X_Window of @p obj
4159 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4161 /* smart callbacks called:
4162 * "delete,request" - the user requested to delete the window
4163 * "focus,in" - window got focus
4164 * "focus,out" - window lost focus
4165 * "moved" - window that holds the canvas was moved
4171 * @image html img/widget/bg/preview-00.png
4172 * @image latex img/widget/bg/preview-00.eps
4174 * @brief Background object, used for setting a solid color, image or Edje
4175 * group as background to a window or any container object.
4177 * The bg object is used for setting a solid background to a window or
4178 * packing into any container object. It works just like an image, but has
4179 * some properties useful to a background, like setting it to tiled,
4180 * centered, scaled or stretched.
4182 * Here is some sample code using it:
4183 * @li @ref bg_01_example_page
4184 * @li @ref bg_02_example_page
4185 * @li @ref bg_03_example_page
4189 typedef enum _Elm_Bg_Option
4191 ELM_BG_OPTION_CENTER, /**< center the background */
4192 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4193 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4194 ELM_BG_OPTION_TILE /**< tile background at its original size */
4198 * Add a new background to the parent
4200 * @param parent The parent object
4201 * @return The new object or NULL if it cannot be created
4205 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4208 * Set the file (image or edje) used for the background
4210 * @param obj The bg object
4211 * @param file The file path
4212 * @param group Optional key (group in Edje) within the file
4214 * This sets the image file used in the background object. The image (or edje)
4215 * will be stretched (retaining aspect if its an image file) to completely fill
4216 * the bg object. This may mean some parts are not visible.
4218 * @note Once the image of @p obj is set, a previously set one will be deleted,
4219 * even if @p file is NULL.
4223 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4226 * Get the file (image or edje) used for the background
4228 * @param obj The bg object
4229 * @param file The file path
4230 * @param group Optional key (group in Edje) within the file
4234 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4237 * Set the option used for the background image
4239 * @param obj The bg object
4240 * @param option The desired background option (TILE, SCALE)
4242 * This sets the option used for manipulating the display of the background
4243 * image. The image can be tiled or scaled.
4247 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4250 * Get the option used for the background image
4252 * @param obj The bg object
4253 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4257 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the option used for the background color
4261 * @param obj The bg object
4266 * This sets the color used for the background rectangle. Its range goes
4271 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4273 * Get the option used for the background color
4275 * @param obj The bg object
4282 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4285 * Set the overlay object used for the background object.
4287 * @param obj The bg object
4288 * @param overlay The overlay object
4290 * This provides a way for elm_bg to have an 'overlay' that will be on top
4291 * of the bg. Once the over object is set, a previously set one will be
4292 * deleted, even if you set the new one to NULL. If you want to keep that
4293 * old content object, use the elm_bg_overlay_unset() function.
4298 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4301 * Get the overlay object used for the background object.
4303 * @param obj The bg object
4304 * @return The content that is being used
4306 * Return the content object which is set for this widget
4310 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4313 * Get the overlay object used for the background object.
4315 * @param obj The bg object
4316 * @return The content that was being used
4318 * Unparent and return the overlay object which was set for this widget
4322 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 * Set the size of the pixmap representation of the image.
4327 * This option just makes sense if an image is going to be set in the bg.
4329 * @param obj The bg object
4330 * @param w The new width of the image pixmap representation.
4331 * @param h The new height of the image pixmap representation.
4333 * This function sets a new size for pixmap representation of the given bg
4334 * image. It allows the image to be loaded already in the specified size,
4335 * reducing the memory usage and load time when loading a big image with load
4336 * size set to a smaller size.
4338 * NOTE: this is just a hint, the real size of the pixmap may differ
4339 * depending on the type of image being loaded, being bigger than requested.
4343 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4344 /* smart callbacks called:
4348 * @defgroup Icon Icon
4350 * @image html img/widget/icon/preview-00.png
4351 * @image latex img/widget/icon/preview-00.eps
4353 * An object that provides standard icon images (delete, edit, arrows, etc.)
4354 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4356 * The icon image requested can be in the elementary theme, or in the
4357 * freedesktop.org paths. It's possible to set the order of preference from
4358 * where the image will be used.
4360 * This API is very similar to @ref Image, but with ready to use images.
4362 * Default images provided by the theme are described below.
4364 * The first list contains icons that were first intended to be used in
4365 * toolbars, but can be used in many other places too:
4381 * Now some icons that were designed to be used in menus (but again, you can
4382 * use them anywhere else):
4387 * @li menu/arrow_down
4388 * @li menu/arrow_left
4389 * @li menu/arrow_right
4398 * And here we have some media player specific icons:
4399 * @li media_player/forward
4400 * @li media_player/info
4401 * @li media_player/next
4402 * @li media_player/pause
4403 * @li media_player/play
4404 * @li media_player/prev
4405 * @li media_player/rewind
4406 * @li media_player/stop
4408 * Signals that you can add callbacks for are:
4410 * "clicked" - This is called when a user has clicked the icon
4412 * An example of usage for this API follows:
4413 * @li @ref tutorial_icon
4421 typedef enum _Elm_Icon_Type
4428 * @enum _Elm_Icon_Lookup_Order
4429 * @typedef Elm_Icon_Lookup_Order
4431 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4432 * theme, FDO paths, or both?
4436 typedef enum _Elm_Icon_Lookup_Order
4438 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4439 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4440 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4441 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4442 } Elm_Icon_Lookup_Order;
4445 * Add a new icon object to the parent.
4447 * @param parent The parent object
4448 * @return The new object or NULL if it cannot be created
4450 * @see elm_icon_file_set()
4454 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4456 * Set the file that will be used as icon.
4458 * @param obj The icon object
4459 * @param file The path to file that will be used as icon image
4460 * @param group The group that the icon belongs to in edje file
4462 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4464 * @note The icon image set by this function can be changed by
4465 * elm_icon_standard_set().
4467 * @see elm_icon_file_get()
4471 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4473 * Set a location in memory to be used as an icon
4475 * @param obj The icon object
4476 * @param img The binary data that will be used as an image
4477 * @param size The size of binary data @p img
4478 * @param format Optional format of @p img to pass to the image loader
4479 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4481 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4483 * @note The icon image set by this function can be changed by
4484 * elm_icon_standard_set().
4488 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
4490 * Get the file that will be used as icon.
4492 * @param obj The icon object
4493 * @param file The path to file that will be used as icon icon image
4494 * @param group The group that the icon belongs to in edje file
4496 * @see elm_icon_file_set()
4500 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4501 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4503 * Set the icon by icon standards names.
4505 * @param obj The icon object
4506 * @param name The icon name
4508 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4510 * For example, freedesktop.org defines standard icon names such as "home",
4511 * "network", etc. There can be different icon sets to match those icon
4512 * keys. The @p name given as parameter is one of these "keys", and will be
4513 * used to look in the freedesktop.org paths and elementary theme. One can
4514 * change the lookup order with elm_icon_order_lookup_set().
4516 * If name is not found in any of the expected locations and it is the
4517 * absolute path of an image file, this image will be used.
4519 * @note The icon image set by this function can be changed by
4520 * elm_icon_file_set().
4522 * @see elm_icon_standard_get()
4523 * @see elm_icon_file_set()
4527 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4529 * Get the icon name set by icon standard names.
4531 * @param obj The icon object
4532 * @return The icon name
4534 * If the icon image was set using elm_icon_file_set() instead of
4535 * elm_icon_standard_set(), then this function will return @c NULL.
4537 * @see elm_icon_standard_set()
4541 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4543 * Set the smooth effect for an icon object.
4545 * @param obj The icon object
4546 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4547 * otherwise. Default is @c EINA_TRUE.
4549 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4550 * scaling provides a better resulting image, but is slower.
4552 * The smooth scaling should be disabled when making animations that change
4553 * the icon size, since they will be faster. Animations that don't require
4554 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4555 * is already scaled, since the scaled icon image will be cached).
4557 * @see elm_icon_smooth_get()
4561 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4563 * Get the smooth effect for an icon object.
4565 * @param obj The icon object
4566 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4568 * @see elm_icon_smooth_set()
4572 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4574 * Disable scaling of this object.
4576 * @param obj The icon object.
4577 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4578 * otherwise. Default is @c EINA_FALSE.
4580 * This function disables scaling of the icon object through the function
4581 * elm_object_scale_set(). However, this does not affect the object
4582 * size/resize in any way. For that effect, take a look at
4583 * elm_icon_scale_set().
4585 * @see elm_icon_no_scale_get()
4586 * @see elm_icon_scale_set()
4587 * @see elm_object_scale_set()
4591 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4593 * Get whether scaling is disabled on the object.
4595 * @param obj The icon object
4596 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4598 * @see elm_icon_no_scale_set()
4602 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4604 * Set if the object is (up/down) resizeable.
4606 * @param obj The icon object
4607 * @param scale_up A bool to set if the object is resizeable up. Default is
4609 * @param scale_down A bool to set if the object is resizeable down. Default
4612 * This function limits the icon object resize ability. If @p scale_up is set to
4613 * @c EINA_FALSE, the object can't have its height or width resized to a value
4614 * higher than the original icon size. Same is valid for @p scale_down.
4616 * @see elm_icon_scale_get()
4620 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4622 * Get if the object is (up/down) resizeable.
4624 * @param obj The icon object
4625 * @param scale_up A bool to set if the object is resizeable up
4626 * @param scale_down A bool to set if the object is resizeable down
4628 * @see elm_icon_scale_set()
4632 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4634 * Get the object's image size
4636 * @param obj The icon object
4637 * @param w A pointer to store the width in
4638 * @param h A pointer to store the height in
4642 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4644 * Set if the icon fill the entire object area.
4646 * @param obj The icon object
4647 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4648 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4650 * When the icon object is resized to a different aspect ratio from the
4651 * original icon image, the icon image will still keep its aspect. This flag
4652 * tells how the image should fill the object's area. They are: keep the
4653 * entire icon inside the limits of height and width of the object (@p
4654 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4655 * of the object, and the icon will fill the entire object (@p fill_outside
4658 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4659 * retain property to false. Thus, the icon image will always keep its
4660 * original aspect ratio.
4662 * @see elm_icon_fill_outside_get()
4663 * @see elm_image_fill_outside_set()
4667 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4669 * Get if the object is filled outside.
4671 * @param obj The icon object
4672 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4674 * @see elm_icon_fill_outside_set()
4678 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4680 * Set the prescale size for the icon.
4682 * @param obj The icon object
4683 * @param size The prescale size. This value is used for both width and
4686 * This function sets a new size for pixmap representation of the given
4687 * icon. It allows the icon to be loaded already in the specified size,
4688 * reducing the memory usage and load time when loading a big icon with load
4689 * size set to a smaller size.
4691 * It's equivalent to the elm_bg_load_size_set() function for bg.
4693 * @note this is just a hint, the real size of the pixmap may differ
4694 * depending on the type of icon being loaded, being bigger than requested.
4696 * @see elm_icon_prescale_get()
4697 * @see elm_bg_load_size_set()
4701 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4703 * Get the prescale size for the icon.
4705 * @param obj The icon object
4706 * @return The prescale size
4708 * @see elm_icon_prescale_set()
4712 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4714 * Sets the icon lookup order used by elm_icon_standard_set().
4716 * @param obj The icon object
4717 * @param order The icon lookup order (can be one of
4718 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4719 * or ELM_ICON_LOOKUP_THEME)
4721 * @see elm_icon_order_lookup_get()
4722 * @see Elm_Icon_Lookup_Order
4726 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4728 * Gets the icon lookup order.
4730 * @param obj The icon object
4731 * @return The icon lookup order
4733 * @see elm_icon_order_lookup_set()
4734 * @see Elm_Icon_Lookup_Order
4738 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4740 * Get the flag related with elm icon can support animation
4742 * @param obj The icon object
4743 * @return The flag of animation available
4745 * Return this elm icon's image can be animated
4746 * Currently Evas only support gif's animation
4747 * If the return value of this function is EINA_FALSE,
4748 * other elm_icon_animated_XXX functions don't work
4751 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4753 * Set animation mode of the icon.
4755 * @param obj The icon object
4756 * @param anim @c EINA_TRUE if the object do animation job,
4757 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4759 * Even though elm icon's file can be animated,
4760 * sometimes appication developer want to just first page of image.
4761 * In that time, don't call this function, because default value is EINA_FALSE
4762 * Only when you want icon support anition,
4763 * use this function and set animated to EINA_TURE
4766 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4768 * Get animation mode of the icon.
4770 * @param obj The icon object
4771 * @return The animation mode of the icon object
4772 * @see elm_icon_animated_set
4775 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4777 * Set animation play mode of the icon.
4779 * @param obj The icon object
4780 * @param play @c EINA_TRUE the object play animation images,
4781 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4783 * If you want to play elm icon's animation, you set play to EINA_TURE.
4784 * For example, you make gif player using this set/get API and click event.
4786 * 1. Click event occurs
4787 * 2. Check play flag using elm_icon_animaged_play_get
4788 * 3. If elm icon was playing, set play to EINA_FALSE.
4789 * Then animation will be stopped and vice versa
4792 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4794 * Get animation play mode of the icon.
4796 * @param obj The icon object
4797 * @return The play mode of the icon object
4799 * @see elm_icon_animated_lay_get
4802 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4809 * @defgroup Image Image
4811 * @image html img/widget/image/preview-00.png
4812 * @image latex img/widget/image/preview-00.eps
4815 * An object that allows one to load an image file to it. It can be used
4816 * anywhere like any other elementary widget.
4818 * This widget provides most of the functionality provided from @ref Bg or @ref
4819 * Icon, but with a slightly different API (use the one that fits better your
4822 * The features not provided by those two other image widgets are:
4823 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4824 * @li change the object orientation with elm_image_orient_set();
4825 * @li and turning the image editable with elm_image_editable_set().
4827 * Signals that you can add callbacks for are:
4829 * @li @c "clicked" - This is called when a user has clicked the image
4831 * An example of usage for this API follows:
4832 * @li @ref tutorial_image
4841 * @enum _Elm_Image_Orient
4842 * @typedef Elm_Image_Orient
4844 * Possible orientation options for elm_image_orient_set().
4846 * @image html elm_image_orient_set.png
4847 * @image latex elm_image_orient_set.eps width=\textwidth
4851 typedef enum _Elm_Image_Orient
4853 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4854 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4855 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4856 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4857 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4858 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4859 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4860 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4864 * Add a new image to the parent.
4866 * @param parent The parent object
4867 * @return The new object or NULL if it cannot be created
4869 * @see elm_image_file_set()
4873 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4875 * Set the file that will be used as image.
4877 * @param obj The image object
4878 * @param file The path to file that will be used as image
4879 * @param group The group that the image belongs in edje file (if it's an
4882 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4884 * @see elm_image_file_get()
4888 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4890 * Get the file that will be used as image.
4892 * @param obj The image object
4893 * @param file The path to file
4894 * @param group The group that the image belongs in edje file
4896 * @see elm_image_file_set()
4900 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4902 * Set the smooth effect for an image.
4904 * @param obj The image object
4905 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4906 * otherwise. Default is @c EINA_TRUE.
4908 * Set the scaling algorithm to be used when scaling the image. Smooth
4909 * scaling provides a better resulting image, but is slower.
4911 * The smooth scaling should be disabled when making animations that change
4912 * the image size, since it will be faster. Animations that don't require
4913 * resizing of the image can keep the smooth scaling enabled (even if the
4914 * image is already scaled, since the scaled image will be cached).
4916 * @see elm_image_smooth_get()
4920 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4922 * Get the smooth effect for an image.
4924 * @param obj The image object
4925 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4927 * @see elm_image_smooth_get()
4931 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 * Gets the current size of the image.
4935 * @param obj The image object.
4936 * @param w Pointer to store width, or NULL.
4937 * @param h Pointer to store height, or NULL.
4939 * This is the real size of the image, not the size of the object.
4941 * On error, neither w or h will be written.
4945 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4947 * Disable scaling of this object.
4949 * @param obj The image object.
4950 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4951 * otherwise. Default is @c EINA_FALSE.
4953 * This function disables scaling of the elm_image widget through the
4954 * function elm_object_scale_set(). However, this does not affect the widget
4955 * size/resize in any way. For that effect, take a look at
4956 * elm_image_scale_set().
4958 * @see elm_image_no_scale_get()
4959 * @see elm_image_scale_set()
4960 * @see elm_object_scale_set()
4964 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4966 * Get whether scaling is disabled on the object.
4968 * @param obj The image object
4969 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4971 * @see elm_image_no_scale_set()
4975 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4977 * Set if the object is (up/down) resizeable.
4979 * @param obj The image object
4980 * @param scale_up A bool to set if the object is resizeable up. Default is
4982 * @param scale_down A bool to set if the object is resizeable down. Default
4985 * This function limits the image resize ability. If @p scale_up is set to
4986 * @c EINA_FALSE, the object can't have its height or width resized to a value
4987 * higher than the original image size. Same is valid for @p scale_down.
4989 * @see elm_image_scale_get()
4993 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4995 * Get if the object is (up/down) resizeable.
4997 * @param obj The image object
4998 * @param scale_up A bool to set if the object is resizeable up
4999 * @param scale_down A bool to set if the object is resizeable down
5001 * @see elm_image_scale_set()
5005 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5007 * Set if the image fill the entire object area when keeping the aspect ratio.
5009 * @param obj The image object
5010 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5011 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5013 * When the image should keep its aspect ratio even if resized to another
5014 * aspect ratio, there are two possibilities to resize it: keep the entire
5015 * image inside the limits of height and width of the object (@p fill_outside
5016 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5017 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5019 * @note This option will have no effect if
5020 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5022 * @see elm_image_fill_outside_get()
5023 * @see elm_image_aspect_ratio_retained_set()
5027 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5029 * Get if the object is filled outside
5031 * @param obj The image object
5032 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5034 * @see elm_image_fill_outside_set()
5038 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5040 * Set the prescale size for the image
5042 * @param obj The image object
5043 * @param size The prescale size. This value is used for both width and
5046 * This function sets a new size for pixmap representation of the given
5047 * image. It allows the image to be loaded already in the specified size,
5048 * reducing the memory usage and load time when loading a big image with load
5049 * size set to a smaller size.
5051 * It's equivalent to the elm_bg_load_size_set() function for bg.
5053 * @note this is just a hint, the real size of the pixmap may differ
5054 * depending on the type of image being loaded, being bigger than requested.
5056 * @see elm_image_prescale_get()
5057 * @see elm_bg_load_size_set()
5061 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5063 * Get the prescale size for the image
5065 * @param obj The image object
5066 * @return The prescale size
5068 * @see elm_image_prescale_set()
5072 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5074 * Set the image orientation.
5076 * @param obj The image object
5077 * @param orient The image orientation
5078 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5079 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5080 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5081 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5082 * Default is #ELM_IMAGE_ORIENT_NONE.
5084 * This function allows to rotate or flip the given image.
5086 * @see elm_image_orient_get()
5087 * @see @ref Elm_Image_Orient
5091 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5093 * Get the image orientation.
5095 * @param obj The image object
5096 * @return The image orientation
5097 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5098 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5099 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5100 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5102 * @see elm_image_orient_set()
5103 * @see @ref Elm_Image_Orient
5107 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5109 * Make the image 'editable'.
5111 * @param obj Image object.
5112 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5114 * This means the image is a valid drag target for drag and drop, and can be
5115 * cut or pasted too.
5119 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5121 * Make the image 'editable'.
5123 * @param obj Image object.
5124 * @return Editability.
5126 * This means the image is a valid drag target for drag and drop, and can be
5127 * cut or pasted too.
5131 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5133 * Get the basic Evas_Image object from this object (widget).
5135 * @param obj The image object to get the inlined image from
5136 * @return The inlined image object, or NULL if none exists
5138 * This function allows one to get the underlying @c Evas_Object of type
5139 * Image from this elementary widget. It can be useful to do things like get
5140 * the pixel data, save the image to a file, etc.
5142 * @note Be careful to not manipulate it, as it is under control of
5147 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5149 * Set whether the original aspect ratio of the image should be kept on resize.
5151 * @param obj The image object.
5152 * @param retained @c EINA_TRUE if the image should retain the aspect,
5153 * @c EINA_FALSE otherwise.
5155 * The original aspect ratio (width / height) of the image is usually
5156 * distorted to match the object's size. Enabling this option will retain
5157 * this original aspect, and the way that the image is fit into the object's
5158 * area depends on the option set by elm_image_fill_outside_set().
5160 * @see elm_image_aspect_ratio_retained_get()
5161 * @see elm_image_fill_outside_set()
5165 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5167 * Get if the object retains the original aspect ratio.
5169 * @param obj The image object.
5170 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5175 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5177 /* smart callbacks called:
5178 * "clicked" - the user clicked the image
5186 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5188 typedef enum _Elm_GLView_Mode
5190 ELM_GLVIEW_ALPHA = 1,
5191 ELM_GLVIEW_DEPTH = 2,
5192 ELM_GLVIEW_STENCIL = 4
5196 * Defines a policy for the glview resizing.
5198 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5200 typedef enum _Elm_GLView_Resize_Policy
5202 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5203 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5204 } Elm_GLView_Resize_Policy;
5206 typedef enum _Elm_GLView_Render_Policy
5208 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5209 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5210 } Elm_GLView_Render_Policy;
5215 * A simple GLView widget that allows GL rendering.
5217 * Signals that you can add callbacks for are:
5223 * Add a new glview to the parent
5225 * @param parent The parent object
5226 * @return The new object or NULL if it cannot be created
5230 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5233 * Sets the size of the glview
5235 * @param obj The glview object
5236 * @param width width of the glview object
5237 * @param height height of the glview object
5241 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5244 * Gets the size of the glview.
5246 * @param obj The glview object
5247 * @param width width of the glview object
5248 * @param height height of the glview object
5250 * Note that this function returns the actual image size of the
5251 * glview. This means that when the scale policy is set to
5252 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5257 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5260 * Gets the gl api struct for gl rendering
5262 * @param obj The glview object
5263 * @return The api object or NULL if it cannot be created
5267 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5270 * Set the mode of the GLView. Supports Three simple modes.
5272 * @param obj The glview object
5273 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5274 * @return True if set properly.
5278 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5281 * Set the resize policy for the glview object.
5283 * @param obj The glview object.
5284 * @param policy The scaling policy.
5286 * By default, the resize policy is set to
5287 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5288 * destroys the previous surface and recreates the newly specified
5289 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5290 * however, glview only scales the image object and not the underlying
5295 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5298 * Set the render policy for the glview object.
5300 * @param obj The glview object.
5301 * @param policy The render policy.
5303 * By default, the render policy is set to
5304 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5305 * that during the render loop, glview is only redrawn if it needs
5306 * to be redrawn. (i.e. When it is visible) If the policy is set to
5307 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5308 * whether it is visible/need redrawing or not.
5312 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5315 * Set the init function that runs once in the main loop.
5317 * @param obj The glview object.
5318 * @param func The init function to be registered.
5320 * The registered init function gets called once during the render loop.
5324 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5327 * Set the render function that runs in the main loop.
5329 * @param obj The glview object.
5330 * @param func The delete function to be registered.
5332 * The registered del function gets called when GLView object is deleted.
5336 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5339 * Set the resize function that gets called when resize happens.
5341 * @param obj The glview object.
5342 * @param func The resize function to be registered.
5346 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5349 * Set the render function that runs in the main loop.
5351 * @param obj The glview object.
5352 * @param func The render function to be registered.
5356 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5359 * Notifies that there has been changes in the GLView.
5361 * @param obj The glview object.
5365 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5375 * @image html img/widget/box/preview-00.png
5376 * @image latex img/widget/box/preview-00.eps width=\textwidth
5378 * @image html img/box.png
5379 * @image latex img/box.eps width=\textwidth
5381 * A box arranges objects in a linear fashion, governed by a layout function
5382 * that defines the details of this arrangement.
5384 * By default, the box will use an internal function to set the layout to
5385 * a single row, either vertical or horizontal. This layout is affected
5386 * by a number of parameters, such as the homogeneous flag set by
5387 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5388 * elm_box_align_set() and the hints set to each object in the box.
5390 * For this default layout, it's possible to change the orientation with
5391 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5392 * placing its elements ordered from top to bottom. When horizontal is set,
5393 * the order will go from left to right. If the box is set to be
5394 * homogeneous, every object in it will be assigned the same space, that
5395 * of the largest object. Padding can be used to set some spacing between
5396 * the cell given to each object. The alignment of the box, set with
5397 * elm_box_align_set(), determines how the bounding box of all the elements
5398 * will be placed within the space given to the box widget itself.
5400 * The size hints of each object also affect how they are placed and sized
5401 * within the box. evas_object_size_hint_min_set() will give the minimum
5402 * size the object can have, and the box will use it as the basis for all
5403 * latter calculations. Elementary widgets set their own minimum size as
5404 * needed, so there's rarely any need to use it manually.
5406 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5407 * used to tell whether the object will be allocated the minimum size it
5408 * needs or if the space given to it should be expanded. It's important
5409 * to realize that expanding the size given to the object is not the same
5410 * thing as resizing the object. It could very well end being a small
5411 * widget floating in a much larger empty space. If not set, the weight
5412 * for objects will normally be 0.0 for both axis, meaning the widget will
5413 * not be expanded. To take as much space possible, set the weight to
5414 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5416 * Besides how much space each object is allocated, it's possible to control
5417 * how the widget will be placed within that space using
5418 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5419 * for both axis, meaning the object will be centered, but any value from
5420 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5421 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5422 * is -1.0, means the object will be resized to fill the entire space it
5425 * In addition, customized functions to define the layout can be set, which
5426 * allow the application developer to organize the objects within the box
5427 * in any number of ways.
5429 * The special elm_box_layout_transition() function can be used
5430 * to switch from one layout to another, animating the motion of the
5431 * children of the box.
5433 * @note Objects should not be added to box objects using _add() calls.
5435 * Some examples on how to use boxes follow:
5436 * @li @ref box_example_01
5437 * @li @ref box_example_02
5442 * @typedef Elm_Box_Transition
5444 * Opaque handler containing the parameters to perform an animated
5445 * transition of the layout the box uses.
5447 * @see elm_box_transition_new()
5448 * @see elm_box_layout_set()
5449 * @see elm_box_layout_transition()
5451 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5454 * Add a new box to the parent
5456 * By default, the box will be in vertical mode and non-homogeneous.
5458 * @param parent The parent object
5459 * @return The new object or NULL if it cannot be created
5461 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5463 * Set the horizontal orientation
5465 * By default, box object arranges their contents vertically from top to
5467 * By calling this function with @p horizontal as EINA_TRUE, the box will
5468 * become horizontal, arranging contents from left to right.
5470 * @note This flag is ignored if a custom layout function is set.
5472 * @param obj The box object
5473 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5474 * EINA_FALSE = vertical)
5476 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5478 * Get the horizontal orientation
5480 * @param obj The box object
5481 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5483 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5485 * Set the box to arrange its children homogeneously
5487 * If enabled, homogeneous layout makes all items the same size, according
5488 * to the size of the largest of its children.
5490 * @note This flag is ignored if a custom layout function is set.
5492 * @param obj The box object
5493 * @param homogeneous The homogeneous flag
5495 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5497 * Get whether the box is using homogeneous mode or not
5499 * @param obj The box object
5500 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5502 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5504 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5506 * Add an object to the beginning of the pack list
5508 * Pack @p subobj into the box @p obj, placing it first in the list of
5509 * children objects. The actual position the object will get on screen
5510 * depends on the layout used. If no custom layout is set, it will be at
5511 * the top or left, depending if the box is vertical or horizontal,
5514 * @param obj The box object
5515 * @param subobj The object to add to the box
5517 * @see elm_box_pack_end()
5518 * @see elm_box_pack_before()
5519 * @see elm_box_pack_after()
5520 * @see elm_box_unpack()
5521 * @see elm_box_unpack_all()
5522 * @see elm_box_clear()
5524 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5526 * Add an object at the end of the pack list
5528 * Pack @p subobj into the box @p obj, placing it last in the list of
5529 * children objects. The actual position the object will get on screen
5530 * depends on the layout used. If no custom layout is set, it will be at
5531 * the bottom or right, depending if the box is vertical or horizontal,
5534 * @param obj The box object
5535 * @param subobj The object to add to the box
5537 * @see elm_box_pack_start()
5538 * @see elm_box_pack_before()
5539 * @see elm_box_pack_after()
5540 * @see elm_box_unpack()
5541 * @see elm_box_unpack_all()
5542 * @see elm_box_clear()
5544 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5546 * Adds an object to the box before the indicated object
5548 * This will add the @p subobj to the box indicated before the object
5549 * indicated with @p before. If @p before is not already in the box, results
5550 * are undefined. Before means either to the left of the indicated object or
5551 * above it depending on orientation.
5553 * @param obj The box object
5554 * @param subobj The object to add to the box
5555 * @param before The object before which to add it
5557 * @see elm_box_pack_start()
5558 * @see elm_box_pack_end()
5559 * @see elm_box_pack_after()
5560 * @see elm_box_unpack()
5561 * @see elm_box_unpack_all()
5562 * @see elm_box_clear()
5564 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5566 * Adds an object to the box after the indicated object
5568 * This will add the @p subobj to the box indicated after the object
5569 * indicated with @p after. If @p after is not already in the box, results
5570 * are undefined. After means either to the right of the indicated object or
5571 * below it depending on orientation.
5573 * @param obj The box object
5574 * @param subobj The object to add to the box
5575 * @param after The object after which to add it
5577 * @see elm_box_pack_start()
5578 * @see elm_box_pack_end()
5579 * @see elm_box_pack_before()
5580 * @see elm_box_unpack()
5581 * @see elm_box_unpack_all()
5582 * @see elm_box_clear()
5584 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5586 * Clear the box of all children
5588 * Remove all the elements contained by the box, deleting the respective
5591 * @param obj The box object
5593 * @see elm_box_unpack()
5594 * @see elm_box_unpack_all()
5596 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5600 * Remove the object given by @p subobj from the box @p obj without
5603 * @param obj The box object
5605 * @see elm_box_unpack_all()
5606 * @see elm_box_clear()
5608 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5610 * Remove all items from the box, without deleting them
5612 * Clear the box from all children, but don't delete the respective objects.
5613 * If no other references of the box children exist, the objects will never
5614 * be deleted, and thus the application will leak the memory. Make sure
5615 * when using this function that you hold a reference to all the objects
5616 * in the box @p obj.
5618 * @param obj The box object
5620 * @see elm_box_clear()
5621 * @see elm_box_unpack()
5623 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5625 * Retrieve a list of the objects packed into the box
5627 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5628 * The order of the list corresponds to the packing order the box uses.
5630 * You must free this list with eina_list_free() once you are done with it.
5632 * @param obj The box object
5634 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5636 * Set the space (padding) between the box's elements.
5638 * Extra space in pixels that will be added between a box child and its
5639 * neighbors after its containing cell has been calculated. This padding
5640 * is set for all elements in the box, besides any possible padding that
5641 * individual elements may have through their size hints.
5643 * @param obj The box object
5644 * @param horizontal The horizontal space between elements
5645 * @param vertical The vertical space between elements
5647 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5649 * Get the space (padding) between the box's elements.
5651 * @param obj The box object
5652 * @param horizontal The horizontal space between elements
5653 * @param vertical The vertical space between elements
5655 * @see elm_box_padding_set()
5657 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5659 * Set the alignment of the whole bouding box of contents.
5661 * Sets how the bounding box containing all the elements of the box, after
5662 * their sizes and position has been calculated, will be aligned within
5663 * the space given for the whole box widget.
5665 * @param obj The box object
5666 * @param horizontal The horizontal alignment of elements
5667 * @param vertical The vertical alignment of elements
5669 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5671 * Get the alignment of the whole bouding box of contents.
5673 * @param obj The box object
5674 * @param horizontal The horizontal alignment of elements
5675 * @param vertical The vertical alignment of elements
5677 * @see elm_box_align_set()
5679 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5682 * Set the layout defining function to be used by the box
5684 * Whenever anything changes that requires the box in @p obj to recalculate
5685 * the size and position of its elements, the function @p cb will be called
5686 * to determine what the layout of the children will be.
5688 * Once a custom function is set, everything about the children layout
5689 * is defined by it. The flags set by elm_box_horizontal_set() and
5690 * elm_box_homogeneous_set() no longer have any meaning, and the values
5691 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5692 * layout function to decide if they are used and how. These last two
5693 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5694 * passed to @p cb. The @c Evas_Object the function receives is not the
5695 * Elementary widget, but the internal Evas Box it uses, so none of the
5696 * functions described here can be used on it.
5698 * Any of the layout functions in @c Evas can be used here, as well as the
5699 * special elm_box_layout_transition().
5701 * The final @p data argument received by @p cb is the same @p data passed
5702 * here, and the @p free_data function will be called to free it
5703 * whenever the box is destroyed or another layout function is set.
5705 * Setting @p cb to NULL will revert back to the default layout function.
5707 * @param obj The box object
5708 * @param cb The callback function used for layout
5709 * @param data Data that will be passed to layout function
5710 * @param free_data Function called to free @p data
5712 * @see elm_box_layout_transition()
5714 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);
5716 * Special layout function that animates the transition from one layout to another
5718 * Normally, when switching the layout function for a box, this will be
5719 * reflected immediately on screen on the next render, but it's also
5720 * possible to do this through an animated transition.
5722 * This is done by creating an ::Elm_Box_Transition and setting the box
5723 * layout to this function.
5727 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5728 * evas_object_box_layout_vertical, // start
5729 * NULL, // data for initial layout
5730 * NULL, // free function for initial data
5731 * evas_object_box_layout_horizontal, // end
5732 * NULL, // data for final layout
5733 * NULL, // free function for final data
5734 * anim_end, // will be called when animation ends
5735 * NULL); // data for anim_end function\
5736 * elm_box_layout_set(box, elm_box_layout_transition, t,
5737 * elm_box_transition_free);
5740 * @note This function can only be used with elm_box_layout_set(). Calling
5741 * it directly will not have the expected results.
5743 * @see elm_box_transition_new
5744 * @see elm_box_transition_free
5745 * @see elm_box_layout_set
5747 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5749 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5751 * If you want to animate the change from one layout to another, you need
5752 * to set the layout function of the box to elm_box_layout_transition(),
5753 * passing as user data to it an instance of ::Elm_Box_Transition with the
5754 * necessary information to perform this animation. The free function to
5755 * set for the layout is elm_box_transition_free().
5757 * The parameters to create an ::Elm_Box_Transition sum up to how long
5758 * will it be, in seconds, a layout function to describe the initial point,
5759 * another for the final position of the children and one function to be
5760 * called when the whole animation ends. This last function is useful to
5761 * set the definitive layout for the box, usually the same as the end
5762 * layout for the animation, but could be used to start another transition.
5764 * @param start_layout The layout function that will be used to start the animation
5765 * @param start_layout_data The data to be passed the @p start_layout function
5766 * @param start_layout_free_data Function to free @p start_layout_data
5767 * @param end_layout The layout function that will be used to end the animation
5768 * @param end_layout_free_data The data to be passed the @p end_layout function
5769 * @param end_layout_free_data Function to free @p end_layout_data
5770 * @param transition_end_cb Callback function called when animation ends
5771 * @param transition_end_data Data to be passed to @p transition_end_cb
5772 * @return An instance of ::Elm_Box_Transition
5774 * @see elm_box_transition_new
5775 * @see elm_box_layout_transition
5777 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);
5779 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5781 * This function is mostly useful as the @c free_data parameter in
5782 * elm_box_layout_set() when elm_box_layout_transition().
5784 * @param data The Elm_Box_Transition instance to be freed.
5786 * @see elm_box_transition_new
5787 * @see elm_box_layout_transition
5789 EAPI void elm_box_transition_free(void *data);
5796 * @defgroup Button Button
5798 * @image html img/widget/button/preview-00.png
5799 * @image latex img/widget/button/preview-00.eps
5800 * @image html img/widget/button/preview-01.png
5801 * @image latex img/widget/button/preview-01.eps
5802 * @image html img/widget/button/preview-02.png
5803 * @image latex img/widget/button/preview-02.eps
5805 * This is a push-button. Press it and run some function. It can contain
5806 * a simple label and icon object and it also has an autorepeat feature.
5808 * This widgets emits the following signals:
5809 * @li "clicked": the user clicked the button (press/release).
5810 * @li "repeated": the user pressed the button without releasing it.
5811 * @li "pressed": button was pressed.
5812 * @li "unpressed": button was released after being pressed.
5813 * In all three cases, the @c event parameter of the callback will be
5816 * Also, defined in the default theme, the button has the following styles
5818 * @li default: a normal button.
5819 * @li anchor: Like default, but the button fades away when the mouse is not
5820 * over it, leaving only the text or icon.
5821 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5822 * continuous look across its options.
5823 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5825 * Follow through a complete example @ref button_example_01 "here".
5829 * Add a new button to the parent's canvas
5831 * @param parent The parent object
5832 * @return The new object or NULL if it cannot be created
5834 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5836 * Set the label used in the button
5838 * The passed @p label can be NULL to clean any existing text in it and
5839 * leave the button as an icon only object.
5841 * @param obj The button object
5842 * @param label The text will be written on the button
5843 * @deprecated use elm_object_text_set() instead.
5845 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5847 * Get the label set for the button
5849 * The string returned is an internal pointer and should not be freed or
5850 * altered. It will also become invalid when the button is destroyed.
5851 * The string returned, if not NULL, is a stringshare, so if you need to
5852 * keep it around even after the button is destroyed, you can use
5853 * eina_stringshare_ref().
5855 * @param obj The button object
5856 * @return The text set to the label, or NULL if nothing is set
5857 * @deprecated use elm_object_text_set() instead.
5859 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5861 * Set the icon used for the button
5863 * Setting a new icon will delete any other that was previously set, making
5864 * any reference to them invalid. If you need to maintain the previous
5865 * object alive, unset it first with elm_button_icon_unset().
5867 * @param obj The button object
5868 * @param icon The icon object for the button
5870 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5872 * Get the icon used for the button
5874 * Return the icon object which is set for this widget. If the button is
5875 * destroyed or another icon is set, the returned object will be deleted
5876 * and any reference to it will be invalid.
5878 * @param obj The button object
5879 * @return The icon object that is being used
5881 * @see elm_button_icon_unset()
5883 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5885 * Remove the icon set without deleting it and return the object
5887 * This function drops the reference the button holds of the icon object
5888 * and returns this last object. It is used in case you want to remove any
5889 * icon, or set another one, without deleting the actual object. The button
5890 * will be left without an icon set.
5892 * @param obj The button object
5893 * @return The icon object that was being used
5895 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5897 * Turn on/off the autorepeat event generated when the button is kept pressed
5899 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5900 * signal when they are clicked.
5902 * When on, keeping a button pressed will continuously emit a @c repeated
5903 * signal until the button is released. The time it takes until it starts
5904 * emitting the signal is given by
5905 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5906 * new emission by elm_button_autorepeat_gap_timeout_set().
5908 * @param obj The button object
5909 * @param on A bool to turn on/off the event
5911 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5913 * Get whether the autorepeat feature is enabled
5915 * @param obj The button object
5916 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5918 * @see elm_button_autorepeat_set()
5920 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5922 * Set the initial timeout before the autorepeat event is generated
5924 * Sets the timeout, in seconds, since the button is pressed until the
5925 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5926 * won't be any delay and the even will be fired the moment the button is
5929 * @param obj The button object
5930 * @param t Timeout in seconds
5932 * @see elm_button_autorepeat_set()
5933 * @see elm_button_autorepeat_gap_timeout_set()
5935 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5937 * Get the initial timeout before the autorepeat event is generated
5939 * @param obj The button object
5940 * @return Timeout in seconds
5942 * @see elm_button_autorepeat_initial_timeout_set()
5944 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5946 * Set the interval between each generated autorepeat event
5948 * After the first @c repeated event is fired, all subsequent ones will
5949 * follow after a delay of @p t seconds for each.
5951 * @param obj The button object
5952 * @param t Interval in seconds
5954 * @see elm_button_autorepeat_initial_timeout_set()
5956 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5958 * Get the interval between each generated autorepeat event
5960 * @param obj The button object
5961 * @return Interval in seconds
5963 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 * @defgroup File_Selector_Button File Selector Button
5971 * @image html img/widget/fileselector_button/preview-00.png
5972 * @image latex img/widget/fileselector_button/preview-00.eps
5973 * @image html img/widget/fileselector_button/preview-01.png
5974 * @image latex img/widget/fileselector_button/preview-01.eps
5975 * @image html img/widget/fileselector_button/preview-02.png
5976 * @image latex img/widget/fileselector_button/preview-02.eps
5978 * This is a button that, when clicked, creates an Elementary
5979 * window (or inner window) <b> with a @ref Fileselector "file
5980 * selector widget" within</b>. When a file is chosen, the (inner)
5981 * window is closed and the button emits a signal having the
5982 * selected file as it's @c event_info.
5984 * This widget encapsulates operations on its internal file
5985 * selector on its own API. There is less control over its file
5986 * selector than that one would have instatiating one directly.
5988 * The following styles are available for this button:
5991 * @li @c "hoversel_vertical"
5992 * @li @c "hoversel_vertical_entry"
5994 * Smart callbacks one can register to:
5995 * - @c "file,chosen" - the user has selected a path, whose string
5996 * pointer comes as the @c event_info data (a stringshared
5999 * Here is an example on its usage:
6000 * @li @ref fileselector_button_example
6002 * @see @ref File_Selector_Entry for a similar widget.
6007 * Add a new file selector button widget to the given parent
6008 * Elementary (container) object
6010 * @param parent The parent object
6011 * @return a new file selector button widget handle or @c NULL, on
6014 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6017 * Set the label for a given file selector button widget
6019 * @param obj The file selector button widget
6020 * @param label The text label to be displayed on @p obj
6022 * @deprecated use elm_object_text_set() instead.
6024 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6027 * Get the label set for a given file selector button widget
6029 * @param obj The file selector button widget
6030 * @return The button label
6032 * @deprecated use elm_object_text_set() instead.
6034 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6037 * Set the icon on a given file selector button widget
6039 * @param obj The file selector button widget
6040 * @param icon The icon object for the button
6042 * Once the icon object is set, a previously set one will be
6043 * deleted. If you want to keep the latter, use the
6044 * elm_fileselector_button_icon_unset() function.
6046 * @see elm_fileselector_button_icon_get()
6048 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6051 * Get the icon set for a given file selector button widget
6053 * @param obj The file selector button widget
6054 * @return The icon object currently set on @p obj or @c NULL, if
6057 * @see elm_fileselector_button_icon_set()
6059 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062 * Unset the icon used in a given file selector button widget
6064 * @param obj The file selector button widget
6065 * @return The icon object that was being used on @p obj or @c
6068 * Unparent and return the icon object which was set for this
6071 * @see elm_fileselector_button_icon_set()
6073 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6076 * Set the title for a given file selector button widget's window
6078 * @param obj The file selector button widget
6079 * @param title The title string
6081 * This will change the window's title, when the file selector pops
6082 * out after a click on the button. Those windows have the default
6083 * (unlocalized) value of @c "Select a file" as titles.
6085 * @note It will only take any effect if the file selector
6086 * button widget is @b not under "inwin mode".
6088 * @see elm_fileselector_button_window_title_get()
6090 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6093 * Get the title set for a given file selector button widget's
6096 * @param obj The file selector button widget
6097 * @return Title of the file selector button's window
6099 * @see elm_fileselector_button_window_title_get() for more details
6101 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6104 * Set the size of a given file selector button widget's window,
6105 * holding the file selector itself.
6107 * @param obj The file selector button widget
6108 * @param width The window's width
6109 * @param height The window's height
6111 * @note it will only take any effect if the file selector button
6112 * widget is @b not under "inwin mode". The default size for the
6113 * window (when applicable) is 400x400 pixels.
6115 * @see elm_fileselector_button_window_size_get()
6117 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6120 * Get the size of a given file selector button widget's window,
6121 * holding the file selector itself.
6123 * @param obj The file selector button widget
6124 * @param width Pointer into which to store the width value
6125 * @param height Pointer into which to store the height value
6127 * @note Use @c NULL pointers on the size values you're not
6128 * interested in: they'll be ignored by the function.
6130 * @see elm_fileselector_button_window_size_set(), for more details
6132 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6135 * Set the initial file system path for a given file selector
6138 * @param obj The file selector button widget
6139 * @param path The path string
6141 * It must be a <b>directory</b> path, which will have the contents
6142 * displayed initially in the file selector's view, when invoked
6143 * from @p obj. The default initial path is the @c "HOME"
6144 * environment variable's value.
6146 * @see elm_fileselector_button_path_get()
6148 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6151 * Get the initial file system path set for a given file selector
6154 * @param obj The file selector button widget
6155 * @return path The path string
6157 * @see elm_fileselector_button_path_set() for more details
6159 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6162 * Enable/disable a tree view in the given file selector button
6163 * widget's internal file selector
6165 * @param obj The file selector button widget
6166 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6169 * This has the same effect as elm_fileselector_expandable_set(),
6170 * but now applied to a file selector button's internal file
6173 * @note There's no way to put a file selector button's internal
6174 * file selector in "grid mode", as one may do with "pure" file
6177 * @see elm_fileselector_expandable_get()
6179 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6182 * Get whether tree view is enabled for the given file selector
6183 * button widget's internal file selector
6185 * @param obj The file selector button widget
6186 * @return @c EINA_TRUE if @p obj widget's internal file selector
6187 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6189 * @see elm_fileselector_expandable_set() for more details
6191 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6194 * Set whether a given file selector button widget's internal file
6195 * selector is to display folders only or the directory contents,
6198 * @param obj The file selector button widget
6199 * @param only @c EINA_TRUE to make @p obj widget's internal file
6200 * selector only display directories, @c EINA_FALSE to make files
6201 * to be displayed in it too
6203 * This has the same effect as elm_fileselector_folder_only_set(),
6204 * but now applied to a file selector button's internal file
6207 * @see elm_fileselector_folder_only_get()
6209 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6212 * Get whether a given file selector button widget's internal file
6213 * selector is displaying folders only or the directory contents,
6216 * @param obj The file selector button widget
6217 * @return @c EINA_TRUE if @p obj widget's internal file
6218 * selector is only displaying directories, @c EINA_FALSE if files
6219 * are being displayed in it too (and on errors)
6221 * @see elm_fileselector_button_folder_only_set() for more details
6223 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6226 * Enable/disable the file name entry box where the user can type
6227 * in a name for a file, in a given file selector button widget's
6228 * internal file selector.
6230 * @param obj The file selector button widget
6231 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6232 * file selector a "saving dialog", @c EINA_FALSE otherwise
6234 * This has the same effect as elm_fileselector_is_save_set(),
6235 * but now applied to a file selector button's internal file
6238 * @see elm_fileselector_is_save_get()
6240 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6243 * Get whether the given file selector button widget's internal
6244 * file selector is in "saving dialog" mode
6246 * @param obj The file selector button widget
6247 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6248 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6251 * @see elm_fileselector_button_is_save_set() for more details
6253 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 * Set whether a given file selector button widget's internal file
6257 * selector will raise an Elementary "inner window", instead of a
6258 * dedicated Elementary window. By default, it won't.
6260 * @param obj The file selector button widget
6261 * @param value @c EINA_TRUE to make it use an inner window, @c
6262 * EINA_TRUE to make it use a dedicated window
6264 * @see elm_win_inwin_add() for more information on inner windows
6265 * @see elm_fileselector_button_inwin_mode_get()
6267 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6270 * Get whether a given file selector button widget's internal file
6271 * selector will raise an Elementary "inner window", instead of a
6272 * dedicated Elementary window.
6274 * @param obj The file selector button widget
6275 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6276 * if it will use a dedicated window
6278 * @see elm_fileselector_button_inwin_mode_set() for more details
6280 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6287 * @defgroup File_Selector_Entry File Selector Entry
6289 * @image html img/widget/fileselector_entry/preview-00.png
6290 * @image latex img/widget/fileselector_entry/preview-00.eps
6292 * This is an entry made to be filled with or display a <b>file
6293 * system path string</b>. Besides the entry itself, the widget has
6294 * a @ref File_Selector_Button "file selector button" on its side,
6295 * which will raise an internal @ref Fileselector "file selector widget",
6296 * when clicked, for path selection aided by file system
6299 * This file selector may appear in an Elementary window or in an
6300 * inner window. When a file is chosen from it, the (inner) window
6301 * is closed and the selected file's path string is exposed both as
6302 * an smart event and as the new text on the entry.
6304 * This widget encapsulates operations on its internal file
6305 * selector on its own API. There is less control over its file
6306 * selector than that one would have instatiating one directly.
6308 * Smart callbacks one can register to:
6309 * - @c "changed" - The text within the entry was changed
6310 * - @c "activated" - The entry has had editing finished and
6311 * changes are to be "committed"
6312 * - @c "press" - The entry has been clicked
6313 * - @c "longpressed" - The entry has been clicked (and held) for a
6315 * - @c "clicked" - The entry has been clicked
6316 * - @c "clicked,double" - The entry has been double clicked
6317 * - @c "focused" - The entry has received focus
6318 * - @c "unfocused" - The entry has lost focus
6319 * - @c "selection,paste" - A paste action has occurred on the
6321 * - @c "selection,copy" - A copy action has occurred on the entry
6322 * - @c "selection,cut" - A cut action has occurred on the entry
6323 * - @c "unpressed" - The file selector entry's button was released
6324 * after being pressed.
6325 * - @c "file,chosen" - The user has selected a path via the file
6326 * selector entry's internal file selector, whose string pointer
6327 * comes as the @c event_info data (a stringshared string)
6329 * Here is an example on its usage:
6330 * @li @ref fileselector_entry_example
6332 * @see @ref File_Selector_Button for a similar widget.
6337 * Add a new file selector entry widget to the given parent
6338 * Elementary (container) object
6340 * @param parent The parent object
6341 * @return a new file selector entry widget handle or @c NULL, on
6344 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6347 * Set the label for a given file selector entry widget's button
6349 * @param obj The file selector entry widget
6350 * @param label The text label to be displayed on @p obj widget's
6353 * @deprecated use elm_object_text_set() instead.
6355 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6358 * Get the label set for a given file selector entry widget's button
6360 * @param obj The file selector entry widget
6361 * @return The widget button's label
6363 * @deprecated use elm_object_text_set() instead.
6365 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 * Set the icon on a given file selector entry widget's button
6370 * @param obj The file selector entry widget
6371 * @param icon The icon object for the entry's button
6373 * Once the icon object is set, a previously set one will be
6374 * deleted. If you want to keep the latter, use the
6375 * elm_fileselector_entry_button_icon_unset() function.
6377 * @see elm_fileselector_entry_button_icon_get()
6379 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6382 * Get the icon set for a given file selector entry widget's button
6384 * @param obj The file selector entry widget
6385 * @return The icon object currently set on @p obj widget's button
6386 * or @c NULL, if none is
6388 * @see elm_fileselector_entry_button_icon_set()
6390 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6393 * Unset the icon used in a given file selector entry widget's
6396 * @param obj The file selector entry widget
6397 * @return The icon object that was being used on @p obj widget's
6398 * button or @c NULL, on errors
6400 * Unparent and return the icon object which was set for this
6403 * @see elm_fileselector_entry_button_icon_set()
6405 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6408 * Set the title for a given file selector entry widget's window
6410 * @param obj The file selector entry widget
6411 * @param title The title string
6413 * This will change the window's title, when the file selector pops
6414 * out after a click on the entry's button. Those windows have the
6415 * default (unlocalized) value of @c "Select a file" as titles.
6417 * @note It will only take any effect if the file selector
6418 * entry widget is @b not under "inwin mode".
6420 * @see elm_fileselector_entry_window_title_get()
6422 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6425 * Get the title set for a given file selector entry widget's
6428 * @param obj The file selector entry widget
6429 * @return Title of the file selector entry's window
6431 * @see elm_fileselector_entry_window_title_get() for more details
6433 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6436 * Set the size of a given file selector entry widget's window,
6437 * holding the file selector itself.
6439 * @param obj The file selector entry widget
6440 * @param width The window's width
6441 * @param height The window's height
6443 * @note it will only take any effect if the file selector entry
6444 * widget is @b not under "inwin mode". The default size for the
6445 * window (when applicable) is 400x400 pixels.
6447 * @see elm_fileselector_entry_window_size_get()
6449 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6452 * Get the size of a given file selector entry widget's window,
6453 * holding the file selector itself.
6455 * @param obj The file selector entry widget
6456 * @param width Pointer into which to store the width value
6457 * @param height Pointer into which to store the height value
6459 * @note Use @c NULL pointers on the size values you're not
6460 * interested in: they'll be ignored by the function.
6462 * @see elm_fileselector_entry_window_size_set(), for more details
6464 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6467 * Set the initial file system path and the entry's path string for
6468 * a given file selector entry widget
6470 * @param obj The file selector entry widget
6471 * @param path The path string
6473 * It must be a <b>directory</b> path, which will have the contents
6474 * displayed initially in the file selector's view, when invoked
6475 * from @p obj. The default initial path is the @c "HOME"
6476 * environment variable's value.
6478 * @see elm_fileselector_entry_path_get()
6480 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6483 * Get the entry's path string for a given file selector entry
6486 * @param obj The file selector entry widget
6487 * @return path The path string
6489 * @see elm_fileselector_entry_path_set() for more details
6491 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6494 * Enable/disable a tree view in the given file selector entry
6495 * widget's internal file selector
6497 * @param obj The file selector entry widget
6498 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6501 * This has the same effect as elm_fileselector_expandable_set(),
6502 * but now applied to a file selector entry's internal file
6505 * @note There's no way to put a file selector entry's internal
6506 * file selector in "grid mode", as one may do with "pure" file
6509 * @see elm_fileselector_expandable_get()
6511 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6514 * Get whether tree view is enabled for the given file selector
6515 * entry widget's internal file selector
6517 * @param obj The file selector entry widget
6518 * @return @c EINA_TRUE if @p obj widget's internal file selector
6519 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6521 * @see elm_fileselector_expandable_set() for more details
6523 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6526 * Set whether a given file selector entry widget's internal file
6527 * selector is to display folders only or the directory contents,
6530 * @param obj The file selector entry widget
6531 * @param only @c EINA_TRUE to make @p obj widget's internal file
6532 * selector only display directories, @c EINA_FALSE to make files
6533 * to be displayed in it too
6535 * This has the same effect as elm_fileselector_folder_only_set(),
6536 * but now applied to a file selector entry's internal file
6539 * @see elm_fileselector_folder_only_get()
6541 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6544 * Get whether a given file selector entry widget's internal file
6545 * selector is displaying folders only or the directory contents,
6548 * @param obj The file selector entry widget
6549 * @return @c EINA_TRUE if @p obj widget's internal file
6550 * selector is only displaying directories, @c EINA_FALSE if files
6551 * are being displayed in it too (and on errors)
6553 * @see elm_fileselector_entry_folder_only_set() for more details
6555 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6558 * Enable/disable the file name entry box where the user can type
6559 * in a name for a file, in a given file selector entry widget's
6560 * internal file selector.
6562 * @param obj The file selector entry widget
6563 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6564 * file selector a "saving dialog", @c EINA_FALSE otherwise
6566 * This has the same effect as elm_fileselector_is_save_set(),
6567 * but now applied to a file selector entry's internal file
6570 * @see elm_fileselector_is_save_get()
6572 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6575 * Get whether the given file selector entry widget's internal
6576 * file selector is in "saving dialog" mode
6578 * @param obj The file selector entry widget
6579 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6580 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6583 * @see elm_fileselector_entry_is_save_set() for more details
6585 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6588 * Set whether a given file selector entry widget's internal file
6589 * selector will raise an Elementary "inner window", instead of a
6590 * dedicated Elementary window. By default, it won't.
6592 * @param obj The file selector entry widget
6593 * @param value @c EINA_TRUE to make it use an inner window, @c
6594 * EINA_TRUE to make it use a dedicated window
6596 * @see elm_win_inwin_add() for more information on inner windows
6597 * @see elm_fileselector_entry_inwin_mode_get()
6599 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6602 * Get whether a given file selector entry widget's internal file
6603 * selector will raise an Elementary "inner window", instead of a
6604 * dedicated Elementary window.
6606 * @param obj The file selector entry widget
6607 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6608 * if it will use a dedicated window
6610 * @see elm_fileselector_entry_inwin_mode_set() for more details
6612 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6615 * Set the initial file system path for a given file selector entry
6618 * @param obj The file selector entry widget
6619 * @param path The path string
6621 * It must be a <b>directory</b> path, which will have the contents
6622 * displayed initially in the file selector's view, when invoked
6623 * from @p obj. The default initial path is the @c "HOME"
6624 * environment variable's value.
6626 * @see elm_fileselector_entry_path_get()
6628 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6631 * Get the parent directory's path to the latest file selection on
6632 * a given filer selector entry widget
6634 * @param obj The file selector object
6635 * @return The (full) path of the directory of the last selection
6636 * on @p obj widget, a @b stringshared string
6638 * @see elm_fileselector_entry_path_set()
6640 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6647 * @defgroup Scroller Scroller
6649 * A scroller holds a single object and "scrolls it around". This means that
6650 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6651 * region around, allowing to move through a much larger object that is
6652 * contained in the scroller. The scroiller will always have a small minimum
6653 * size by default as it won't be limited by the contents of the scroller.
6655 * Signals that you can add callbacks for are:
6656 * @li "edge,left" - the left edge of the content has been reached
6657 * @li "edge,right" - the right edge of the content has been reached
6658 * @li "edge,top" - the top edge of the content has been reached
6659 * @li "edge,bottom" - the bottom edge of the content has been reached
6660 * @li "scroll" - the content has been scrolled (moved)
6661 * @li "scroll,anim,start" - scrolling animation has started
6662 * @li "scroll,anim,stop" - scrolling animation has stopped
6663 * @li "scroll,drag,start" - dragging the contents around has started
6664 * @li "scroll,drag,stop" - dragging the contents around has stopped
6665 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6668 * @note When Elemementary is in embedded mode the scrollbars will not be
6669 * dragable, they appear merely as indicators of how much has been scrolled.
6670 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6671 * fingerscroll) won't work.
6673 * In @ref tutorial_scroller you'll find an example of how to use most of
6678 * @brief Type that controls when scrollbars should appear.
6680 * @see elm_scroller_policy_set()
6682 typedef enum _Elm_Scroller_Policy
6684 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6685 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6686 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6687 ELM_SCROLLER_POLICY_LAST
6688 } Elm_Scroller_Policy;
6690 * @brief Add a new scroller to the parent
6692 * @param parent The parent object
6693 * @return The new object or NULL if it cannot be created
6695 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6697 * @brief Set the content of the scroller widget (the object to be scrolled around).
6699 * @param obj The scroller object
6700 * @param content The new content object
6702 * Once the content object is set, a previously set one will be deleted.
6703 * If you want to keep that old content object, use the
6704 * elm_scroller_content_unset() function.
6706 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6708 * @brief Get the content of the scroller widget
6710 * @param obj The slider object
6711 * @return The content that is being used
6713 * Return the content object which is set for this widget
6715 * @see elm_scroller_content_set()
6717 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6719 * @brief Unset the content of the scroller widget
6721 * @param obj The slider object
6722 * @return The content that was being used
6724 * Unparent and return the content object which was set for this widget
6726 * @see elm_scroller_content_set()
6728 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6730 * @brief Set custom theme elements for the scroller
6732 * @param obj The scroller object
6733 * @param widget The widget name to use (default is "scroller")
6734 * @param base The base name to use (default is "base")
6736 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6738 * @brief Make the scroller minimum size limited to the minimum size of the content
6740 * @param obj The scroller object
6741 * @param w Enable limiting minimum size horizontally
6742 * @param h Enable limiting minimum size vertically
6744 * By default the scroller will be as small as its design allows,
6745 * irrespective of its content. This will make the scroller minimum size the
6746 * right size horizontally and/or vertically to perfectly fit its content in
6749 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6751 * @brief Show a specific virtual region within the scroller content object
6753 * @param obj The scroller object
6754 * @param x X coordinate of the region
6755 * @param y Y coordinate of the region
6756 * @param w Width of the region
6757 * @param h Height of the region
6759 * This will ensure all (or part if it does not fit) of the designated
6760 * region in the virtual content object (0, 0 starting at the top-left of the
6761 * virtual content object) is shown within the scroller.
6763 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);
6765 * @brief Set the scrollbar visibility policy
6767 * @param obj The scroller object
6768 * @param policy_h Horizontal scrollbar policy
6769 * @param policy_v Vertical scrollbar policy
6771 * This sets the scrollbar visibility policy for the given scroller.
6772 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6773 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6774 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6775 * respectively for the horizontal and vertical scrollbars.
6777 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6779 * @brief Gets scrollbar visibility policy
6781 * @param obj The scroller object
6782 * @param policy_h Horizontal scrollbar policy
6783 * @param policy_v Vertical scrollbar policy
6785 * @see elm_scroller_policy_set()
6787 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6789 * @brief Get the currently visible content region
6791 * @param obj The scroller object
6792 * @param x X coordinate of the region
6793 * @param y Y coordinate of the region
6794 * @param w Width of the region
6795 * @param h Height of the region
6797 * This gets the current region in the content object that is visible through
6798 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6799 * w, @p h values pointed to.
6801 * @note All coordinates are relative to the content.
6803 * @see elm_scroller_region_show()
6805 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);
6807 * @brief Get the size of the content object
6809 * @param obj The scroller object
6810 * @param w Width return
6811 * @param h Height return
6813 * This gets the size of the content object of the scroller.
6815 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6817 * @brief Set bouncing behavior
6819 * @param obj The scroller object
6820 * @param h_bounce Will the scroller bounce horizontally or not
6821 * @param v_bounce Will the scroller bounce vertically or not
6823 * When scrolling, the scroller may "bounce" when reaching an edge of the
6824 * content object. This is a visual way to indicate the end has been reached.
6825 * This is enabled by default for both axis. This will set if it is enabled
6826 * for that axis with the boolean parameters for each axis.
6828 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6830 * @brief Get the bounce mode
6832 * @param obj The Scroller object
6833 * @param h_bounce Allow bounce horizontally
6834 * @param v_bounce Allow bounce vertically
6836 * @see elm_scroller_bounce_set()
6838 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6840 * @brief Set scroll page size relative to viewport size.
6842 * @param obj The scroller object
6843 * @param h_pagerel The horizontal page relative size
6844 * @param v_pagerel The vertical page relative size
6846 * The scroller is capable of limiting scrolling by the user to "pages". That
6847 * is to jump by and only show a "whole page" at a time as if the continuous
6848 * area of the scroller content is split into page sized pieces. This sets
6849 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6850 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6851 * axis. This is mutually exclusive with page size
6852 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6853 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6854 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6857 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6859 * @brief Set scroll page size.
6861 * @param obj The scroller object
6862 * @param h_pagesize The horizontal page size
6863 * @param v_pagesize The vertical page size
6865 * This sets the page size to an absolute fixed value, with 0 turning it off
6868 * @see elm_scroller_page_relative_set()
6870 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6872 * @brief Show a specific virtual region within the scroller content object.
6874 * @param obj The scroller object
6875 * @param x X coordinate of the region
6876 * @param y Y coordinate of the region
6877 * @param w Width of the region
6878 * @param h Height of the region
6880 * This will ensure all (or part if it does not fit) of the designated
6881 * region in the virtual content object (0, 0 starting at the top-left of the
6882 * virtual content object) is shown within the scroller. Unlike
6883 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6884 * to this location (if configuration in general calls for transitions). It
6885 * may not jump immediately to the new location and make take a while and
6886 * show other content along the way.
6888 * @see elm_scroller_region_show()
6890 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);
6892 * @brief Set event propagation on a scroller
6894 * @param obj The scroller object
6895 * @param propagation If propagation is enabled or not
6897 * This enables or disabled event propagation from the scroller content to
6898 * the scroller and its parent. By default event propagation is disabled.
6900 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6902 * @brief Get event propagation for a scroller
6904 * @param obj The scroller object
6905 * @return The propagation state
6907 * This gets the event propagation for a scroller.
6909 * @see elm_scroller_propagate_events_set()
6911 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
6917 * @defgroup Label Label
6919 * @image html img/widget/label/preview-00.png
6920 * @image latex img/widget/label/preview-00.eps
6922 * @brief Widget to display text, with simple html-like markup.
6924 * The Label widget @b doesn't allow text to overflow its boundaries, if the
6925 * text doesn't fit the geometry of the label it will be ellipsized or be
6926 * cut. Elementary provides several themes for this widget:
6927 * @li default - No animation
6928 * @li marker - Centers the text in the label and make it bold by default
6929 * @li slide_long - The entire text appears from the right of the screen and
6930 * slides until it disappears in the left of the screen(reappering on the
6932 * @li slide_short - The text appears in the left of the label and slides to
6933 * the right to show the overflow. When all of the text has been shown the
6934 * position is reset.
6935 * @li slide_bounce - The text appears in the left of the label and slides to
6936 * the right to show the overflow. When all of the text has been shown the
6937 * animation reverses, moving the text to the left.
6939 * Custom themes can of course invent new markup tags and style them any way
6942 * See @ref tutorial_label for a demonstration of how to use a label widget.
6946 * @brief Add a new label to the parent
6948 * @param parent The parent object
6949 * @return The new object or NULL if it cannot be created
6951 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6953 * @brief Set the label on the label object
6955 * @param obj The label object
6956 * @param label The label will be used on the label object
6957 * @deprecated See elm_object_text_set()
6959 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 */
6961 * @brief Get the label used on the label object
6963 * @param obj The label object
6964 * @return The string inside the label
6965 * @deprecated See elm_object_text_get()
6967 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
6969 * @brief Set the wrapping behavior of the label
6971 * @param obj The label object
6972 * @param wrap To wrap text or not
6974 * By default no wrapping is done. Possible values for @p wrap are:
6975 * @li ELM_WRAP_NONE - No wrapping
6976 * @li ELM_WRAP_CHAR - wrap between characters
6977 * @li ELM_WRAP_WORD - wrap between words
6978 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
6980 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6982 * @brief Get the wrapping behavior of the label
6984 * @param obj The label object
6987 * @see elm_label_line_wrap_set()
6989 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6991 * @brief Set wrap width of the label
6993 * @param obj The label object
6994 * @param w The wrap width in pixels at a minimum where words need to wrap
6996 * This function sets the maximum width size hint of the label.
6998 * @warning This is only relevant if the label is inside a container.
7000 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7002 * @brief Get wrap width of the label
7004 * @param obj The label object
7005 * @return The wrap width in pixels at a minimum where words need to wrap
7007 * @see elm_label_wrap_width_set()
7009 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7011 * @brief Set wrap height of the label
7013 * @param obj The label object
7014 * @param h The wrap height in pixels at a minimum where words need to wrap
7016 * This function sets the maximum height size hint of the label.
7018 * @warning This is only relevant if the label is inside a container.
7020 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7022 * @brief get wrap width of the label
7024 * @param obj The label object
7025 * @return The wrap height in pixels at a minimum where words need to wrap
7027 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7029 * @brief Set the font size on the label object.
7031 * @param obj The label object
7032 * @param size font size
7034 * @warning NEVER use this. It is for hyper-special cases only. use styles
7035 * instead. e.g. "big", "medium", "small" - or better name them by use:
7036 * "title", "footnote", "quote" etc.
7038 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7040 * @brief Set the text color on the label object
7042 * @param obj The label object
7043 * @param r Red property background color of The label object
7044 * @param g Green property background color of The label object
7045 * @param b Blue property background color of The label object
7046 * @param a Alpha property background color of The label object
7048 * @warning NEVER use this. It is for hyper-special cases only. use styles
7049 * instead. e.g. "big", "medium", "small" - or better name them by use:
7050 * "title", "footnote", "quote" etc.
7052 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);
7054 * @brief Set the text align on the label object
7056 * @param obj The label object
7057 * @param align align mode ("left", "center", "right")
7059 * @warning NEVER use this. It is for hyper-special cases only. use styles
7060 * instead. e.g. "big", "medium", "small" - or better name them by use:
7061 * "title", "footnote", "quote" etc.
7063 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7065 * @brief Set background color of the label
7067 * @param obj The label object
7068 * @param r Red property background color of The label object
7069 * @param g Green property background color of The label object
7070 * @param b Blue property background color of The label object
7071 * @param a Alpha property background alpha of The label object
7073 * @warning NEVER use this. It is for hyper-special cases only. use styles
7074 * instead. e.g. "big", "medium", "small" - or better name them by use:
7075 * "title", "footnote", "quote" etc.
7077 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);
7079 * @brief Set the ellipsis behavior of the label
7081 * @param obj The label object
7082 * @param ellipsis To ellipsis text or not
7084 * If set to true and the text doesn't fit in the label an ellipsis("...")
7085 * will be shown at the end of the widget.
7087 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7088 * choosen wrap method was ELM_WRAP_WORD.
7090 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7092 * @brief Set the text slide of the label
7094 * @param obj The label object
7095 * @param slide To start slide or stop
7097 * If set to true the text of the label will slide throught the length of
7100 * @warning This only work with the themes "slide_short", "slide_long" and
7103 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7105 * @brief Get the text slide mode of the label
7107 * @param obj The label object
7108 * @return slide slide mode value
7110 * @see elm_label_slide_set()
7112 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7114 * @brief Set the slide duration(speed) of the label
7116 * @param obj The label object
7117 * @return The duration in seconds in moving text from slide begin position
7118 * to slide end position
7120 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7122 * @brief Get the slide duration(speed) of the label
7124 * @param obj The label object
7125 * @return The duration time in moving text from slide begin position to slide end position
7127 * @see elm_label_slide_duration_set()
7129 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7135 * @defgroup Toggle Toggle
7137 * @image html img/widget/toggle/preview-00.png
7138 * @image latex img/widget/toggle/preview-00.eps
7140 * @brief A toggle is a slider which can be used to toggle between
7141 * two values. It has two states: on and off.
7143 * Signals that you can add callbacks for are:
7144 * @li "changed" - Whenever the toggle value has been changed. Is not called
7145 * until the toggle is released by the cursor (assuming it
7146 * has been triggered by the cursor in the first place).
7148 * @ref tutorial_toggle show how to use a toggle.
7152 * @brief Add a toggle to @p parent.
7154 * @param parent The parent object
7156 * @return The toggle object
7158 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7160 * @brief Sets the label to be displayed with the toggle.
7162 * @param obj The toggle object
7163 * @param label The label to be displayed
7165 * @deprecated use elm_object_text_set() instead.
7167 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7169 * @brief Gets the label of the toggle
7171 * @param obj toggle object
7172 * @return The label of the toggle
7174 * @deprecated use elm_object_text_get() instead.
7176 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7178 * @brief Set the icon used for the toggle
7180 * @param obj The toggle object
7181 * @param icon The icon object for the button
7183 * Once the icon object is set, a previously set one will be deleted
7184 * If you want to keep that old content object, use the
7185 * elm_toggle_icon_unset() function.
7187 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7189 * @brief Get the icon used for the toggle
7191 * @param obj The toggle object
7192 * @return The icon object that is being used
7194 * Return the icon object which is set for this widget.
7196 * @see elm_toggle_icon_set()
7198 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7200 * @brief Unset the icon used for the toggle
7202 * @param obj The toggle object
7203 * @return The icon object that was being used
7205 * Unparent and return the icon object which was set for this widget.
7207 * @see elm_toggle_icon_set()
7209 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7211 * @brief Sets the labels to be associated with the on and off states of the toggle.
7213 * @param obj The toggle object
7214 * @param onlabel The label displayed when the toggle is in the "on" state
7215 * @param offlabel The label displayed when the toggle is in the "off" state
7217 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7219 * @brief Gets the labels associated with the on and off states of the toggle.
7221 * @param obj The toggle object
7222 * @param onlabel A char** to place the onlabel of @p obj into
7223 * @param offlabel A char** to place the offlabel of @p obj into
7225 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7227 * @brief Sets the state of the toggle to @p state.
7229 * @param obj The toggle object
7230 * @param state The state of @p obj
7232 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7234 * @brief Gets the state of the toggle to @p state.
7236 * @param obj The toggle object
7237 * @return The state of @p obj
7239 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 * @brief Sets the state pointer of the toggle to @p statep.
7243 * @param obj The toggle object
7244 * @param statep The state pointer of @p obj
7246 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7252 * @defgroup Frame Frame
7254 * @image html img/widget/frame/preview-00.png
7255 * @image latex img/widget/frame/preview-00.eps
7257 * @brief Frame is a widget that holds some content and has a title.
7259 * The default look is a frame with a title, but Frame supports multple
7267 * @li outdent_bottom
7269 * Of all this styles only default shows the title. Frame emits no signals.
7271 * For a detailed example see the @ref tutorial_frame.
7276 * @brief Add a new frame to the parent
7278 * @param parent The parent object
7279 * @return The new object or NULL if it cannot be created
7281 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7283 * @brief Set the frame label
7285 * @param obj The frame object
7286 * @param label The label of this frame object
7288 * @deprecated use elm_object_text_set() instead.
7290 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7292 * @brief Get the frame label
7294 * @param obj The frame object
7296 * @return The label of this frame objet or NULL if unable to get frame
7298 * @deprecated use elm_object_text_get() instead.
7300 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7302 * @brief Set the content of the frame widget
7304 * Once the content object is set, a previously set one will be deleted.
7305 * If you want to keep that old content object, use the
7306 * elm_frame_content_unset() function.
7308 * @param obj The frame object
7309 * @param content The content will be filled in this frame object
7311 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7313 * @brief Get the content of the frame widget
7315 * Return the content object which is set for this widget
7317 * @param obj The frame object
7318 * @return The content that is being used
7320 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7322 * @brief Unset the content of the frame widget
7324 * Unparent and return the content object which was set for this widget
7326 * @param obj The frame object
7327 * @return The content that was being used
7329 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7335 * @defgroup Table Table
7337 * A container widget to arrange other widgets in a table where items can
7338 * also span multiple columns or rows - even overlap (and then be raised or
7339 * lowered accordingly to adjust stacking if they do overlap).
7341 * The followin are examples of how to use a table:
7342 * @li @ref tutorial_table_01
7343 * @li @ref tutorial_table_02
7348 * @brief Add a new table to the parent
7350 * @param parent The parent object
7351 * @return The new object or NULL if it cannot be created
7353 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7355 * @brief Set the homogeneous layout in the table
7357 * @param obj The layout object
7358 * @param homogeneous A boolean to set if the layout is homogeneous in the
7359 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7361 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7363 * @brief Get the current table homogeneous mode.
7365 * @param obj The table object
7366 * @return A boolean to indicating if the layout is homogeneous in the table
7367 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7369 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7371 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7373 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7375 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7377 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7379 * @brief Set padding between cells.
7381 * @param obj The layout object.
7382 * @param horizontal set the horizontal padding.
7383 * @param vertical set the vertical padding.
7385 * Default value is 0.
7387 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7389 * @brief Get padding between cells.
7391 * @param obj The layout object.
7392 * @param horizontal set the horizontal padding.
7393 * @param vertical set the vertical padding.
7395 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7397 * @brief Add a subobject on the table with the coordinates passed
7399 * @param obj The table object
7400 * @param subobj The subobject to be added to the table
7401 * @param x Row number
7402 * @param y Column number
7406 * @note All positioning inside the table is relative to rows and columns, so
7407 * a value of 0 for x and y, means the top left cell of the table, and a
7408 * value of 1 for w and h means @p subobj only takes that 1 cell.
7410 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7412 * @brief Remove child from table.
7414 * @param obj The table object
7415 * @param subobj The subobject
7417 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7419 * @brief Faster way to remove all child objects from a table object.
7421 * @param obj The table object
7422 * @param clear If true, will delete children, else just remove from table.
7424 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7426 * @brief Set the packing location of an existing child of the table
7428 * @param subobj The subobject to be modified in the table
7429 * @param x Row number
7430 * @param y Column number
7434 * Modifies the position of an object already in the table.
7436 * @note All positioning inside the table is relative to rows and columns, so
7437 * a value of 0 for x and y, means the top left cell of the table, and a
7438 * value of 1 for w and h means @p subobj only takes that 1 cell.
7440 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7442 * @brief Get the packing location of an existing child of the table
7444 * @param subobj The subobject to be modified in the table
7445 * @param x Row number
7446 * @param y Column number
7450 * @see elm_table_pack_set()
7452 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7458 * @defgroup Gengrid Gengrid (Generic grid)
7460 * This widget aims to position objects in a grid layout while
7461 * actually creating and rendering only the visible ones, using the
7462 * same idea as the @ref Genlist "genlist": the user defines a @b
7463 * class for each item, specifying functions that will be called at
7464 * object creation, deletion, etc. When those items are selected by
7465 * the user, a callback function is issued. Users may interact with
7466 * a gengrid via the mouse (by clicking on items to select them and
7467 * clicking on the grid's viewport and swiping to pan the whole
7468 * view) or via the keyboard, navigating through item with the
7471 * @section Gengrid_Layouts Gengrid layouts
7473 * Gengrids may layout its items in one of two possible layouts:
7477 * When in "horizontal mode", items will be placed in @b columns,
7478 * from top to bottom and, when the space for a column is filled,
7479 * another one is started on the right, thus expanding the grid
7480 * horizontally, making for horizontal scrolling. When in "vertical
7481 * mode" , though, items will be placed in @b rows, from left to
7482 * right and, when the space for a row is filled, another one is
7483 * started below, thus expanding the grid vertically (and making
7484 * for vertical scrolling).
7486 * @section Gengrid_Items Gengrid items
7488 * An item in a gengrid can have 0 or more text labels (they can be
7489 * regular text or textblock Evas objects - that's up to the style
7490 * to determine), 0 or more icons (which are simply objects
7491 * swallowed into the gengrid item's theming Edje object) and 0 or
7492 * more <b>boolean states</b>, which have the behavior left to the
7493 * user to define. The Edje part names for each of these properties
7494 * will be looked up, in the theme file for the gengrid, under the
7495 * Edje (string) data items named @c "labels", @c "icons" and @c
7496 * "states", respectively. For each of those properties, if more
7497 * than one part is provided, they must have names listed separated
7498 * by spaces in the data fields. For the default gengrid item
7499 * theme, we have @b one label part (@c "elm.text"), @b two icon
7500 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7503 * A gengrid item may be at one of several styles. Elementary
7504 * provides one by default - "default", but this can be extended by
7505 * system or application custom themes/overlays/extensions (see
7506 * @ref Theme "themes" for more details).
7508 * @section Gengrid_Item_Class Gengrid item classes
7510 * In order to have the ability to add and delete items on the fly,
7511 * gengrid implements a class (callback) system where the
7512 * application provides a structure with information about that
7513 * type of item (gengrid may contain multiple different items with
7514 * different classes, states and styles). Gengrid will call the
7515 * functions in this struct (methods) when an item is "realized"
7516 * (i.e., created dynamically, while the user is scrolling the
7517 * grid). All objects will simply be deleted when no longer needed
7518 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7519 * contains the following members:
7520 * - @c item_style - This is a constant string and simply defines
7521 * the name of the item style. It @b must be specified and the
7522 * default should be @c "default".
7523 * - @c func.label_get - This function is called when an item
7524 * object is actually created. The @c data parameter will point to
7525 * the same data passed to elm_gengrid_item_append() and related
7526 * item creation functions. The @c obj parameter is the gengrid
7527 * object itself, while the @c part one is the name string of one
7528 * of the existing text parts in the Edje group implementing the
7529 * item's theme. This function @b must return a strdup'()ed string,
7530 * as the caller will free() it when done. See
7531 * #Elm_Gengrid_Item_Label_Get_Cb.
7532 * - @c func.icon_get - This function is called when an item object
7533 * is actually created. The @c data parameter will point to the
7534 * same data passed to elm_gengrid_item_append() and related item
7535 * creation functions. The @c obj parameter is the gengrid object
7536 * itself, while the @c part one is the name string of one of the
7537 * existing (icon) swallow parts in the Edje group implementing the
7538 * item's theme. It must return @c NULL, when no icon is desired,
7539 * or a valid object handle, otherwise. The object will be deleted
7540 * by the gengrid on its deletion or when the item is "unrealized".
7541 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7542 * - @c func.state_get - This function is called when an item
7543 * object is actually created. The @c data parameter will point to
7544 * the same data passed to elm_gengrid_item_append() and related
7545 * item creation functions. The @c obj parameter is the gengrid
7546 * object itself, while the @c part one is the name string of one
7547 * of the state parts in the Edje group implementing the item's
7548 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7549 * true/on. Gengrids will emit a signal to its theming Edje object
7550 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7551 * "source" arguments, respectively, when the state is true (the
7552 * default is false), where @c XXX is the name of the (state) part.
7553 * See #Elm_Gengrid_Item_State_Get_Cb.
7554 * - @c func.del - This is called when elm_gengrid_item_del() is
7555 * called on an item or elm_gengrid_clear() is called on the
7556 * gengrid. This is intended for use when gengrid items are
7557 * deleted, so any data attached to the item (e.g. its data
7558 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7560 * @section Gengrid_Usage_Hints Usage hints
7562 * If the user wants to have multiple items selected at the same
7563 * time, elm_gengrid_multi_select_set() will permit it. If the
7564 * gengrid is single-selection only (the default), then
7565 * elm_gengrid_select_item_get() will return the selected item or
7566 * @c NULL, if none is selected. If the gengrid is under
7567 * multi-selection, then elm_gengrid_selected_items_get() will
7568 * return a list (that is only valid as long as no items are
7569 * modified (added, deleted, selected or unselected) of child items
7572 * If an item changes (internal (boolean) state, label or icon
7573 * changes), then use elm_gengrid_item_update() to have gengrid
7574 * update the item with the new state. A gengrid will re-"realize"
7575 * the item, thus calling the functions in the
7576 * #Elm_Gengrid_Item_Class set for that item.
7578 * To programmatically (un)select an item, use
7579 * elm_gengrid_item_selected_set(). To get its selected state use
7580 * elm_gengrid_item_selected_get(). To make an item disabled
7581 * (unable to be selected and appear differently) use
7582 * elm_gengrid_item_disabled_set() to set this and
7583 * elm_gengrid_item_disabled_get() to get the disabled state.
7585 * Grid cells will only have their selection smart callbacks called
7586 * when firstly getting selected. Any further clicks will do
7587 * nothing, unless you enable the "always select mode", with
7588 * elm_gengrid_always_select_mode_set(), thus making every click to
7589 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7590 * turn off the ability to select items entirely in the widget and
7591 * they will neither appear selected nor call the selection smart
7594 * Remember that you can create new styles and add your own theme
7595 * augmentation per application with elm_theme_extension_add(). If
7596 * you absolutely must have a specific style that overrides any
7597 * theme the user or system sets up you can use
7598 * elm_theme_overlay_add() to add such a file.
7600 * @section Gengrid_Smart_Events Gengrid smart events
7602 * Smart events that you can add callbacks for are:
7603 * - @c "activated" - The user has double-clicked or pressed
7604 * (enter|return|spacebar) on an item. The @c event_info parameter
7605 * is the gengrid item that was activated.
7606 * - @c "clicked,double" - The user has double-clicked an item.
7607 * The @c event_info parameter is the gengrid item that was double-clicked.
7608 * - @c "selected" - The user has made an item selected. The
7609 * @c event_info parameter is the gengrid item that was selected.
7610 * - @c "unselected" - The user has made an item unselected. The
7611 * @c event_info parameter is the gengrid item that was unselected.
7612 * - @c "realized" - This is called when the item in the gengrid
7613 * has its implementing Evas object instantiated, de facto. @c
7614 * event_info is the gengrid item that was created. The object
7615 * may be deleted at any time, so it is highly advised to the
7616 * caller @b not to use the object pointer returned from
7617 * elm_gengrid_item_object_get(), because it may point to freed
7619 * - @c "unrealized" - This is called when the implementing Evas
7620 * object for this item is deleted. @c event_info is the gengrid
7621 * item that was deleted.
7622 * - @c "changed" - Called when an item is added, removed, resized
7623 * or moved and when the gengrid is resized or gets "horizontal"
7625 * - @c "drag,start,up" - Called when the item in the gengrid has
7626 * been dragged (not scrolled) up.
7627 * - @c "drag,start,down" - Called when the item in the gengrid has
7628 * been dragged (not scrolled) down.
7629 * - @c "drag,start,left" - Called when the item in the gengrid has
7630 * been dragged (not scrolled) left.
7631 * - @c "drag,start,right" - Called when the item in the gengrid has
7632 * been dragged (not scrolled) right.
7633 * - @c "drag,stop" - Called when the item in the gengrid has
7634 * stopped being dragged.
7635 * - @c "drag" - Called when the item in the gengrid is being
7637 * - @c "scroll" - called when the content has been scrolled
7639 * - @c "scroll,drag,start" - called when dragging the content has
7641 * - @c "scroll,drag,stop" - called when dragging the content has
7644 * List of gendrid examples:
7645 * @li @ref gengrid_example
7649 * @addtogroup Gengrid
7653 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7654 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7655 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7656 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7657 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. */
7658 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. */
7659 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7661 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7662 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7663 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7664 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7667 * @struct _Elm_Gengrid_Item_Class
7669 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7672 struct _Elm_Gengrid_Item_Class
7674 const char *item_style;
7675 struct _Elm_Gengrid_Item_Class_Func
7677 Elm_Gengrid_Item_Label_Get_Cb label_get;
7678 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7679 Elm_Gengrid_Item_State_Get_Cb state_get;
7680 Elm_Gengrid_Item_Del_Cb del;
7682 }; /**< #Elm_Gengrid_Item_Class member definitions */
7685 * Add a new gengrid widget to the given parent Elementary
7686 * (container) object
7688 * @param parent The parent object
7689 * @return a new gengrid widget handle or @c NULL, on errors
7691 * This function inserts a new gengrid widget on the canvas.
7693 * @see elm_gengrid_item_size_set()
7694 * @see elm_gengrid_horizontal_set()
7695 * @see elm_gengrid_item_append()
7696 * @see elm_gengrid_item_del()
7697 * @see elm_gengrid_clear()
7701 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7704 * Set the size for the items of a given gengrid widget
7706 * @param obj The gengrid object.
7707 * @param w The items' width.
7708 * @param h The items' height;
7710 * A gengrid, after creation, has still no information on the size
7711 * to give to each of its cells. So, you most probably will end up
7712 * with squares one @ref Fingers "finger" wide, the default
7713 * size. Use this function to force a custom size for you items,
7714 * making them as big as you wish.
7716 * @see elm_gengrid_item_size_get()
7720 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7723 * Get the size set for the items of a given gengrid widget
7725 * @param obj The gengrid object.
7726 * @param w Pointer to a variable where to store the items' width.
7727 * @param h Pointer to a variable where to store the items' height.
7729 * @note Use @c NULL pointers on the size values you're not
7730 * interested in: they'll be ignored by the function.
7732 * @see elm_gengrid_item_size_get() for more details
7736 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7739 * Set the items grid's alignment within a given gengrid widget
7741 * @param obj The gengrid object.
7742 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7743 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7745 * This sets the alignment of the whole grid of items of a gengrid
7746 * within its given viewport. By default, those values are both
7747 * 0.5, meaning that the gengrid will have its items grid placed
7748 * exactly in the middle of its viewport.
7750 * @note If given alignment values are out of the cited ranges,
7751 * they'll be changed to the nearest boundary values on the valid
7754 * @see elm_gengrid_align_get()
7758 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7761 * Get the items grid's alignment values within a given gengrid
7764 * @param obj The gengrid object.
7765 * @param align_x Pointer to a variable where to store the
7766 * horizontal alignment.
7767 * @param align_y Pointer to a variable where to store the vertical
7770 * @note Use @c NULL pointers on the alignment values you're not
7771 * interested in: they'll be ignored by the function.
7773 * @see elm_gengrid_align_set() for more details
7777 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7780 * Set whether a given gengrid widget is or not able have items
7783 * @param obj The gengrid object
7784 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7785 * @c EINA_FALSE to turn it off
7787 * If a gengrid is set to allow reordering, a click held for more
7788 * than 0.5 over a given item will highlight it specially,
7789 * signalling the gengrid has entered the reordering state. From
7790 * that time on, the user will be able to, while still holding the
7791 * mouse button down, move the item freely in the gengrid's
7792 * viewport, replacing to said item to the locations it goes to.
7793 * The replacements will be animated and, whenever the user
7794 * releases the mouse button, the item being replaced gets a new
7795 * definitive place in the grid.
7797 * @see elm_gengrid_reorder_mode_get()
7801 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7804 * Get whether a given gengrid widget is or not able have items
7807 * @param obj The gengrid object
7808 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7811 * @see elm_gengrid_reorder_mode_set() for more details
7815 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7818 * Append a new item in a given gengrid widget.
7820 * @param obj The gengrid object.
7821 * @param gic The item class for the item.
7822 * @param data The item data.
7823 * @param func Convenience function called when the item is
7825 * @param func_data Data to be passed to @p func.
7826 * @return A handle to the item added or @c NULL, on errors.
7828 * This adds an item to the beginning of the gengrid.
7830 * @see elm_gengrid_item_prepend()
7831 * @see elm_gengrid_item_insert_before()
7832 * @see elm_gengrid_item_insert_after()
7833 * @see elm_gengrid_item_del()
7837 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);
7840 * Prepend a new item in a given gengrid widget.
7842 * @param obj The gengrid object.
7843 * @param gic The item class for the item.
7844 * @param data The item data.
7845 * @param func Convenience function called when the item is
7847 * @param func_data Data to be passed to @p func.
7848 * @return A handle to the item added or @c NULL, on errors.
7850 * This adds an item to the end of the gengrid.
7852 * @see elm_gengrid_item_append()
7853 * @see elm_gengrid_item_insert_before()
7854 * @see elm_gengrid_item_insert_after()
7855 * @see elm_gengrid_item_del()
7859 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);
7862 * Insert an item before another in a gengrid widget
7864 * @param obj The gengrid object.
7865 * @param gic The item class for the item.
7866 * @param data The item data.
7867 * @param relative The item to place this new one before.
7868 * @param func Convenience function called when the item is
7870 * @param func_data Data to be passed to @p func.
7871 * @return A handle to the item added or @c NULL, on errors.
7873 * This inserts an item before another in the gengrid.
7875 * @see elm_gengrid_item_append()
7876 * @see elm_gengrid_item_prepend()
7877 * @see elm_gengrid_item_insert_after()
7878 * @see elm_gengrid_item_del()
7882 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);
7885 * Insert an item after another in a gengrid widget
7887 * @param obj The gengrid object.
7888 * @param gic The item class for the item.
7889 * @param data The item data.
7890 * @param relative The item to place this new one after.
7891 * @param func Convenience function called when the item is
7893 * @param func_data Data to be passed to @p func.
7894 * @return A handle to the item added or @c NULL, on errors.
7896 * This inserts an item after another in the gengrid.
7898 * @see elm_gengrid_item_append()
7899 * @see elm_gengrid_item_prepend()
7900 * @see elm_gengrid_item_insert_after()
7901 * @see elm_gengrid_item_del()
7905 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);
7907 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);
7909 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);
7912 * Set whether items on a given gengrid widget are to get their
7913 * selection callbacks issued for @b every subsequent selection
7914 * click on them or just for the first click.
7916 * @param obj The gengrid object
7917 * @param always_select @c EINA_TRUE to make items "always
7918 * selected", @c EINA_FALSE, otherwise
7920 * By default, grid items will only call their selection callback
7921 * function when firstly getting selected, any subsequent further
7922 * clicks will do nothing. With this call, you make those
7923 * subsequent clicks also to issue the selection callbacks.
7925 * @note <b>Double clicks</b> will @b always be reported on items.
7927 * @see elm_gengrid_always_select_mode_get()
7931 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7934 * Get whether items on a given gengrid widget have their selection
7935 * callbacks issued for @b every subsequent selection click on them
7936 * or just for the first click.
7938 * @param obj The gengrid object.
7939 * @return @c EINA_TRUE if the gengrid items are "always selected",
7940 * @c EINA_FALSE, otherwise
7942 * @see elm_gengrid_always_select_mode_set() for more details
7946 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7949 * Set whether items on a given gengrid widget can be selected or not.
7951 * @param obj The gengrid object
7952 * @param no_select @c EINA_TRUE to make items selectable,
7953 * @c EINA_FALSE otherwise
7955 * This will make items in @p obj selectable or not. In the latter
7956 * case, any user interacion on the gendrid items will neither make
7957 * them appear selected nor them call their selection callback
7960 * @see elm_gengrid_no_select_mode_get()
7964 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7967 * Get whether items on a given gengrid widget can be selected or
7970 * @param obj The gengrid object
7971 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
7974 * @see elm_gengrid_no_select_mode_set() for more details
7978 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7981 * Enable or disable multi-selection in a given gengrid widget
7983 * @param obj The gengrid object.
7984 * @param multi @c EINA_TRUE, to enable multi-selection,
7985 * @c EINA_FALSE to disable it.
7987 * Multi-selection is the ability for one to have @b more than one
7988 * item selected, on a given gengrid, simultaneously. When it is
7989 * enabled, a sequence of clicks on different items will make them
7990 * all selected, progressively. A click on an already selected item
7991 * will unselect it. If interecting via the keyboard,
7992 * multi-selection is enabled while holding the "Shift" key.
7994 * @note By default, multi-selection is @b disabled on gengrids
7996 * @see elm_gengrid_multi_select_get()
8000 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8003 * Get whether multi-selection is enabled or disabled for a given
8006 * @param obj The gengrid object.
8007 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8008 * EINA_FALSE otherwise
8010 * @see elm_gengrid_multi_select_set() for more details
8014 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8017 * Enable or disable bouncing effect for a given gengrid widget
8019 * @param obj The gengrid object
8020 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8021 * @c EINA_FALSE to disable it
8022 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8023 * @c EINA_FALSE to disable it
8025 * The bouncing effect occurs whenever one reaches the gengrid's
8026 * edge's while panning it -- it will scroll past its limits a
8027 * little bit and return to the edge again, in a animated for,
8030 * @note By default, gengrids have bouncing enabled on both axis
8032 * @see elm_gengrid_bounce_get()
8036 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8039 * Get whether bouncing effects are enabled or disabled, for a
8040 * given gengrid widget, on each axis
8042 * @param obj The gengrid object
8043 * @param h_bounce Pointer to a variable where to store the
8044 * horizontal bouncing flag.
8045 * @param v_bounce Pointer to a variable where to store the
8046 * vertical bouncing flag.
8048 * @see elm_gengrid_bounce_set() for more details
8052 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8055 * Set a given gengrid widget's scrolling page size, relative to
8056 * its viewport size.
8058 * @param obj The gengrid object
8059 * @param h_pagerel The horizontal page (relative) size
8060 * @param v_pagerel The vertical page (relative) size
8062 * The gengrid's scroller is capable of binding scrolling by the
8063 * user to "pages". It means that, while scrolling and, specially
8064 * after releasing the mouse button, the grid will @b snap to the
8065 * nearest displaying page's area. When page sizes are set, the
8066 * grid's continuous content area is split into (equal) page sized
8069 * This function sets the size of a page <b>relatively to the
8070 * viewport dimensions</b> of the gengrid, for each axis. A value
8071 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8072 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8073 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8074 * 1.0. Values beyond those will make it behave behave
8075 * inconsistently. If you only want one axis to snap to pages, use
8076 * the value @c 0.0 for the other one.
8078 * There is a function setting page size values in @b absolute
8079 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8080 * is mutually exclusive to this one.
8082 * @see elm_gengrid_page_relative_get()
8086 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8089 * Get a given gengrid widget's scrolling page size, relative to
8090 * its viewport size.
8092 * @param obj The gengrid object
8093 * @param h_pagerel Pointer to a variable where to store the
8094 * horizontal page (relative) size
8095 * @param v_pagerel Pointer to a variable where to store the
8096 * vertical page (relative) size
8098 * @see elm_gengrid_page_relative_set() for more details
8102 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8105 * Set a given gengrid widget's scrolling page size
8107 * @param obj The gengrid object
8108 * @param h_pagerel The horizontal page size, in pixels
8109 * @param v_pagerel The vertical page size, in pixels
8111 * The gengrid's scroller is capable of binding scrolling by the
8112 * user to "pages". It means that, while scrolling and, specially
8113 * after releasing the mouse button, the grid will @b snap to the
8114 * nearest displaying page's area. When page sizes are set, the
8115 * grid's continuous content area is split into (equal) page sized
8118 * This function sets the size of a page of the gengrid, in pixels,
8119 * for each axis. Sane usable values are, between @c 0 and the
8120 * dimensions of @p obj, for each axis. Values beyond those will
8121 * make it behave behave inconsistently. If you only want one axis
8122 * to snap to pages, use the value @c 0 for the other one.
8124 * There is a function setting page size values in @b relative
8125 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8126 * use is mutually exclusive to this one.
8130 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8133 * Set for what direction a given gengrid widget will expand while
8134 * placing its items.
8136 * @param obj The gengrid object.
8137 * @param setting @c EINA_TRUE to make the gengrid expand
8138 * horizontally, @c EINA_FALSE to expand vertically.
8140 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8141 * in @b columns, from top to bottom and, when the space for a
8142 * column is filled, another one is started on the right, thus
8143 * expanding the grid horizontally. When in "vertical mode"
8144 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8145 * to right and, when the space for a row is filled, another one is
8146 * started below, thus expanding the grid vertically.
8148 * @see elm_gengrid_horizontal_get()
8152 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8155 * Get for what direction a given gengrid widget will expand while
8156 * placing its items.
8158 * @param obj The gengrid object.
8159 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8160 * @c EINA_FALSE if it's set to expand vertically.
8162 * @see elm_gengrid_horizontal_set() for more detais
8166 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8169 * Get the first item in a given gengrid widget
8171 * @param obj The gengrid object
8172 * @return The first item's handle or @c NULL, if there are no
8173 * items in @p obj (and on errors)
8175 * This returns the first item in the @p obj's internal list of
8178 * @see elm_gengrid_last_item_get()
8182 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8185 * Get the last item in a given gengrid widget
8187 * @param obj The gengrid object
8188 * @return The last item's handle or @c NULL, if there are no
8189 * items in @p obj (and on errors)
8191 * This returns the last item in the @p obj's internal list of
8194 * @see elm_gengrid_first_item_get()
8198 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8201 * Get the @b next item in a gengrid widget's internal list of items,
8202 * given a handle to one of those items.
8204 * @param item The gengrid item to fetch next from
8205 * @return The item after @p item, or @c NULL if there's none (and
8208 * This returns the item placed after the @p item, on the container
8211 * @see elm_gengrid_item_prev_get()
8215 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8218 * Get the @b previous item in a gengrid widget's internal list of items,
8219 * given a handle to one of those items.
8221 * @param item The gengrid item to fetch previous from
8222 * @return The item before @p item, or @c NULL if there's none (and
8225 * This returns the item placed before the @p item, on the container
8228 * @see elm_gengrid_item_next_get()
8232 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8235 * Get the gengrid object's handle which contains a given gengrid
8238 * @param item The item to fetch the container from
8239 * @return The gengrid (parent) object
8241 * This returns the gengrid object itself that an item belongs to.
8245 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8248 * Remove a gengrid item from the its parent, deleting it.
8250 * @param item The item to be removed.
8251 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8253 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8258 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8261 * Update the contents of a given gengrid item
8263 * @param item The gengrid item
8265 * This updates an item by calling all the item class functions
8266 * again to get the icons, labels and states. Use this when the
8267 * original item data has changed and you want thta changes to be
8272 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8273 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8274 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8277 * Return the data associated to a given gengrid item
8279 * @param item The gengrid item.
8280 * @return the data associated to this item.
8282 * This returns the @c data value passed on the
8283 * elm_gengrid_item_append() and related item addition calls.
8285 * @see elm_gengrid_item_append()
8286 * @see elm_gengrid_item_data_set()
8290 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8293 * Set the data associated to a given gengrid item
8295 * @param item The gengrid item
8296 * @param data The new data pointer to set on it
8298 * This @b overrides the @c data value passed on the
8299 * elm_gengrid_item_append() and related item addition calls. This
8300 * function @b won't call elm_gengrid_item_update() automatically,
8301 * so you'd issue it afterwards if you want to hove the item
8302 * updated to reflect the that new data.
8304 * @see elm_gengrid_item_data_get()
8308 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8311 * Get a given gengrid item's position, relative to the whole
8312 * gengrid's grid area.
8314 * @param item The Gengrid item.
8315 * @param x Pointer to variable where to store the item's <b>row
8317 * @param y Pointer to variable where to store the item's <b>column
8320 * This returns the "logical" position of the item whithin the
8321 * gengrid. For example, @c (0, 1) would stand for first row,
8326 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8329 * Set whether a given gengrid item is selected or not
8331 * @param item The gengrid item
8332 * @param selected Use @c EINA_TRUE, to make it selected, @c
8333 * EINA_FALSE to make it unselected
8335 * This sets the selected state of an item. If multi selection is
8336 * not enabled on the containing gengrid and @p selected is @c
8337 * EINA_TRUE, any other previously selected items will get
8338 * unselected in favor of this new one.
8340 * @see elm_gengrid_item_selected_get()
8344 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8347 * Get whether a given gengrid item is selected or not
8349 * @param item The gengrid item
8350 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8352 * @see elm_gengrid_item_selected_set() for more details
8356 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8359 * Get the real Evas object created to implement the view of a
8360 * given gengrid item
8362 * @param item The gengrid item.
8363 * @return the Evas object implementing this item's view.
8365 * This returns the actual Evas object used to implement the
8366 * specified gengrid item's view. This may be @c NULL, as it may
8367 * not have been created or may have been deleted, at any time, by
8368 * the gengrid. <b>Do not modify this object</b> (move, resize,
8369 * show, hide, etc.), as the gengrid is controlling it. This
8370 * function is for querying, emitting custom signals or hooking
8371 * lower level callbacks for events on that object. Do not delete
8372 * this object under any circumstances.
8374 * @see elm_gengrid_item_data_get()
8378 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8381 * Show the portion of a gengrid's internal grid containing a given
8382 * item, @b immediately.
8384 * @param item The item to display
8386 * This causes gengrid to @b redraw its viewport's contents to the
8387 * region contining the given @p item item, if it is not fully
8390 * @see elm_gengrid_item_bring_in()
8394 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8397 * Animatedly bring in, to the visible are of a gengrid, a given
8400 * @param item The gengrid item to display
8402 * This causes gengrig to jump to the given @p item item and show
8403 * it (by scrolling), if it is not fully visible. This will use
8404 * animation to do so and take a period of time to complete.
8406 * @see elm_gengrid_item_show()
8410 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8413 * Set whether a given gengrid item is disabled or not.
8415 * @param item The gengrid item
8416 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8417 * to enable it back.
8419 * A disabled item cannot be selected or unselected. It will also
8420 * change its appearance, to signal the user it's disabled.
8422 * @see elm_gengrid_item_disabled_get()
8426 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8429 * Get whether a given gengrid item is disabled or not.
8431 * @param item The gengrid item
8432 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8435 * @see elm_gengrid_item_disabled_set() for more details
8439 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8442 * Set the text to be shown in a given gengrid item's tooltips.
8444 * @param item The gengrid item
8445 * @param text The text to set in the content
8447 * This call will setup the text to be used as tooltip to that item
8448 * (analogous to elm_object_tooltip_text_set(), but being item
8449 * tooltips with higher precedence than object tooltips). It can
8450 * have only one tooltip at a time, so any previous tooltip data
8455 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8458 * Set the content to be shown in a given gengrid item's tooltips
8460 * @param item The gengrid item.
8461 * @param func The function returning the tooltip contents.
8462 * @param data What to provide to @a func as callback data/context.
8463 * @param del_cb Called when data is not needed anymore, either when
8464 * another callback replaces @p func, the tooltip is unset with
8465 * elm_gengrid_item_tooltip_unset() or the owner @p item
8466 * dies. This callback receives as its first parameter the
8467 * given @p data, being @c event_info the item handle.
8469 * This call will setup the tooltip's contents to @p item
8470 * (analogous to elm_object_tooltip_content_cb_set(), but being
8471 * item tooltips with higher precedence than object tooltips). It
8472 * can have only one tooltip at a time, so any previous tooltip
8473 * content will get removed. @p func (with @p data) will be called
8474 * every time Elementary needs to show the tooltip and it should
8475 * return a valid Evas object, which will be fully managed by the
8476 * tooltip system, getting deleted when the tooltip is gone.
8480 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);
8483 * Unset a tooltip from a given gengrid item
8485 * @param item gengrid item to remove a previously set tooltip from.
8487 * This call removes any tooltip set on @p item. The callback
8488 * provided as @c del_cb to
8489 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8490 * notify it is not used anymore (and have resources cleaned, if
8493 * @see elm_gengrid_item_tooltip_content_cb_set()
8497 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8500 * Set a different @b style for a given gengrid item's tooltip.
8502 * @param item gengrid item with tooltip set
8503 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8504 * "default", @c "transparent", etc)
8506 * Tooltips can have <b>alternate styles</b> to be displayed on,
8507 * which are defined by the theme set on Elementary. This function
8508 * works analogously as elm_object_tooltip_style_set(), but here
8509 * applied only to gengrid item objects. The default style for
8510 * tooltips is @c "default".
8512 * @note before you set a style you should define a tooltip with
8513 * elm_gengrid_item_tooltip_content_cb_set() or
8514 * elm_gengrid_item_tooltip_text_set()
8516 * @see elm_gengrid_item_tooltip_style_get()
8520 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8523 * Get the style set a given gengrid item's tooltip.
8525 * @param item gengrid item with tooltip already set on.
8526 * @return style the theme style in use, which defaults to
8527 * "default". If the object does not have a tooltip set,
8528 * then @c NULL is returned.
8530 * @see elm_gengrid_item_tooltip_style_set() for more details
8534 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8536 * @brief Disable size restrictions on an object's tooltip
8537 * @param item The tooltip's anchor object
8538 * @param disable If EINA_TRUE, size restrictions are disabled
8539 * @return EINA_FALSE on failure, EINA_TRUE on success
8541 * This function allows a tooltip to expand beyond its parant window's canvas.
8542 * It will instead be limited only by the size of the display.
8544 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8546 * @brief Retrieve size restriction state of an object's tooltip
8547 * @param item The tooltip's anchor object
8548 * @return If EINA_TRUE, size restrictions are disabled
8550 * This function returns whether a tooltip is allowed to expand beyond
8551 * its parant window's canvas.
8552 * It will instead be limited only by the size of the display.
8554 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8556 * Set the type of mouse pointer/cursor decoration to be shown,
8557 * when the mouse pointer is over the given gengrid widget item
8559 * @param item gengrid item to customize cursor on
8560 * @param cursor the cursor type's name
8562 * This function works analogously as elm_object_cursor_set(), but
8563 * here the cursor's changing area is restricted to the item's
8564 * area, and not the whole widget's. Note that that item cursors
8565 * have precedence over widget cursors, so that a mouse over @p
8566 * item will always show cursor @p type.
8568 * If this function is called twice for an object, a previously set
8569 * cursor will be unset on the second call.
8571 * @see elm_object_cursor_set()
8572 * @see elm_gengrid_item_cursor_get()
8573 * @see elm_gengrid_item_cursor_unset()
8577 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8580 * Get the type of mouse pointer/cursor decoration set to be shown,
8581 * when the mouse pointer is over the given gengrid widget item
8583 * @param item gengrid item with custom cursor set
8584 * @return the cursor type's name or @c NULL, if no custom cursors
8585 * were set to @p item (and on errors)
8587 * @see elm_object_cursor_get()
8588 * @see elm_gengrid_item_cursor_set() for more details
8589 * @see elm_gengrid_item_cursor_unset()
8593 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8596 * Unset any custom mouse pointer/cursor decoration set to be
8597 * shown, when the mouse pointer is over the given gengrid widget
8598 * item, thus making it show the @b default cursor again.
8600 * @param item a gengrid item
8602 * Use this call to undo any custom settings on this item's cursor
8603 * decoration, bringing it back to defaults (no custom style set).
8605 * @see elm_object_cursor_unset()
8606 * @see elm_gengrid_item_cursor_set() for more details
8610 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8613 * Set a different @b style for a given custom cursor set for a
8616 * @param item gengrid item with custom cursor set
8617 * @param style the <b>theme style</b> to use (e.g. @c "default",
8618 * @c "transparent", etc)
8620 * This function only makes sense when one is using custom mouse
8621 * cursor decorations <b>defined in a theme file</b> , which can
8622 * have, given a cursor name/type, <b>alternate styles</b> on
8623 * it. It works analogously as elm_object_cursor_style_set(), but
8624 * here applied only to gengrid item objects.
8626 * @warning Before you set a cursor style you should have defined a
8627 * custom cursor previously on the item, with
8628 * elm_gengrid_item_cursor_set()
8630 * @see elm_gengrid_item_cursor_engine_only_set()
8631 * @see elm_gengrid_item_cursor_style_get()
8635 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8638 * Get the current @b style set for a given gengrid item's custom
8641 * @param item gengrid item with custom cursor set.
8642 * @return style the cursor style in use. If the object does not
8643 * have a cursor set, then @c NULL is returned.
8645 * @see elm_gengrid_item_cursor_style_set() for more details
8649 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8652 * Set if the (custom) cursor for a given gengrid item should be
8653 * searched in its theme, also, or should only rely on the
8656 * @param item item with custom (custom) cursor already set on
8657 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8658 * only on those provided by the rendering engine, @c EINA_FALSE to
8659 * have them searched on the widget's theme, as well.
8661 * @note This call is of use only if you've set a custom cursor
8662 * for gengrid items, with elm_gengrid_item_cursor_set().
8664 * @note By default, cursors will only be looked for between those
8665 * provided by the rendering engine.
8669 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8672 * Get if the (custom) cursor for a given gengrid item is being
8673 * searched in its theme, also, or is only relying on the rendering
8676 * @param item a gengrid item
8677 * @return @c EINA_TRUE, if cursors are being looked for only on
8678 * those provided by the rendering engine, @c EINA_FALSE if they
8679 * are being searched on the widget's theme, as well.
8681 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8685 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8688 * Remove all items from a given gengrid widget
8690 * @param obj The gengrid object.
8692 * This removes (and deletes) all items in @p obj, leaving it
8695 * @see elm_gengrid_item_del(), to remove just one item.
8699 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8702 * Get the selected item in a given gengrid widget
8704 * @param obj The gengrid object.
8705 * @return The selected item's handleor @c NULL, if none is
8706 * selected at the moment (and on errors)
8708 * This returns the selected item in @p obj. If multi selection is
8709 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8710 * the first item in the list is selected, which might not be very
8711 * useful. For that case, see elm_gengrid_selected_items_get().
8715 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8718 * Get <b>a list</b> of selected items in a given gengrid
8720 * @param obj The gengrid object.
8721 * @return The list of selected items or @c NULL, if none is
8722 * selected at the moment (and on errors)
8724 * This returns a list of the selected items, in the order that
8725 * they appear in the grid. This list is only valid as long as no
8726 * more items are selected or unselected (or unselected implictly
8727 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8730 * @see elm_gengrid_selected_item_get()
8734 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8741 * @defgroup Clock Clock
8743 * @image html img/widget/clock/preview-00.png
8744 * @image latex img/widget/clock/preview-00.eps
8746 * This is a @b digital clock widget. In its default theme, it has a
8747 * vintage "flipping numbers clock" appearance, which will animate
8748 * sheets of individual algarisms individually as time goes by.
8750 * A newly created clock will fetch system's time (already
8751 * considering local time adjustments) to start with, and will tick
8752 * accondingly. It may or may not show seconds.
8754 * Clocks have an @b edition mode. When in it, the sheets will
8755 * display extra arrow indications on the top and bottom and the
8756 * user may click on them to raise or lower the time values. After
8757 * it's told to exit edition mode, it will keep ticking with that
8758 * new time set (it keeps the difference from local time).
8760 * Also, when under edition mode, user clicks on the cited arrows
8761 * which are @b held for some time will make the clock to flip the
8762 * sheet, thus editing the time, continuosly and automatically for
8763 * the user. The interval between sheet flips will keep growing in
8764 * time, so that it helps the user to reach a time which is distant
8767 * The time display is, by default, in military mode (24h), but an
8768 * am/pm indicator may be optionally shown, too, when it will
8771 * Smart callbacks one can register to:
8772 * - "changed" - the clock's user changed the time
8774 * Here is an example on its usage:
8775 * @li @ref clock_example
8784 * Identifiers for which clock digits should be editable, when a
8785 * clock widget is in edition mode. Values may be ORed together to
8786 * make a mask, naturally.
8788 * @see elm_clock_edit_set()
8789 * @see elm_clock_digit_edit_set()
8791 typedef enum _Elm_Clock_Digedit
8793 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8794 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8795 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8796 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8797 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8798 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8799 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8800 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8801 } Elm_Clock_Digedit;
8804 * Add a new clock widget to the given parent Elementary
8805 * (container) object
8807 * @param parent The parent object
8808 * @return a new clock widget handle or @c NULL, on errors
8810 * This function inserts a new clock widget on the canvas.
8814 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8817 * Set a clock widget's time, programmatically
8819 * @param obj The clock widget object
8820 * @param hrs The hours to set
8821 * @param min The minutes to set
8822 * @param sec The secondes to set
8824 * This function updates the time that is showed by the clock
8827 * Values @b must be set within the following ranges:
8828 * - 0 - 23, for hours
8829 * - 0 - 59, for minutes
8830 * - 0 - 59, for seconds,
8832 * even if the clock is not in "military" mode.
8834 * @warning The behavior for values set out of those ranges is @b
8839 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8842 * Get a clock widget's time values
8844 * @param obj The clock object
8845 * @param[out] hrs Pointer to the variable to get the hours value
8846 * @param[out] min Pointer to the variable to get the minutes value
8847 * @param[out] sec Pointer to the variable to get the seconds value
8849 * This function gets the time set for @p obj, returning
8850 * it on the variables passed as the arguments to function
8852 * @note Use @c NULL pointers on the time values you're not
8853 * interested in: they'll be ignored by the function.
8857 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8860 * Set whether a given clock widget is under <b>edition mode</b> or
8861 * under (default) displaying-only mode.
8863 * @param obj The clock object
8864 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8865 * put it back to "displaying only" mode
8867 * This function makes a clock's time to be editable or not <b>by
8868 * user interaction</b>. When in edition mode, clocks @b stop
8869 * ticking, until one brings them back to canonical mode. The
8870 * elm_clock_digit_edit_set() function will influence which digits
8871 * of the clock will be editable. By default, all of them will be
8872 * (#ELM_CLOCK_NONE).
8874 * @note am/pm sheets, if being shown, will @b always be editable
8875 * under edition mode.
8877 * @see elm_clock_edit_get()
8881 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8884 * Retrieve whether a given clock widget is under <b>edition
8885 * mode</b> or under (default) displaying-only mode.
8887 * @param obj The clock object
8888 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8891 * This function retrieves whether the clock's time can be edited
8892 * or not by user interaction.
8894 * @see elm_clock_edit_set() for more details
8898 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8901 * Set what digits of the given clock widget should be editable
8902 * when in edition mode.
8904 * @param obj The clock object
8905 * @param digedit Bit mask indicating the digits to be editable
8906 * (values in #Elm_Clock_Digedit).
8908 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8909 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8912 * @see elm_clock_digit_edit_get()
8916 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8919 * Retrieve what digits of the given clock widget should be
8920 * editable when in edition mode.
8922 * @param obj The clock object
8923 * @return Bit mask indicating the digits to be editable
8924 * (values in #Elm_Clock_Digedit).
8926 * @see elm_clock_digit_edit_set() for more details
8930 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8933 * Set if the given clock widget must show hours in military or
8936 * @param obj The clock object
8937 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8940 * This function sets if the clock must show hours in military or
8941 * am/pm mode. In some countries like Brazil the military mode
8942 * (00-24h-format) is used, in opposition to the USA, where the
8943 * am/pm mode is more commonly used.
8945 * @see elm_clock_show_am_pm_get()
8949 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8952 * Get if the given clock widget shows hours in military or am/pm
8955 * @param obj The clock object
8956 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8959 * This function gets if the clock shows hours in military or am/pm
8962 * @see elm_clock_show_am_pm_set() for more details
8966 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8969 * Set if the given clock widget must show time with seconds or not
8971 * @param obj The clock object
8972 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
8974 * This function sets if the given clock must show or not elapsed
8975 * seconds. By default, they are @b not shown.
8977 * @see elm_clock_show_seconds_get()
8981 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
8984 * Get whether the given clock widget is showing time with seconds
8987 * @param obj The clock object
8988 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
8990 * This function gets whether @p obj is showing or not the elapsed
8993 * @see elm_clock_show_seconds_set()
8997 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9000 * Set the interval on time updates for an user mouse button hold
9001 * on clock widgets' time edition.
9003 * @param obj The clock object
9004 * @param interval The (first) interval value in seconds
9006 * This interval value is @b decreased while the user holds the
9007 * mouse pointer either incrementing or decrementing a given the
9008 * clock digit's value.
9010 * This helps the user to get to a given time distant from the
9011 * current one easier/faster, as it will start to flip quicker and
9012 * quicker on mouse button holds.
9014 * The calculation for the next flip interval value, starting from
9015 * the one set with this call, is the previous interval divided by
9016 * 1.05, so it decreases a little bit.
9018 * The default starting interval value for automatic flips is
9021 * @see elm_clock_interval_get()
9025 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9028 * Get the interval on time updates for an user mouse button hold
9029 * on clock widgets' time edition.
9031 * @param obj The clock object
9032 * @return The (first) interval value, in seconds, set on it
9034 * @see elm_clock_interval_set() for more details
9038 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9045 * @defgroup Layout Layout
9047 * @image html img/widget/layout/preview-00.png
9048 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9050 * @image html img/layout-predefined.png
9051 * @image latex img/layout-predefined.eps width=\textwidth
9053 * This is a container widget that takes a standard Edje design file and
9054 * wraps it very thinly in a widget.
9056 * An Edje design (theme) file has a very wide range of possibilities to
9057 * describe the behavior of elements added to the Layout. Check out the Edje
9058 * documentation and the EDC reference to get more information about what can
9059 * be done with Edje.
9061 * Just like @ref List, @ref Box, and other container widgets, any
9062 * object added to the Layout will become its child, meaning that it will be
9063 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9065 * The Layout widget can contain as many Contents, Boxes or Tables as
9066 * described in its theme file. For instance, objects can be added to
9067 * different Tables by specifying the respective Table part names. The same
9068 * is valid for Content and Box.
9070 * The objects added as child of the Layout will behave as described in the
9071 * part description where they were added. There are 3 possible types of
9072 * parts where a child can be added:
9074 * @section secContent Content (SWALLOW part)
9076 * Only one object can be added to the @c SWALLOW part (but you still can
9077 * have many @c SWALLOW parts and one object on each of them). Use the @c
9078 * elm_layout_content_* set of functions to set, retrieve and unset objects
9079 * as content of the @c SWALLOW. After being set to this part, the object
9080 * size, position, visibility, clipping and other description properties
9081 * will be totally controled by the description of the given part (inside
9082 * the Edje theme file).
9084 * One can use @c evas_object_size_hint_* functions on the child to have some
9085 * kind of control over its behavior, but the resulting behavior will still
9086 * depend heavily on the @c SWALLOW part description.
9088 * The Edje theme also can change the part description, based on signals or
9089 * scripts running inside the theme. This change can also be animated. All of
9090 * this will affect the child object set as content accordingly. The object
9091 * size will be changed if the part size is changed, it will animate move if
9092 * the part is moving, and so on.
9094 * The following picture demonstrates a Layout widget with a child object
9095 * added to its @c SWALLOW:
9097 * @image html layout_swallow.png
9098 * @image latex layout_swallow.eps width=\textwidth
9100 * @section secBox Box (BOX part)
9102 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9103 * allows one to add objects to the box and have them distributed along its
9104 * area, accordingly to the specified @a layout property (now by @a layout we
9105 * mean the chosen layouting design of the Box, not the Layout widget
9108 * A similar effect for having a box with its position, size and other things
9109 * controled by the Layout theme would be to create an Elementary @ref Box
9110 * widget and add it as a Content in the @c SWALLOW part.
9112 * The main difference of using the Layout Box is that its behavior, the box
9113 * properties like layouting format, padding, align, etc. will be all
9114 * controled by the theme. This means, for example, that a signal could be
9115 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9116 * handled the signal by changing the box padding, or align, or both. Using
9117 * the Elementary @ref Box widget is not necessarily harder or easier, it
9118 * just depends on the circunstances and requirements.
9120 * The Layout Box can be used through the @c elm_layout_box_* set of
9123 * The following picture demonstrates a Layout widget with many child objects
9124 * added to its @c BOX part:
9126 * @image html layout_box.png
9127 * @image latex layout_box.eps width=\textwidth
9129 * @section secTable Table (TABLE part)
9131 * Just like the @ref secBox, the Layout Table is very similar to the
9132 * Elementary @ref Table widget. It allows one to add objects to the Table
9133 * specifying the row and column where the object should be added, and any
9134 * column or row span if necessary.
9136 * Again, we could have this design by adding a @ref Table widget to the @c
9137 * SWALLOW part using elm_layout_content_set(). The same difference happens
9138 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9139 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9141 * The Layout Table can be used through the @c elm_layout_table_* set of
9144 * The following picture demonstrates a Layout widget with many child objects
9145 * added to its @c TABLE part:
9147 * @image html layout_table.png
9148 * @image latex layout_table.eps width=\textwidth
9150 * @section secPredef Predefined Layouts
9152 * Another interesting thing about the Layout widget is that it offers some
9153 * predefined themes that come with the default Elementary theme. These
9154 * themes can be set by the call elm_layout_theme_set(), and provide some
9155 * basic functionality depending on the theme used.
9157 * Most of them already send some signals, some already provide a toolbar or
9158 * back and next buttons.
9160 * These are available predefined theme layouts. All of them have class = @c
9161 * layout, group = @c application, and style = one of the following options:
9163 * @li @c toolbar-content - application with toolbar and main content area
9164 * @li @c toolbar-content-back - application with toolbar and main content
9165 * area with a back button and title area
9166 * @li @c toolbar-content-back-next - application with toolbar and main
9167 * content area with a back and next buttons and title area
9168 * @li @c content-back - application with a main content area with a back
9169 * button and title area
9170 * @li @c content-back-next - application with a main content area with a
9171 * back and next buttons and title area
9172 * @li @c toolbar-vbox - application with toolbar and main content area as a
9174 * @li @c toolbar-table - application with toolbar and main content area as a
9177 * @section secExamples Examples
9179 * Some examples of the Layout widget can be found here:
9180 * @li @ref layout_example_01
9181 * @li @ref layout_example_02
9182 * @li @ref layout_example_03
9183 * @li @ref layout_example_edc
9188 * Add a new layout to the parent
9190 * @param parent The parent object
9191 * @return The new object or NULL if it cannot be created
9193 * @see elm_layout_file_set()
9194 * @see elm_layout_theme_set()
9198 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9200 * Set the file that will be used as layout
9202 * @param obj The layout object
9203 * @param file The path to file (edj) that will be used as layout
9204 * @param group The group that the layout belongs in edje file
9206 * @return (1 = success, 0 = error)
9210 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9212 * Set the edje group from the elementary theme that will be used as layout
9214 * @param obj The layout object
9215 * @param clas the clas of the group
9216 * @param group the group
9217 * @param style the style to used
9219 * @return (1 = success, 0 = error)
9223 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9225 * Set the layout content.
9227 * @param obj The layout object
9228 * @param swallow The swallow part name in the edje file
9229 * @param content The child that will be added in this layout object
9231 * Once the content object is set, a previously set one will be deleted.
9232 * If you want to keep that old content object, use the
9233 * elm_layout_content_unset() function.
9235 * @note In an Edje theme, the part used as a content container is called @c
9236 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9237 * expected to be a part name just like the second parameter of
9238 * elm_layout_box_append().
9240 * @see elm_layout_box_append()
9241 * @see elm_layout_content_get()
9242 * @see elm_layout_content_unset()
9247 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9249 * Get the child object in the given content part.
9251 * @param obj The layout object
9252 * @param swallow The SWALLOW part to get its content
9254 * @return The swallowed object or NULL if none or an error occurred
9256 * @see elm_layout_content_set()
9260 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9262 * Unset the layout content.
9264 * @param obj The layout object
9265 * @param swallow The swallow part name in the edje file
9266 * @return The content that was being used
9268 * Unparent and return the content object which was set for this part.
9270 * @see elm_layout_content_set()
9274 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9276 * Set the text of the given part
9278 * @param obj The layout object
9279 * @param part The TEXT part where to set the text
9280 * @param text The text to set
9283 * @deprecated use elm_object_text_* instead.
9285 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9287 * Get the text set in the given part
9289 * @param obj The layout object
9290 * @param part The TEXT part to retrieve the text off
9292 * @return The text set in @p part
9295 * @deprecated use elm_object_text_* instead.
9297 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9299 * Append child to layout box part.
9301 * @param obj the layout object
9302 * @param part the box part to which the object will be appended.
9303 * @param child the child object to append to box.
9305 * Once the object is appended, it will become child of the layout. Its
9306 * lifetime will be bound to the layout, whenever the layout dies the child
9307 * will be deleted automatically. One should use elm_layout_box_remove() to
9308 * make this layout forget about the object.
9310 * @see elm_layout_box_prepend()
9311 * @see elm_layout_box_insert_before()
9312 * @see elm_layout_box_insert_at()
9313 * @see elm_layout_box_remove()
9317 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9319 * Prepend child to layout box part.
9321 * @param obj the layout object
9322 * @param part the box part to prepend.
9323 * @param child the child object to prepend to box.
9325 * Once the object is prepended, it will become child of the layout. Its
9326 * lifetime will be bound to the layout, whenever the layout dies the child
9327 * will be deleted automatically. One should use elm_layout_box_remove() to
9328 * make this layout forget about the object.
9330 * @see elm_layout_box_append()
9331 * @see elm_layout_box_insert_before()
9332 * @see elm_layout_box_insert_at()
9333 * @see elm_layout_box_remove()
9337 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9339 * Insert child to layout box part before a reference object.
9341 * @param obj the layout object
9342 * @param part the box part to insert.
9343 * @param child the child object to insert into box.
9344 * @param reference another reference object to insert before in box.
9346 * Once the object is inserted, it will become child of the layout. Its
9347 * lifetime will be bound to the layout, whenever the layout dies the child
9348 * will be deleted automatically. One should use elm_layout_box_remove() to
9349 * make this layout forget about the object.
9351 * @see elm_layout_box_append()
9352 * @see elm_layout_box_prepend()
9353 * @see elm_layout_box_insert_before()
9354 * @see elm_layout_box_remove()
9358 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9360 * Insert child to layout box part at a given position.
9362 * @param obj the layout object
9363 * @param part the box part to insert.
9364 * @param child the child object to insert into box.
9365 * @param pos the numeric position >=0 to insert the child.
9367 * Once the object is inserted, it will become child of the layout. Its
9368 * lifetime will be bound to the layout, whenever the layout dies the child
9369 * will be deleted automatically. One should use elm_layout_box_remove() to
9370 * make this layout forget about the object.
9372 * @see elm_layout_box_append()
9373 * @see elm_layout_box_prepend()
9374 * @see elm_layout_box_insert_before()
9375 * @see elm_layout_box_remove()
9379 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9381 * Remove a child of the given part box.
9383 * @param obj The layout object
9384 * @param part The box part name to remove child.
9385 * @param child The object to remove from box.
9386 * @return The object that was being used, or NULL if not found.
9388 * The object will be removed from the box part and its lifetime will
9389 * not be handled by the layout anymore. This is equivalent to
9390 * elm_layout_content_unset() for box.
9392 * @see elm_layout_box_append()
9393 * @see elm_layout_box_remove_all()
9397 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9399 * Remove all child of the given part box.
9401 * @param obj The layout object
9402 * @param part The box part name to remove child.
9403 * @param clear If EINA_TRUE, then all objects will be deleted as
9404 * well, otherwise they will just be removed and will be
9405 * dangling on the canvas.
9407 * The objects will be removed from the box part and their lifetime will
9408 * not be handled by the layout anymore. This is equivalent to
9409 * elm_layout_box_remove() for all box children.
9411 * @see elm_layout_box_append()
9412 * @see elm_layout_box_remove()
9416 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9418 * Insert child to layout table part.
9420 * @param obj the layout object
9421 * @param part the box part to pack child.
9422 * @param child_obj the child object to pack into table.
9423 * @param col the column to which the child should be added. (>= 0)
9424 * @param row the row to which the child should be added. (>= 0)
9425 * @param colspan how many columns should be used to store this object. (>=
9427 * @param rowspan how many rows should be used to store this object. (>= 1)
9429 * Once the object is inserted, it will become child of the table. Its
9430 * lifetime will be bound to the layout, and whenever the layout dies the
9431 * child will be deleted automatically. One should use
9432 * elm_layout_table_remove() to make this layout forget about the object.
9434 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9435 * more space than a single cell. For instance, the following code:
9437 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9440 * Would result in an object being added like the following picture:
9442 * @image html layout_colspan.png
9443 * @image latex layout_colspan.eps width=\textwidth
9445 * @see elm_layout_table_unpack()
9446 * @see elm_layout_table_clear()
9450 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);
9452 * Unpack (remove) a child of the given part table.
9454 * @param obj The layout object
9455 * @param part The table part name to remove child.
9456 * @param child_obj The object to remove from table.
9457 * @return The object that was being used, or NULL if not found.
9459 * The object will be unpacked from the table part and its lifetime
9460 * will not be handled by the layout anymore. This is equivalent to
9461 * elm_layout_content_unset() for table.
9463 * @see elm_layout_table_pack()
9464 * @see elm_layout_table_clear()
9468 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9470 * Remove all child of the given part table.
9472 * @param obj The layout object
9473 * @param part The table part name to remove child.
9474 * @param clear If EINA_TRUE, then all objects will be deleted as
9475 * well, otherwise they will just be removed and will be
9476 * dangling on the canvas.
9478 * The objects will be removed from the table part and their lifetime will
9479 * not be handled by the layout anymore. This is equivalent to
9480 * elm_layout_table_unpack() for all table children.
9482 * @see elm_layout_table_pack()
9483 * @see elm_layout_table_unpack()
9487 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9489 * Get the edje layout
9491 * @param obj The layout object
9493 * @return A Evas_Object with the edje layout settings loaded
9494 * with function elm_layout_file_set
9496 * This returns the edje object. It is not expected to be used to then
9497 * swallow objects via edje_object_part_swallow() for example. Use
9498 * elm_layout_content_set() instead so child object handling and sizing is
9501 * @note This function should only be used if you really need to call some
9502 * low level Edje function on this edje object. All the common stuff (setting
9503 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9504 * with proper elementary functions.
9506 * @see elm_object_signal_callback_add()
9507 * @see elm_object_signal_emit()
9508 * @see elm_object_text_part_set()
9509 * @see elm_layout_content_set()
9510 * @see elm_layout_box_append()
9511 * @see elm_layout_table_pack()
9512 * @see elm_layout_data_get()
9516 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9518 * Get the edje data from the given layout
9520 * @param obj The layout object
9521 * @param key The data key
9523 * @return The edje data string
9525 * This function fetches data specified inside the edje theme of this layout.
9526 * This function return NULL if data is not found.
9528 * In EDC this comes from a data block within the group block that @p
9529 * obj was loaded from. E.g.
9536 * item: "key1" "value1";
9537 * item: "key2" "value2";
9545 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9549 * @param obj The layout object
9551 * Manually forces a sizing re-evaluation. This is useful when the minimum
9552 * size required by the edje theme of this layout has changed. The change on
9553 * the minimum size required by the edje theme is not immediately reported to
9554 * the elementary layout, so one needs to call this function in order to tell
9555 * the widget (layout) that it needs to reevaluate its own size.
9557 * The minimum size of the theme is calculated based on minimum size of
9558 * parts, the size of elements inside containers like box and table, etc. All
9559 * of this can change due to state changes, and that's when this function
9562 * Also note that a standard signal of "size,eval" "elm" emitted from the
9563 * edje object will cause this to happen too.
9567 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9570 * Sets a specific cursor for an edje part.
9572 * @param obj The layout object.
9573 * @param part_name a part from loaded edje group.
9574 * @param cursor cursor name to use, see Elementary_Cursor.h
9576 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9577 * part not exists or it has "mouse_events: 0".
9581 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9584 * Get the cursor to be shown when mouse is over an edje part
9586 * @param obj The layout object.
9587 * @param part_name a part from loaded edje group.
9588 * @return the cursor name.
9592 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9595 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9597 * @param obj The layout object.
9598 * @param part_name a part from loaded edje group, that had a cursor set
9599 * with elm_layout_part_cursor_set().
9603 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9606 * Sets a specific cursor style for an edje part.
9608 * @param obj The layout object.
9609 * @param part_name a part from loaded edje group.
9610 * @param style the theme style to use (default, transparent, ...)
9612 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9613 * part not exists or it did not had a cursor set.
9617 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9620 * Gets a specific cursor style for an edje part.
9622 * @param obj The layout object.
9623 * @param part_name a part from loaded edje group.
9625 * @return the theme style in use, defaults to "default". If the
9626 * object does not have a cursor set, then NULL is returned.
9630 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9633 * Sets if the cursor set should be searched on the theme or should use
9634 * the provided by the engine, only.
9636 * @note before you set if should look on theme you should define a
9637 * cursor with elm_layout_part_cursor_set(). By default it will only
9638 * look for cursors provided by the engine.
9640 * @param obj The layout object.
9641 * @param part_name a part from loaded edje group.
9642 * @param engine_only if cursors should be just provided by the engine
9643 * or should also search on widget's theme as well
9645 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9646 * part not exists or it did not had a cursor set.
9650 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);
9653 * Gets a specific cursor engine_only for an edje part.
9655 * @param obj The layout object.
9656 * @param part_name a part from loaded edje group.
9658 * @return whenever the cursor is just provided by engine or also from theme.
9662 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9665 * @def elm_layout_icon_set
9666 * Convienience macro to set the icon object in a layout that follows the
9667 * Elementary naming convention for its parts.
9671 #define elm_layout_icon_set(_ly, _obj) \
9674 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9675 if ((_obj)) sig = "elm,state,icon,visible"; \
9676 else sig = "elm,state,icon,hidden"; \
9677 elm_object_signal_emit((_ly), sig, "elm"); \
9681 * @def elm_layout_icon_get
9682 * Convienience macro to get the icon object from a layout that follows the
9683 * Elementary naming convention for its parts.
9687 #define elm_layout_icon_get(_ly) \
9688 elm_layout_content_get((_ly), "elm.swallow.icon")
9691 * @def elm_layout_end_set
9692 * Convienience macro to set the end object in a layout that follows the
9693 * Elementary naming convention for its parts.
9697 #define elm_layout_end_set(_ly, _obj) \
9700 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9701 if ((_obj)) sig = "elm,state,end,visible"; \
9702 else sig = "elm,state,end,hidden"; \
9703 elm_object_signal_emit((_ly), sig, "elm"); \
9707 * @def elm_layout_end_get
9708 * Convienience macro to get the end object in a layout that follows the
9709 * Elementary naming convention for its parts.
9713 #define elm_layout_end_get(_ly) \
9714 elm_layout_content_get((_ly), "elm.swallow.end")
9717 * @def elm_layout_label_set
9718 * Convienience macro to set the label in a layout that follows the
9719 * Elementary naming convention for its parts.
9722 * @deprecated use elm_object_text_* instead.
9724 #define elm_layout_label_set(_ly, _txt) \
9725 elm_layout_text_set((_ly), "elm.text", (_txt))
9728 * @def elm_layout_label_get
9729 * Convienience macro to get the label in a layout that follows the
9730 * Elementary naming convention for its parts.
9733 * @deprecated use elm_object_text_* instead.
9735 #define elm_layout_label_get(_ly) \
9736 elm_layout_text_get((_ly), "elm.text")
9738 /* smart callbacks called:
9739 * "theme,changed" - when elm theme is changed.
9743 * @defgroup Notify Notify
9745 * @image html img/widget/notify/preview-00.png
9746 * @image latex img/widget/notify/preview-00.eps
9748 * Display a container in a particular region of the parent(top, bottom,
9749 * etc. A timeout can be set to automatically hide the notify. This is so
9750 * that, after an evas_object_show() on a notify object, if a timeout was set
9751 * on it, it will @b automatically get hidden after that time.
9753 * Signals that you can add callbacks for are:
9754 * @li "timeout" - when timeout happens on notify and it's hidden
9755 * @li "block,clicked" - when a click outside of the notify happens
9757 * @ref tutorial_notify show usage of the API.
9762 * @brief Possible orient values for notify.
9764 * This values should be used in conjunction to elm_notify_orient_set() to
9765 * set the position in which the notify should appear(relative to its parent)
9766 * and in conjunction with elm_notify_orient_get() to know where the notify
9769 typedef enum _Elm_Notify_Orient
9771 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9772 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9773 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9774 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9775 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9776 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9777 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9778 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9779 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9780 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9781 } Elm_Notify_Orient;
9783 * @brief Add a new notify to the parent
9785 * @param parent The parent object
9786 * @return The new object or NULL if it cannot be created
9788 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9790 * @brief Set the content of the notify widget
9792 * @param obj The notify object
9793 * @param content The content will be filled in this notify object
9795 * Once the content object is set, a previously set one will be deleted. If
9796 * you want to keep that old content object, use the
9797 * elm_notify_content_unset() function.
9799 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9801 * @brief Unset the content of the notify widget
9803 * @param obj The notify object
9804 * @return The content that was being used
9806 * Unparent and return the content object which was set for this widget
9808 * @see elm_notify_content_set()
9810 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9812 * @brief Return the content of the notify widget
9814 * @param obj The notify object
9815 * @return The content that is being used
9817 * @see elm_notify_content_set()
9819 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9821 * @brief Set the notify parent
9823 * @param obj The notify object
9824 * @param content The new parent
9826 * Once the parent object is set, a previously set one will be disconnected
9829 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9831 * @brief Get the notify parent
9833 * @param obj The notify object
9834 * @return The parent
9836 * @see elm_notify_parent_set()
9838 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9840 * @brief Set the orientation
9842 * @param obj The notify object
9843 * @param orient The new orientation
9845 * Sets the position in which the notify will appear in its parent.
9847 * @see @ref Elm_Notify_Orient for possible values.
9849 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9851 * @brief Return the orientation
9852 * @param obj The notify object
9853 * @return The orientation of the notification
9855 * @see elm_notify_orient_set()
9856 * @see Elm_Notify_Orient
9858 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9860 * @brief Set the time interval after which the notify window is going to be
9863 * @param obj The notify object
9864 * @param time The timeout in seconds
9866 * This function sets a timeout and starts the timer controlling when the
9867 * notify is hidden. Since calling evas_object_show() on a notify restarts
9868 * the timer controlling when the notify is hidden, setting this before the
9869 * notify is shown will in effect mean starting the timer when the notify is
9872 * @note Set a value <= 0.0 to disable a running timer.
9874 * @note If the value > 0.0 and the notify is previously visible, the
9875 * timer will be started with this value, canceling any running timer.
9877 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9879 * @brief Return the timeout value (in seconds)
9880 * @param obj the notify object
9882 * @see elm_notify_timeout_set()
9884 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9886 * @brief Sets whether events should be passed to by a click outside
9889 * @param obj The notify object
9890 * @param repeats EINA_TRUE Events are repeats, else no
9892 * When true if the user clicks outside the window the events will be caught
9893 * by the others widgets, else the events are blocked.
9895 * @note The default value is EINA_TRUE.
9897 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9899 * @brief Return true if events are repeat below the notify object
9900 * @param obj the notify object
9902 * @see elm_notify_repeat_events_set()
9904 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9910 * @defgroup Hover Hover
9912 * @image html img/widget/hover/preview-00.png
9913 * @image latex img/widget/hover/preview-00.eps
9915 * A Hover object will hover over its @p parent object at the @p target
9916 * location. Anything in the background will be given a darker coloring to
9917 * indicate that the hover object is on top (at the default theme). When the
9918 * hover is clicked it is dismissed(hidden), if the contents of the hover are
9919 * clicked that @b doesn't cause the hover to be dismissed.
9921 * @note The hover object will take up the entire space of @p target
9924 * Elementary has the following styles for the hover widget:
9928 * @li hoversel_vertical
9930 * The following are the available position for content:
9942 * Signals that you can add callbacks for are:
9943 * @li "clicked" - the user clicked the empty space in the hover to dismiss
9944 * @li "smart,changed" - a content object placed under the "smart"
9945 * policy was replaced to a new slot direction.
9947 * See @ref tutorial_hover for more information.
9951 typedef enum _Elm_Hover_Axis
9953 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9954 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9955 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9956 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9959 * @brief Adds a hover object to @p parent
9961 * @param parent The parent object
9962 * @return The hover object or NULL if one could not be created
9964 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9966 * @brief Sets the target object for the hover.
9968 * @param obj The hover object
9969 * @param target The object to center the hover onto. The hover
9971 * This function will cause the hover to be centered on the target object.
9973 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
9975 * @brief Gets the target object for the hover.
9977 * @param obj The hover object
9978 * @param parent The object to locate the hover over.
9980 * @see elm_hover_target_set()
9982 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9984 * @brief Sets the parent object for the hover.
9986 * @param obj The hover object
9987 * @param parent The object to locate the hover over.
9989 * This function will cause the hover to take up the entire space that the
9990 * parent object fills.
9992 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9994 * @brief Gets the parent object for the hover.
9996 * @param obj The hover object
9997 * @return The parent object to locate the hover over.
9999 * @see elm_hover_parent_set()
10001 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10003 * @brief Sets the content of the hover object and the direction in which it
10006 * @param obj The hover object
10007 * @param swallow The direction that the object will be displayed
10008 * at. Accepted values are "left", "top-left", "top", "top-right",
10009 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10011 * @param content The content to place at @p swallow
10013 * Once the content object is set for a given direction, a previously
10014 * set one (on the same direction) will be deleted. If you want to
10015 * keep that old content object, use the elm_hover_content_unset()
10018 * All directions may have contents at the same time, except for
10019 * "smart". This is a special placement hint and its use case
10020 * independs of the calculations coming from
10021 * elm_hover_best_content_location_get(). Its use is for cases when
10022 * one desires only one hover content, but with a dinamic special
10023 * placement within the hover area. The content's geometry, whenever
10024 * it changes, will be used to decide on a best location not
10025 * extrapolating the hover's parent object view to show it in (still
10026 * being the hover's target determinant of its medium part -- move and
10027 * resize it to simulate finger sizes, for example). If one of the
10028 * directions other than "smart" are used, a previously content set
10029 * using it will be deleted, and vice-versa.
10031 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10033 * @brief Get the content of the hover object, in a given direction.
10035 * Return the content object which was set for this widget in the
10036 * @p swallow direction.
10038 * @param obj The hover object
10039 * @param swallow The direction that the object was display at.
10040 * @return The content that was being used
10042 * @see elm_hover_content_set()
10044 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10046 * @brief Unset the content of the hover object, in a given direction.
10048 * Unparent and return the content object set at @p swallow direction.
10050 * @param obj The hover object
10051 * @param swallow The direction that the object was display at.
10052 * @return The content that was being used.
10054 * @see elm_hover_content_set()
10056 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10058 * @brief Returns the best swallow location for content in the hover.
10060 * @param obj The hover object
10061 * @param pref_axis The preferred orientation axis for the hover object to use
10062 * @return The edje location to place content into the hover or @c
10065 * Best is defined here as the location at which there is the most available
10068 * @p pref_axis may be one of
10069 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10070 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10071 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10072 * - @c ELM_HOVER_AXIS_BOTH -- both
10074 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10075 * nescessarily be along the horizontal axis("left" or "right"). If
10076 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10077 * be along the vertical axis("top" or "bottom"). Chossing
10078 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10079 * returned position may be in either axis.
10081 * @see elm_hover_content_set()
10083 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10090 * @defgroup Entry Entry
10092 * @image html img/widget/entry/preview-00.png
10093 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10094 * @image html img/widget/entry/preview-01.png
10095 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10096 * @image html img/widget/entry/preview-02.png
10097 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10098 * @image html img/widget/entry/preview-03.png
10099 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10101 * An entry is a convenience widget which shows a box that the user can
10102 * enter text into. Entries by default don't scroll, so they grow to
10103 * accomodate the entire text, resizing the parent window as needed. This
10104 * can be changed with the elm_entry_scrollable_set() function.
10106 * They can also be single line or multi line (the default) and when set
10107 * to multi line mode they support text wrapping in any of the modes
10108 * indicated by #Elm_Wrap_Type.
10110 * Other features include password mode, filtering of inserted text with
10111 * elm_entry_text_filter_append() and related functions, inline "items" and
10112 * formatted markup text.
10114 * @section entry-markup Formatted text
10116 * The markup tags supported by the Entry are defined by the theme, but
10117 * even when writing new themes or extensions it's a good idea to stick to
10118 * a sane default, to maintain coherency and avoid application breakages.
10119 * Currently defined by the default theme are the following tags:
10120 * @li \<br\>: Inserts a line break.
10121 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10123 * @li \<tab\>: Inserts a tab.
10124 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10126 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10127 * @li \<link\>...\</link\>: Underlines the enclosed text.
10128 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10130 * @section entry-special Special markups
10132 * Besides those used to format text, entries support two special markup
10133 * tags used to insert clickable portions of text or items inlined within
10136 * @subsection entry-anchors Anchors
10138 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10139 * \</a\> tags and an event will be generated when this text is clicked,
10143 * This text is outside <a href=anc-01>but this one is an anchor</a>
10146 * The @c href attribute in the opening tag gives the name that will be
10147 * used to identify the anchor and it can be any valid utf8 string.
10149 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10150 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10151 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10152 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10155 * @subsection entry-items Items
10157 * Inlined in the text, any other @c Evas_Object can be inserted by using
10158 * \<item\> tags this way:
10161 * <item size=16x16 vsize=full href=emoticon/haha></item>
10164 * Just like with anchors, the @c href identifies each item, but these need,
10165 * in addition, to indicate their size, which is done using any one of
10166 * @c size, @c absize or @c relsize attributes. These attributes take their
10167 * value in the WxH format, where W is the width and H the height of the
10170 * @li absize: Absolute pixel size for the item. Whatever value is set will
10171 * be the item's size regardless of any scale value the object may have
10172 * been set to. The final line height will be adjusted to fit larger items.
10173 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10175 * @li relsize: Size is adjusted for the item to fit within the current
10178 * Besides their size, items are specificed a @c vsize value that affects
10179 * how their final size and position are calculated. The possible values
10181 * @li ascent: Item will be placed within the line's baseline and its
10182 * ascent. That is, the height between the line where all characters are
10183 * positioned and the highest point in the line. For @c size and @c absize
10184 * items, the descent value will be added to the total line height to make
10185 * them fit. @c relsize items will be adjusted to fit within this space.
10186 * @li full: Items will be placed between the descent and ascent, or the
10187 * lowest point in the line and its highest.
10189 * The next image shows different configurations of items and how they
10190 * are the previously mentioned options affect their sizes. In all cases,
10191 * the green line indicates the ascent, blue for the baseline and red for
10194 * @image html entry_item.png
10195 * @image latex entry_item.eps width=\textwidth
10197 * And another one to show how size differs from absize. In the first one,
10198 * the scale value is set to 1.0, while the second one is using one of 2.0.
10200 * @image html entry_item_scale.png
10201 * @image latex entry_item_scale.eps width=\textwidth
10203 * After the size for an item is calculated, the entry will request an
10204 * object to place in its space. For this, the functions set with
10205 * elm_entry_item_provider_append() and related functions will be called
10206 * in order until one of them returns a @c non-NULL value. If no providers
10207 * are available, or all of them return @c NULL, then the entry falls back
10208 * to one of the internal defaults, provided the name matches with one of
10211 * All of the following are currently supported:
10214 * - emoticon/angry-shout
10215 * - emoticon/crazy-laugh
10216 * - emoticon/evil-laugh
10218 * - emoticon/goggle-smile
10219 * - emoticon/grumpy
10220 * - emoticon/grumpy-smile
10221 * - emoticon/guilty
10222 * - emoticon/guilty-smile
10224 * - emoticon/half-smile
10225 * - emoticon/happy-panting
10227 * - emoticon/indifferent
10229 * - emoticon/knowing-grin
10231 * - emoticon/little-bit-sorry
10232 * - emoticon/love-lots
10234 * - emoticon/minimal-smile
10235 * - emoticon/not-happy
10236 * - emoticon/not-impressed
10238 * - emoticon/opensmile
10241 * - emoticon/squint-laugh
10242 * - emoticon/surprised
10243 * - emoticon/suspicious
10244 * - emoticon/tongue-dangling
10245 * - emoticon/tongue-poke
10247 * - emoticon/unhappy
10248 * - emoticon/very-sorry
10251 * - emoticon/worried
10254 * Alternatively, an item may reference an image by its path, using
10255 * the URI form @c file:///path/to/an/image.png and the entry will then
10256 * use that image for the item.
10258 * @section entry-files Loading and saving files
10260 * Entries have convinience functions to load text from a file and save
10261 * changes back to it after a short delay. The automatic saving is enabled
10262 * by default, but can be disabled with elm_entry_autosave_set() and files
10263 * can be loaded directly as plain text or have any markup in them
10264 * recognized. See elm_entry_file_set() for more details.
10266 * @section entry-signals Emitted signals
10268 * This widget emits the following signals:
10270 * @li "changed": The text within the entry was changed.
10271 * @li "changed,user": The text within the entry was changed because of user interaction.
10272 * @li "activated": The enter key was pressed on a single line entry.
10273 * @li "press": A mouse button has been pressed on the entry.
10274 * @li "longpressed": A mouse button has been pressed and held for a couple
10276 * @li "clicked": The entry has been clicked (mouse press and release).
10277 * @li "clicked,double": The entry has been double clicked.
10278 * @li "clicked,triple": The entry has been triple clicked.
10279 * @li "focused": The entry has received focus.
10280 * @li "unfocused": The entry has lost focus.
10281 * @li "selection,paste": A paste of the clipboard contents was requested.
10282 * @li "selection,copy": A copy of the selected text into the clipboard was
10284 * @li "selection,cut": A cut of the selected text into the clipboard was
10286 * @li "selection,start": A selection has begun and no previous selection
10288 * @li "selection,changed": The current selection has changed.
10289 * @li "selection,cleared": The current selection has been cleared.
10290 * @li "cursor,changed": The cursor has changed position.
10291 * @li "anchor,clicked": An anchor has been clicked. The event_info
10292 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10293 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10294 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10295 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10296 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10297 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10298 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10299 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10300 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10301 * @li "preedit,changed": The preedit string has changed.
10303 * @section entry-examples
10305 * An overview of the Entry API can be seen in @ref entry_example_01
10310 * @typedef Elm_Entry_Anchor_Info
10312 * The info sent in the callback for the "anchor,clicked" signals emitted
10315 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10317 * @struct _Elm_Entry_Anchor_Info
10319 * The info sent in the callback for the "anchor,clicked" signals emitted
10322 struct _Elm_Entry_Anchor_Info
10324 const char *name; /**< The name of the anchor, as stated in its href */
10325 int button; /**< The mouse button used to click on it */
10326 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10327 y, /**< Anchor geometry, relative to canvas */
10328 w, /**< Anchor geometry, relative to canvas */
10329 h; /**< Anchor geometry, relative to canvas */
10332 * @typedef Elm_Entry_Filter_Cb
10333 * This callback type is used by entry filters to modify text.
10334 * @param data The data specified as the last param when adding the filter
10335 * @param entry The entry object
10336 * @param text A pointer to the location of the text being filtered. This data can be modified,
10337 * but any additional allocations must be managed by the user.
10338 * @see elm_entry_text_filter_append
10339 * @see elm_entry_text_filter_prepend
10341 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10344 * This adds an entry to @p parent object.
10346 * By default, entries are:
10350 * @li autosave is enabled
10352 * @param parent The parent object
10353 * @return The new object or NULL if it cannot be created
10355 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10357 * Sets the entry to single line mode.
10359 * In single line mode, entries don't ever wrap when the text reaches the
10360 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10361 * key will generate an @c "activate" event instead of adding a new line.
10363 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10364 * and pressing enter will break the text into a different line
10365 * without generating any events.
10367 * @param obj The entry object
10368 * @param single_line If true, the text in the entry
10369 * will be on a single line.
10371 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10373 * Gets whether the entry is set to be single line.
10375 * @param obj The entry object
10376 * @return single_line If true, the text in the entry is set to display
10377 * on a single line.
10379 * @see elm_entry_single_line_set()
10381 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10383 * Sets the entry to password mode.
10385 * In password mode, entries are implicitly single line and the display of
10386 * any text in them is replaced with asterisks (*).
10388 * @param obj The entry object
10389 * @param password If true, password mode is enabled.
10391 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10393 * Gets whether the entry is set to password mode.
10395 * @param obj The entry object
10396 * @return If true, the entry is set to display all characters
10397 * as asterisks (*).
10399 * @see elm_entry_password_set()
10401 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10403 * This sets the text displayed within the entry to @p entry.
10405 * @param obj The entry object
10406 * @param entry The text to be displayed
10408 * @deprecated Use elm_object_text_set() instead.
10410 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10412 * This returns the text currently shown in object @p entry.
10413 * See also elm_entry_entry_set().
10415 * @param obj The entry object
10416 * @return The currently displayed text or NULL on failure
10418 * @deprecated Use elm_object_text_get() instead.
10420 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10422 * Appends @p entry to the text of the entry.
10424 * Adds the text in @p entry to the end of any text already present in the
10427 * The appended text is subject to any filters set for the widget.
10429 * @param obj The entry object
10430 * @param entry The text to be displayed
10432 * @see elm_entry_text_filter_append()
10434 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10436 * Gets whether the entry is empty.
10438 * Empty means no text at all. If there are any markup tags, like an item
10439 * tag for which no provider finds anything, and no text is displayed, this
10440 * function still returns EINA_FALSE.
10442 * @param obj The entry object
10443 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10445 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10447 * Gets any selected text within the entry.
10449 * If there's any selected text in the entry, this function returns it as
10450 * a string in markup format. NULL is returned if no selection exists or
10451 * if an error occurred.
10453 * The returned value points to an internal string and should not be freed
10454 * or modified in any way. If the @p entry object is deleted or its
10455 * contents are changed, the returned pointer should be considered invalid.
10457 * @param obj The entry object
10458 * @return The selected text within the entry or NULL on failure
10460 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10462 * Inserts the given text into the entry at the current cursor position.
10464 * This inserts text at the cursor position as if it was typed
10465 * by the user (note that this also allows markup which a user
10466 * can't just "type" as it would be converted to escaped text, so this
10467 * call can be used to insert things like emoticon items or bold push/pop
10468 * tags, other font and color change tags etc.)
10470 * If any selection exists, it will be replaced by the inserted text.
10472 * The inserted text is subject to any filters set for the widget.
10474 * @param obj The entry object
10475 * @param entry The text to insert
10477 * @see elm_entry_text_filter_append()
10479 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10481 * Set the line wrap type to use on multi-line entries.
10483 * Sets the wrap type used by the entry to any of the specified in
10484 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10485 * line (without inserting a line break or paragraph separator) when it
10486 * reaches the far edge of the widget.
10488 * Note that this only makes sense for multi-line entries. A widget set
10489 * to be single line will never wrap.
10491 * @param obj The entry object
10492 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10494 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10496 * Gets the wrap mode the entry was set to use.
10498 * @param obj The entry object
10499 * @return Wrap type
10501 * @see also elm_entry_line_wrap_set()
10503 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10505 * Sets if the entry is to be editable or not.
10507 * By default, entries are editable and when focused, any text input by the
10508 * user will be inserted at the current cursor position. But calling this
10509 * function with @p editable as EINA_FALSE will prevent the user from
10510 * inputting text into the entry.
10512 * The only way to change the text of a non-editable entry is to use
10513 * elm_object_text_set(), elm_entry_entry_insert() and other related
10516 * @param obj The entry object
10517 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10518 * if not, the entry is read-only and no user input is allowed.
10520 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10522 * Gets whether the entry is editable or not.
10524 * @param obj The entry object
10525 * @return If true, the entry is editable by the user.
10526 * If false, it is not editable by the user
10528 * @see elm_entry_editable_set()
10530 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10532 * This drops any existing text selection within the entry.
10534 * @param obj The entry object
10536 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10538 * This selects all text within the entry.
10540 * @param obj The entry object
10542 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10544 * This moves the cursor one place to the right within the entry.
10546 * @param obj The entry object
10547 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10549 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10551 * This moves the cursor one place to the left within the entry.
10553 * @param obj The entry object
10554 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10556 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10558 * This moves the cursor one line up within the entry.
10560 * @param obj The entry object
10561 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10563 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10565 * This moves the cursor one line down within the entry.
10567 * @param obj The entry object
10568 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10570 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10572 * This moves the cursor to the beginning of the entry.
10574 * @param obj The entry object
10576 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10578 * This moves the cursor to the end of the entry.
10580 * @param obj The entry object
10582 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10584 * This moves the cursor to the beginning of the current line.
10586 * @param obj The entry object
10588 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10590 * This moves the cursor to the end of the current line.
10592 * @param obj The entry object
10594 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10596 * This begins a selection within the entry as though
10597 * the user were holding down the mouse button to make a selection.
10599 * @param obj The entry object
10601 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10603 * This ends a selection within the entry as though
10604 * the user had just released the mouse button while making a selection.
10606 * @param obj The entry object
10608 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10610 * Gets whether a format node exists at the current cursor position.
10612 * A format node is anything that defines how the text is rendered. It can
10613 * be a visible format node, such as a line break or a paragraph separator,
10614 * or an invisible one, such as bold begin or end tag.
10615 * This function returns whether any format node exists at the current
10618 * @param obj The entry object
10619 * @return EINA_TRUE if the current cursor position contains a format node,
10620 * EINA_FALSE otherwise.
10622 * @see elm_entry_cursor_is_visible_format_get()
10624 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10626 * Gets if the current cursor position holds a visible format node.
10628 * @param obj The entry object
10629 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10630 * if it's an invisible one or no format exists.
10632 * @see elm_entry_cursor_is_format_get()
10634 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10636 * Gets the character pointed by the cursor at its current position.
10638 * This function returns a string with the utf8 character stored at the
10639 * current cursor position.
10640 * Only the text is returned, any format that may exist will not be part
10641 * of the return value.
10643 * @param obj The entry object
10644 * @return The text pointed by the cursors.
10646 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10648 * This function returns the geometry of the cursor.
10650 * It's useful if you want to draw something on the cursor (or where it is),
10651 * or for example in the case of scrolled entry where you want to show the
10654 * @param obj The entry object
10655 * @param x returned geometry
10656 * @param y returned geometry
10657 * @param w returned geometry
10658 * @param h returned geometry
10659 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10661 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);
10663 * Sets the cursor position in the entry to the given value
10665 * The value in @p pos is the index of the character position within the
10666 * contents of the string as returned by elm_entry_cursor_pos_get().
10668 * @param obj The entry object
10669 * @param pos The position of the cursor
10671 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10673 * Retrieves the current position of the cursor in the entry
10675 * @param obj The entry object
10676 * @return The cursor position
10678 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10680 * This executes a "cut" action on the selected text in the entry.
10682 * @param obj The entry object
10684 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10686 * This executes a "copy" action on the selected text in the entry.
10688 * @param obj The entry object
10690 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10692 * This executes a "paste" action in the entry.
10694 * @param obj The entry object
10696 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10698 * This clears and frees the items in a entry's contextual (longpress)
10701 * @param obj The entry object
10703 * @see elm_entry_context_menu_item_add()
10705 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10707 * This adds an item to the entry's contextual menu.
10709 * A longpress on an entry will make the contextual menu show up, if this
10710 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10711 * By default, this menu provides a few options like enabling selection mode,
10712 * which is useful on embedded devices that need to be explicit about it,
10713 * and when a selection exists it also shows the copy and cut actions.
10715 * With this function, developers can add other options to this menu to
10716 * perform any action they deem necessary.
10718 * @param obj The entry object
10719 * @param label The item's text label
10720 * @param icon_file The item's icon file
10721 * @param icon_type The item's icon type
10722 * @param func The callback to execute when the item is clicked
10723 * @param data The data to associate with the item for related functions
10725 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);
10727 * This disables the entry's contextual (longpress) menu.
10729 * @param obj The entry object
10730 * @param disabled If true, the menu is disabled
10732 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10734 * This returns whether the entry's contextual (longpress) menu is
10737 * @param obj The entry object
10738 * @return If true, the menu is disabled
10740 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10742 * This appends a custom item provider to the list for that entry
10744 * This appends the given callback. The list is walked from beginning to end
10745 * with each function called given the item href string in the text. If the
10746 * function returns an object handle other than NULL (it should create an
10747 * object to do this), then this object is used to replace that item. If
10748 * not the next provider is called until one provides an item object, or the
10749 * default provider in entry does.
10751 * @param obj The entry object
10752 * @param func The function called to provide the item object
10753 * @param data The data passed to @p func
10755 * @see @ref entry-items
10757 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);
10759 * This prepends a custom item provider to the list for that entry
10761 * This prepends the given callback. See elm_entry_item_provider_append() for
10764 * @param obj The entry object
10765 * @param func The function called to provide the item object
10766 * @param data The data passed to @p func
10768 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);
10770 * This removes a custom item provider to the list for that entry
10772 * This removes the given callback. See elm_entry_item_provider_append() for
10775 * @param obj The entry object
10776 * @param func The function called to provide the item object
10777 * @param data The data passed to @p func
10779 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);
10781 * Append a filter function for text inserted in the entry
10783 * Append the given callback to the list. This functions will be called
10784 * whenever any text is inserted into the entry, with the text to be inserted
10785 * as a parameter. The callback function is free to alter the text in any way
10786 * it wants, but it must remember to free the given pointer and update it.
10787 * If the new text is to be discarded, the function can free it and set its
10788 * text parameter to NULL. This will also prevent any following filters from
10791 * @param obj The entry object
10792 * @param func The function to use as text filter
10793 * @param data User data to pass to @p func
10795 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10797 * Prepend a filter function for text insdrted in the entry
10799 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10800 * for more information
10802 * @param obj The entry object
10803 * @param func The function to use as text filter
10804 * @param data User data to pass to @p func
10806 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10808 * Remove a filter from the list
10810 * Removes the given callback from the filter list. See
10811 * elm_entry_text_filter_append() for more information.
10813 * @param obj The entry object
10814 * @param func The filter function to remove
10815 * @param data The user data passed when adding the function
10817 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10819 * This converts a markup (HTML-like) string into UTF-8.
10821 * The returned string is a malloc'ed buffer and it should be freed when
10822 * not needed anymore.
10824 * @param s The string (in markup) to be converted
10825 * @return The converted string (in UTF-8). It should be freed.
10827 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10829 * This converts a UTF-8 string into markup (HTML-like).
10831 * The returned string is a malloc'ed buffer and it should be freed when
10832 * not needed anymore.
10834 * @param s The string (in UTF-8) to be converted
10835 * @return The converted string (in markup). It should be freed.
10837 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10839 * This sets the file (and implicitly loads it) for the text to display and
10840 * then edit. All changes are written back to the file after a short delay if
10841 * the entry object is set to autosave (which is the default).
10843 * If the entry had any other file set previously, any changes made to it
10844 * will be saved if the autosave feature is enabled, otherwise, the file
10845 * will be silently discarded and any non-saved changes will be lost.
10847 * @param obj The entry object
10848 * @param file The path to the file to load and save
10849 * @param format The file format
10851 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10853 * Gets the file being edited by the entry.
10855 * This function can be used to retrieve any file set on the entry for
10856 * edition, along with the format used to load and save it.
10858 * @param obj The entry object
10859 * @param file The path to the file to load and save
10860 * @param format The file format
10862 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10864 * This function writes any changes made to the file set with
10865 * elm_entry_file_set()
10867 * @param obj The entry object
10869 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10871 * This sets the entry object to 'autosave' the loaded text file or not.
10873 * @param obj The entry object
10874 * @param autosave Autosave the loaded file or not
10876 * @see elm_entry_file_set()
10878 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10880 * This gets the entry object's 'autosave' status.
10882 * @param obj The entry object
10883 * @return Autosave the loaded file or not
10885 * @see elm_entry_file_set()
10887 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10889 * Control pasting of text and images for the widget.
10891 * Normally the entry allows both text and images to be pasted. By setting
10892 * textonly to be true, this prevents images from being pasted.
10894 * Note this only changes the behaviour of text.
10896 * @param obj The entry object
10897 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10898 * text+image+other.
10900 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10902 * Getting elm_entry text paste/drop mode.
10904 * In textonly mode, only text may be pasted or dropped into the widget.
10906 * @param obj The entry object
10907 * @return If the widget only accepts text from pastes.
10909 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10911 * Enable or disable scrolling in entry
10913 * Normally the entry is not scrollable unless you enable it with this call.
10915 * @param obj The entry object
10916 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10918 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10920 * Get the scrollable state of the entry
10922 * Normally the entry is not scrollable. This gets the scrollable state
10923 * of the entry. See elm_entry_scrollable_set() for more information.
10925 * @param obj The entry object
10926 * @return The scrollable state
10928 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
10930 * This sets a widget to be displayed to the left of a scrolled entry.
10932 * @param obj The scrolled entry object
10933 * @param icon The widget to display on the left side of the scrolled
10936 * @note A previously set widget will be destroyed.
10937 * @note If the object being set does not have minimum size hints set,
10938 * it won't get properly displayed.
10940 * @see elm_entry_end_set()
10942 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10944 * Gets the leftmost widget of the scrolled entry. This object is
10945 * owned by the scrolled entry and should not be modified.
10947 * @param obj The scrolled entry object
10948 * @return the left widget inside the scroller
10950 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10952 * Unset the leftmost widget of the scrolled entry, unparenting and
10955 * @param obj The scrolled entry object
10956 * @return the previously set icon sub-object of this entry, on
10959 * @see elm_entry_icon_set()
10961 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10963 * Sets the visibility of the left-side widget of the scrolled entry,
10964 * set by elm_entry_icon_set().
10966 * @param obj The scrolled entry object
10967 * @param setting EINA_TRUE if the object should be displayed,
10968 * EINA_FALSE if not.
10970 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
10972 * This sets a widget to be displayed to the end of a scrolled entry.
10974 * @param obj The scrolled entry object
10975 * @param end The widget to display on the right side of the scrolled
10978 * @note A previously set widget will be destroyed.
10979 * @note If the object being set does not have minimum size hints set,
10980 * it won't get properly displayed.
10982 * @see elm_entry_icon_set
10984 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
10986 * Gets the endmost widget of the scrolled entry. This object is owned
10987 * by the scrolled entry and should not be modified.
10989 * @param obj The scrolled entry object
10990 * @return the right widget inside the scroller
10992 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
10994 * Unset the endmost widget of the scrolled entry, unparenting and
10997 * @param obj The scrolled entry object
10998 * @return the previously set icon sub-object of this entry, on
11001 * @see elm_entry_icon_set()
11003 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11005 * Sets the visibility of the end widget of the scrolled entry, set by
11006 * elm_entry_end_set().
11008 * @param obj The scrolled entry object
11009 * @param setting EINA_TRUE if the object should be displayed,
11010 * EINA_FALSE if not.
11012 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11014 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11017 * Setting an entry to single-line mode with elm_entry_single_line_set()
11018 * will automatically disable the display of scrollbars when the entry
11019 * moves inside its scroller.
11021 * @param obj The scrolled entry object
11022 * @param h The horizontal scrollbar policy to apply
11023 * @param v The vertical scrollbar policy to apply
11025 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11027 * This enables/disables bouncing within the entry.
11029 * This function sets whether the entry will bounce when scrolling reaches
11030 * the end of the contained entry.
11032 * @param obj The scrolled entry object
11033 * @param h The horizontal bounce state
11034 * @param v The vertical bounce state
11036 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11038 * Get the bounce mode
11040 * @param obj The Entry object
11041 * @param h_bounce Allow bounce horizontally
11042 * @param v_bounce Allow bounce vertically
11044 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11046 /* pre-made filters for entries */
11048 * @typedef Elm_Entry_Filter_Limit_Size
11050 * Data for the elm_entry_filter_limit_size() entry filter.
11052 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11054 * @struct _Elm_Entry_Filter_Limit_Size
11056 * Data for the elm_entry_filter_limit_size() entry filter.
11058 struct _Elm_Entry_Filter_Limit_Size
11060 int max_char_count; /**< The maximum number of characters allowed. */
11061 int max_byte_count; /**< The maximum number of bytes allowed*/
11064 * Filter inserted text based on user defined character and byte limits
11066 * Add this filter to an entry to limit the characters that it will accept
11067 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11068 * The funtion works on the UTF-8 representation of the string, converting
11069 * it from the set markup, thus not accounting for any format in it.
11071 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11072 * it as data when setting the filter. In it, it's possible to set limits
11073 * by character count or bytes (any of them is disabled if 0), and both can
11074 * be set at the same time. In that case, it first checks for characters,
11077 * The function will cut the inserted text in order to allow only the first
11078 * number of characters that are still allowed. The cut is made in
11079 * characters, even when limiting by bytes, in order to always contain
11080 * valid ones and avoid half unicode characters making it in.
11082 * This filter, like any others, does not apply when setting the entry text
11083 * directly with elm_object_text_set() (or the deprecated
11084 * elm_entry_entry_set()).
11086 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11088 * @typedef Elm_Entry_Filter_Accept_Set
11090 * Data for the elm_entry_filter_accept_set() entry filter.
11092 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11094 * @struct _Elm_Entry_Filter_Accept_Set
11096 * Data for the elm_entry_filter_accept_set() entry filter.
11098 struct _Elm_Entry_Filter_Accept_Set
11100 const char *accepted; /**< Set of characters accepted in the entry. */
11101 const char *rejected; /**< Set of characters rejected from the entry. */
11104 * Filter inserted text based on accepted or rejected sets of characters
11106 * Add this filter to an entry to restrict the set of accepted characters
11107 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11108 * This structure contains both accepted and rejected sets, but they are
11109 * mutually exclusive.
11111 * The @c accepted set takes preference, so if it is set, the filter will
11112 * only work based on the accepted characters, ignoring anything in the
11113 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11115 * In both cases, the function filters by matching utf8 characters to the
11116 * raw markup text, so it can be used to remove formatting tags.
11118 * This filter, like any others, does not apply when setting the entry text
11119 * directly with elm_object_text_set() (or the deprecated
11120 * elm_entry_entry_set()).
11122 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11127 /* composite widgets - these basically put together basic widgets above
11128 * in convenient packages that do more than basic stuff */
11132 * @defgroup Anchorview Anchorview
11134 * @image html img/widget/anchorview/preview-00.png
11135 * @image latex img/widget/anchorview/preview-00.eps
11137 * Anchorview is for displaying text that contains markup with anchors
11138 * like <c>\<a href=1234\>something\</\></c> in it.
11140 * Besides being styled differently, the anchorview widget provides the
11141 * necessary functionality so that clicking on these anchors brings up a
11142 * popup with user defined content such as "call", "add to contacts" or
11143 * "open web page". This popup is provided using the @ref Hover widget.
11145 * This widget is very similar to @ref Anchorblock, so refer to that
11146 * widget for an example. The only difference Anchorview has is that the
11147 * widget is already provided with scrolling functionality, so if the
11148 * text set to it is too large to fit in the given space, it will scroll,
11149 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11150 * text can be displayed.
11152 * This widget emits the following signals:
11153 * @li "anchor,clicked": will be called when an anchor is clicked. The
11154 * @p event_info parameter on the callback will be a pointer of type
11155 * ::Elm_Entry_Anchorview_Info.
11157 * See @ref Anchorblock for an example on how to use both of them.
11166 * @typedef Elm_Entry_Anchorview_Info
11168 * The info sent in the callback for "anchor,clicked" signals emitted by
11169 * the Anchorview widget.
11171 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11173 * @struct _Elm_Entry_Anchorview_Info
11175 * The info sent in the callback for "anchor,clicked" signals emitted by
11176 * the Anchorview widget.
11178 struct _Elm_Entry_Anchorview_Info
11180 const char *name; /**< Name of the anchor, as indicated in its href
11182 int button; /**< The mouse button used to click on it */
11183 Evas_Object *hover; /**< The hover object to use for the popup */
11185 Evas_Coord x, y, w, h;
11186 } anchor, /**< Geometry selection of text used as anchor */
11187 hover_parent; /**< Geometry of the object used as parent by the
11189 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11190 for content on the left side of
11191 the hover. Before calling the
11192 callback, the widget will make the
11193 necessary calculations to check
11194 which sides are fit to be set with
11195 content, based on the position the
11196 hover is activated and its distance
11197 to the edges of its parent object
11199 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11200 the right side of the hover.
11201 See @ref hover_left */
11202 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11203 of the hover. See @ref hover_left */
11204 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11205 below the hover. See @ref
11209 * Add a new Anchorview object
11211 * @param parent The parent object
11212 * @return The new object or NULL if it cannot be created
11214 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11216 * Set the text to show in the anchorview
11218 * Sets the text of the anchorview to @p text. This text can include markup
11219 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11220 * text that will be specially styled and react to click events, ended with
11221 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11222 * "anchor,clicked" signal that you can attach a callback to with
11223 * evas_object_smart_callback_add(). The name of the anchor given in the
11224 * event info struct will be the one set in the href attribute, in this
11225 * case, anchorname.
11227 * Other markup can be used to style the text in different ways, but it's
11228 * up to the style defined in the theme which tags do what.
11229 * @deprecated use elm_object_text_set() instead.
11231 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11233 * Get the markup text set for the anchorview
11235 * Retrieves the text set on the anchorview, with markup tags included.
11237 * @param obj The anchorview object
11238 * @return The markup text set or @c NULL if nothing was set or an error
11240 * @deprecated use elm_object_text_set() instead.
11242 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244 * Set the parent of the hover popup
11246 * Sets the parent object to use by the hover created by the anchorview
11247 * when an anchor is clicked. See @ref Hover for more details on this.
11248 * If no parent is set, the same anchorview object will be used.
11250 * @param obj The anchorview object
11251 * @param parent The object to use as parent for the hover
11253 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11255 * Get the parent of the hover popup
11257 * Get the object used as parent for the hover created by the anchorview
11258 * widget. See @ref Hover for more details on this.
11260 * @param obj The anchorview object
11261 * @return The object used as parent for the hover, NULL if none is set.
11263 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11265 * Set the style that the hover should use
11267 * When creating the popup hover, anchorview will request that it's
11268 * themed according to @p style.
11270 * @param obj The anchorview object
11271 * @param style The style to use for the underlying hover
11273 * @see elm_object_style_set()
11275 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11277 * Get the style that the hover should use
11279 * Get the style the hover created by anchorview will use.
11281 * @param obj The anchorview object
11282 * @return The style to use by the hover. NULL means the default is used.
11284 * @see elm_object_style_set()
11286 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11288 * Ends the hover popup in the anchorview
11290 * When an anchor is clicked, the anchorview widget will create a hover
11291 * object to use as a popup with user provided content. This function
11292 * terminates this popup, returning the anchorview to its normal state.
11294 * @param obj The anchorview object
11296 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11298 * Set bouncing behaviour when the scrolled content reaches an edge
11300 * Tell the internal scroller object whether it should bounce or not
11301 * when it reaches the respective edges for each axis.
11303 * @param obj The anchorview object
11304 * @param h_bounce Whether to bounce or not in the horizontal axis
11305 * @param v_bounce Whether to bounce or not in the vertical axis
11307 * @see elm_scroller_bounce_set()
11309 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11311 * Get the set bouncing behaviour of the internal scroller
11313 * Get whether the internal scroller should bounce when the edge of each
11314 * axis is reached scrolling.
11316 * @param obj The anchorview object
11317 * @param h_bounce Pointer where to store the bounce state of the horizontal
11319 * @param v_bounce Pointer where to store the bounce state of the vertical
11322 * @see elm_scroller_bounce_get()
11324 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11326 * Appends a custom item provider to the given anchorview
11328 * Appends the given function to the list of items providers. This list is
11329 * called, one function at a time, with the given @p data pointer, the
11330 * anchorview object and, in the @p item parameter, the item name as
11331 * referenced in its href string. Following functions in the list will be
11332 * called in order until one of them returns something different to NULL,
11333 * which should be an Evas_Object which will be used in place of the item
11336 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11337 * href=item/name\>\</item\>
11339 * @param obj The anchorview object
11340 * @param func The function to add to the list of providers
11341 * @param data User data that will be passed to the callback function
11343 * @see elm_entry_item_provider_append()
11345 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);
11347 * Prepend a custom item provider to the given anchorview
11349 * Like elm_anchorview_item_provider_append(), but it adds the function
11350 * @p func to the beginning of the list, instead of the end.
11352 * @param obj The anchorview object
11353 * @param func The function to add to the list of providers
11354 * @param data User data that will be passed to the callback function
11356 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);
11358 * Remove a custom item provider from the list of the given anchorview
11360 * Removes the function and data pairing that matches @p func and @p data.
11361 * That is, unless the same function and same user data are given, the
11362 * function will not be removed from the list. This allows us to add the
11363 * same callback several times, with different @p data pointers and be
11364 * able to remove them later without conflicts.
11366 * @param obj The anchorview object
11367 * @param func The function to remove from the list
11368 * @param data The data matching the function to remove from the list
11370 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);
11377 * @defgroup Anchorblock Anchorblock
11379 * @image html img/widget/anchorblock/preview-00.png
11380 * @image latex img/widget/anchorblock/preview-00.eps
11382 * Anchorblock is for displaying text that contains markup with anchors
11383 * like <c>\<a href=1234\>something\</\></c> in it.
11385 * Besides being styled differently, the anchorblock widget provides the
11386 * necessary functionality so that clicking on these anchors brings up a
11387 * popup with user defined content such as "call", "add to contacts" or
11388 * "open web page". This popup is provided using the @ref Hover widget.
11390 * This widget emits the following signals:
11391 * @li "anchor,clicked": will be called when an anchor is clicked. The
11392 * @p event_info parameter on the callback will be a pointer of type
11393 * ::Elm_Entry_Anchorblock_Info.
11399 * Since examples are usually better than plain words, we might as well
11400 * try @ref tutorial_anchorblock_example "one".
11403 * @addtogroup Anchorblock
11407 * @typedef Elm_Entry_Anchorblock_Info
11409 * The info sent in the callback for "anchor,clicked" signals emitted by
11410 * the Anchorblock widget.
11412 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11414 * @struct _Elm_Entry_Anchorblock_Info
11416 * The info sent in the callback for "anchor,clicked" signals emitted by
11417 * the Anchorblock widget.
11419 struct _Elm_Entry_Anchorblock_Info
11421 const char *name; /**< Name of the anchor, as indicated in its href
11423 int button; /**< The mouse button used to click on it */
11424 Evas_Object *hover; /**< The hover object to use for the popup */
11426 Evas_Coord x, y, w, h;
11427 } anchor, /**< Geometry selection of text used as anchor */
11428 hover_parent; /**< Geometry of the object used as parent by the
11430 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11431 for content on the left side of
11432 the hover. Before calling the
11433 callback, the widget will make the
11434 necessary calculations to check
11435 which sides are fit to be set with
11436 content, based on the position the
11437 hover is activated and its distance
11438 to the edges of its parent object
11440 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11441 the right side of the hover.
11442 See @ref hover_left */
11443 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11444 of the hover. See @ref hover_left */
11445 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11446 below the hover. See @ref
11450 * Add a new Anchorblock object
11452 * @param parent The parent object
11453 * @return The new object or NULL if it cannot be created
11455 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11457 * Set the text to show in the anchorblock
11459 * Sets the text of the anchorblock to @p text. This text can include markup
11460 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11461 * of text that will be specially styled and react to click events, ended
11462 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11463 * "anchor,clicked" signal that you can attach a callback to with
11464 * evas_object_smart_callback_add(). The name of the anchor given in the
11465 * event info struct will be the one set in the href attribute, in this
11466 * case, anchorname.
11468 * Other markup can be used to style the text in different ways, but it's
11469 * up to the style defined in the theme which tags do what.
11470 * @deprecated use elm_object_text_set() instead.
11472 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11474 * Get the markup text set for the anchorblock
11476 * Retrieves the text set on the anchorblock, with markup tags included.
11478 * @param obj The anchorblock object
11479 * @return The markup text set or @c NULL if nothing was set or an error
11481 * @deprecated use elm_object_text_set() instead.
11483 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11485 * Set the parent of the hover popup
11487 * Sets the parent object to use by the hover created by the anchorblock
11488 * when an anchor is clicked. See @ref Hover for more details on this.
11490 * @param obj The anchorblock object
11491 * @param parent The object to use as parent for the hover
11493 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11495 * Get the parent of the hover popup
11497 * Get the object used as parent for the hover created by the anchorblock
11498 * widget. See @ref Hover for more details on this.
11499 * If no parent is set, the same anchorblock object will be used.
11501 * @param obj The anchorblock object
11502 * @return The object used as parent for the hover, NULL if none is set.
11504 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11506 * Set the style that the hover should use
11508 * When creating the popup hover, anchorblock will request that it's
11509 * themed according to @p style.
11511 * @param obj The anchorblock object
11512 * @param style The style to use for the underlying hover
11514 * @see elm_object_style_set()
11516 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11518 * Get the style that the hover should use
11520 * Get the style the hover created by anchorblock will use.
11522 * @param obj The anchorblock object
11523 * @return The style to use by the hover. NULL means the default is used.
11525 * @see elm_object_style_set()
11527 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11529 * Ends the hover popup in the anchorblock
11531 * When an anchor is clicked, the anchorblock widget will create a hover
11532 * object to use as a popup with user provided content. This function
11533 * terminates this popup, returning the anchorblock to its normal state.
11535 * @param obj The anchorblock object
11537 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11539 * Appends a custom item provider to the given anchorblock
11541 * Appends the given function to the list of items providers. This list is
11542 * called, one function at a time, with the given @p data pointer, the
11543 * anchorblock object and, in the @p item parameter, the item name as
11544 * referenced in its href string. Following functions in the list will be
11545 * called in order until one of them returns something different to NULL,
11546 * which should be an Evas_Object which will be used in place of the item
11549 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11550 * href=item/name\>\</item\>
11552 * @param obj The anchorblock object
11553 * @param func The function to add to the list of providers
11554 * @param data User data that will be passed to the callback function
11556 * @see elm_entry_item_provider_append()
11558 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);
11560 * Prepend a custom item provider to the given anchorblock
11562 * Like elm_anchorblock_item_provider_append(), but it adds the function
11563 * @p func to the beginning of the list, instead of the end.
11565 * @param obj The anchorblock object
11566 * @param func The function to add to the list of providers
11567 * @param data User data that will be passed to the callback function
11569 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);
11571 * Remove a custom item provider from the list of the given anchorblock
11573 * Removes the function and data pairing that matches @p func and @p data.
11574 * That is, unless the same function and same user data are given, the
11575 * function will not be removed from the list. This allows us to add the
11576 * same callback several times, with different @p data pointers and be
11577 * able to remove them later without conflicts.
11579 * @param obj The anchorblock object
11580 * @param func The function to remove from the list
11581 * @param data The data matching the function to remove from the list
11583 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);
11589 * @defgroup Bubble Bubble
11591 * @image html img/widget/bubble/preview-00.png
11592 * @image latex img/widget/bubble/preview-00.eps
11593 * @image html img/widget/bubble/preview-01.png
11594 * @image latex img/widget/bubble/preview-01.eps
11595 * @image html img/widget/bubble/preview-02.png
11596 * @image latex img/widget/bubble/preview-02.eps
11598 * @brief The Bubble is a widget to show text similarly to how speech is
11599 * represented in comics.
11601 * The bubble widget contains 5 important visual elements:
11602 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11603 * @li The @p icon is an image to which the frame's arrow points to.
11604 * @li The @p label is a text which appears to the right of the icon if the
11605 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11607 * @li The @p info is a text which appears to the right of the label. Info's
11608 * font is of a ligther color than label.
11609 * @li The @p content is an evas object that is shown inside the frame.
11611 * The position of the arrow, icon, label and info depends on which corner is
11612 * selected. The four available corners are:
11613 * @li "top_left" - Default
11615 * @li "bottom_left"
11616 * @li "bottom_right"
11618 * Signals that you can add callbacks for are:
11619 * @li "clicked" - This is called when a user has clicked the bubble.
11621 * For an example of using a buble see @ref bubble_01_example_page "this".
11626 * Add a new bubble to the parent
11628 * @param parent The parent object
11629 * @return The new object or NULL if it cannot be created
11631 * This function adds a text bubble to the given parent evas object.
11633 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11635 * Set the label of the bubble
11637 * @param obj The bubble object
11638 * @param label The string to set in the label
11640 * This function sets the title of the bubble. Where this appears depends on
11641 * the selected corner.
11642 * @deprecated use elm_object_text_set() instead.
11644 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11646 * Get the label of the bubble
11648 * @param obj The bubble object
11649 * @return The string of set in the label
11651 * This function gets the title of the bubble.
11652 * @deprecated use elm_object_text_get() instead.
11654 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11656 * Set the info of the bubble
11658 * @param obj The bubble object
11659 * @param info The given info about the bubble
11661 * This function sets the info of the bubble. Where this appears depends on
11662 * the selected corner.
11663 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11665 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11667 * Get the info of the bubble
11669 * @param obj The bubble object
11671 * @return The "info" string of the bubble
11673 * This function gets the info text.
11674 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11676 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11678 * Set the content to be shown in the bubble
11680 * Once the content object is set, a previously set one will be deleted.
11681 * If you want to keep the old content object, use the
11682 * elm_bubble_content_unset() function.
11684 * @param obj The bubble object
11685 * @param content The given content of the bubble
11687 * This function sets the content shown on the middle of the bubble.
11689 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11691 * Get the content shown in the bubble
11693 * Return the content object which is set for this widget.
11695 * @param obj The bubble object
11696 * @return The content that is being used
11698 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11700 * Unset the content shown in the bubble
11702 * Unparent and return the content object which was set for this widget.
11704 * @param obj The bubble object
11705 * @return The content that was being used
11707 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11709 * Set the icon of the bubble
11711 * Once the icon object is set, a previously set one will be deleted.
11712 * If you want to keep the old content object, use the
11713 * elm_icon_content_unset() function.
11715 * @param obj The bubble object
11716 * @param icon The given icon for the bubble
11718 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11720 * Get the icon of the bubble
11722 * @param obj The bubble object
11723 * @return The icon for the bubble
11725 * This function gets the icon shown on the top left of bubble.
11727 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11729 * Unset the icon of the bubble
11731 * Unparent and return the icon object which was set for this widget.
11733 * @param obj The bubble object
11734 * @return The icon that was being used
11736 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11738 * Set the corner of the bubble
11740 * @param obj The bubble object.
11741 * @param corner The given corner for the bubble.
11743 * This function sets the corner of the bubble. The corner will be used to
11744 * determine where the arrow in the frame points to and where label, icon and
11747 * Possible values for corner are:
11748 * @li "top_left" - Default
11750 * @li "bottom_left"
11751 * @li "bottom_right"
11753 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11755 * Get the corner of the bubble
11757 * @param obj The bubble object.
11758 * @return The given corner for the bubble.
11760 * This function gets the selected corner of the bubble.
11762 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11768 * @defgroup Photo Photo
11770 * For displaying the photo of a person (contact). Simple yet
11771 * with a very specific purpose.
11773 * Signals that you can add callbacks for are:
11775 * "clicked" - This is called when a user has clicked the photo
11776 * "drag,start" - Someone started dragging the image out of the object
11777 * "drag,end" - Dragged item was dropped (somewhere)
11783 * Add a new photo to the parent
11785 * @param parent The parent object
11786 * @return The new object or NULL if it cannot be created
11790 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11793 * Set the file that will be used as photo
11795 * @param obj The photo object
11796 * @param file The path to file that will be used as photo
11798 * @return (1 = success, 0 = error)
11802 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11805 * Set the size that will be used on the photo
11807 * @param obj The photo object
11808 * @param size The size that the photo will be
11812 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11815 * Set if the photo should be completely visible or not.
11817 * @param obj The photo object
11818 * @param fill if true the photo will be completely visible
11822 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11825 * Set editability of the photo.
11827 * An editable photo can be dragged to or from, and can be cut or
11828 * pasted too. Note that pasting an image or dropping an item on
11829 * the image will delete the existing content.
11831 * @param obj The photo object.
11832 * @param set To set of clear editablity.
11834 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11840 /* gesture layer */
11842 * @defgroup Elm_Gesture_Layer Gesture Layer
11843 * Gesture Layer Usage:
11845 * Use Gesture Layer to detect gestures.
11846 * The advantage is that you don't have to implement
11847 * gesture detection, just set callbacks of gesture state.
11848 * By using gesture layer we make standard interface.
11850 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11851 * with a parent object parameter.
11852 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11853 * call. Usually with same object as target (2nd parameter).
11855 * Now you need to tell gesture layer what gestures you follow.
11856 * This is done with @ref elm_gesture_layer_cb_set call.
11857 * By setting the callback you actually saying to gesture layer:
11858 * I would like to know when the gesture @ref Elm_Gesture_Types
11859 * switches to state @ref Elm_Gesture_State.
11861 * Next, you need to implement the actual action that follows the input
11862 * in your callback.
11864 * Note that if you like to stop being reported about a gesture, just set
11865 * all callbacks referring this gesture to NULL.
11866 * (again with @ref elm_gesture_layer_cb_set)
11868 * The information reported by gesture layer to your callback is depending
11869 * on @ref Elm_Gesture_Types:
11870 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11871 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11872 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11874 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11875 * @ref ELM_GESTURE_MOMENTUM.
11877 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11878 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11879 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11880 * Note that we consider a flick as a line-gesture that should be completed
11881 * in flick-time-limit as defined in @ref Config.
11883 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11885 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11889 * @enum _Elm_Gesture_Types
11890 * Enum of supported gesture types.
11891 * @ingroup Elm_Gesture_Layer
11893 enum _Elm_Gesture_Types
11895 ELM_GESTURE_FIRST = 0,
11897 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11898 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11899 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11900 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11902 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11904 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11905 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11907 ELM_GESTURE_ZOOM, /**< Zoom */
11908 ELM_GESTURE_ROTATE, /**< Rotate */
11914 * @typedef Elm_Gesture_Types
11915 * gesture types enum
11916 * @ingroup Elm_Gesture_Layer
11918 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11921 * @enum _Elm_Gesture_State
11922 * Enum of gesture states.
11923 * @ingroup Elm_Gesture_Layer
11925 enum _Elm_Gesture_State
11927 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11928 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
11929 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
11930 ELM_GESTURE_STATE_END, /**< Gesture completed */
11931 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
11935 * @typedef Elm_Gesture_State
11936 * gesture states enum
11937 * @ingroup Elm_Gesture_Layer
11939 typedef enum _Elm_Gesture_State Elm_Gesture_State;
11942 * @struct _Elm_Gesture_Taps_Info
11943 * Struct holds taps info for user
11944 * @ingroup Elm_Gesture_Layer
11946 struct _Elm_Gesture_Taps_Info
11948 Evas_Coord x, y; /**< Holds center point between fingers */
11949 unsigned int n; /**< Number of fingers tapped */
11950 unsigned int timestamp; /**< event timestamp */
11954 * @typedef Elm_Gesture_Taps_Info
11955 * holds taps info for user
11956 * @ingroup Elm_Gesture_Layer
11958 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11961 * @struct _Elm_Gesture_Momentum_Info
11962 * Struct holds momentum info for user
11963 * x1 and y1 are not necessarily in sync
11964 * x1 holds x value of x direction starting point
11965 * and same holds for y1.
11966 * This is noticeable when doing V-shape movement
11967 * @ingroup Elm_Gesture_Layer
11969 struct _Elm_Gesture_Momentum_Info
11970 { /* Report line ends, timestamps, and momentum computed */
11971 Evas_Coord x1; /**< Final-swipe direction starting point on X */
11972 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
11973 Evas_Coord x2; /**< Final-swipe direction ending point on X */
11974 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
11976 unsigned int tx; /**< Timestamp of start of final x-swipe */
11977 unsigned int ty; /**< Timestamp of start of final y-swipe */
11979 Evas_Coord mx; /**< Momentum on X */
11980 Evas_Coord my; /**< Momentum on Y */
11984 * @typedef Elm_Gesture_Momentum_Info
11985 * holds momentum info for user
11986 * @ingroup Elm_Gesture_Layer
11988 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
11991 * @struct _Elm_Gesture_Line_Info
11992 * Struct holds line info for user
11993 * @ingroup Elm_Gesture_Layer
11995 struct _Elm_Gesture_Line_Info
11996 { /* Report line ends, timestamps, and momentum computed */
11997 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
11998 unsigned int n; /**< Number of fingers (lines) */
11999 /* FIXME should be radians, bot degrees */
12000 double angle; /**< Angle (direction) of lines */
12004 * @typedef Elm_Gesture_Line_Info
12005 * Holds line info for user
12006 * @ingroup Elm_Gesture_Layer
12008 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12011 * @struct _Elm_Gesture_Zoom_Info
12012 * Struct holds zoom info for user
12013 * @ingroup Elm_Gesture_Layer
12015 struct _Elm_Gesture_Zoom_Info
12017 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12018 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12019 double zoom; /**< Zoom value: 1.0 means no zoom */
12020 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12024 * @typedef Elm_Gesture_Zoom_Info
12025 * Holds zoom info for user
12026 * @ingroup Elm_Gesture_Layer
12028 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12031 * @struct _Elm_Gesture_Rotate_Info
12032 * Struct holds rotation info for user
12033 * @ingroup Elm_Gesture_Layer
12035 struct _Elm_Gesture_Rotate_Info
12037 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12038 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12039 double base_angle; /**< Holds start-angle */
12040 double angle; /**< Rotation value: 0.0 means no rotation */
12041 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12045 * @typedef Elm_Gesture_Rotate_Info
12046 * Holds rotation info for user
12047 * @ingroup Elm_Gesture_Layer
12049 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12052 * @typedef Elm_Gesture_Event_Cb
12053 * User callback used to stream gesture info from gesture layer
12054 * @param data user data
12055 * @param event_info gesture report info
12056 * Returns a flag field to be applied on the causing event.
12057 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12058 * upon the event, in an irreversible way.
12060 * @ingroup Elm_Gesture_Layer
12062 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12065 * Use function to set callbacks to be notified about
12066 * change of state of gesture.
12067 * When a user registers a callback with this function
12068 * this means this gesture has to be tested.
12070 * When ALL callbacks for a gesture are set to NULL
12071 * it means user isn't interested in gesture-state
12072 * and it will not be tested.
12074 * @param obj Pointer to gesture-layer.
12075 * @param idx The gesture you would like to track its state.
12076 * @param cb callback function pointer.
12077 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12078 * @param data user info to be sent to callback (usually, Smart Data)
12080 * @ingroup Elm_Gesture_Layer
12082 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);
12085 * Call this function to get repeat-events settings.
12087 * @param obj Pointer to gesture-layer.
12089 * @return repeat events settings.
12090 * @see elm_gesture_layer_hold_events_set()
12091 * @ingroup Elm_Gesture_Layer
12093 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12096 * This function called in order to make gesture-layer repeat events.
12097 * Set this of you like to get the raw events only if gestures were not detected.
12098 * Clear this if you like gesture layer to fwd events as testing gestures.
12100 * @param obj Pointer to gesture-layer.
12101 * @param r Repeat: TRUE/FALSE
12103 * @ingroup Elm_Gesture_Layer
12105 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12108 * This function sets step-value for zoom action.
12109 * Set step to any positive value.
12110 * Cancel step setting by setting to 0.0
12112 * @param obj Pointer to gesture-layer.
12113 * @param s new zoom step value.
12115 * @ingroup Elm_Gesture_Layer
12117 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12120 * This function sets step-value for rotate action.
12121 * Set step to any positive value.
12122 * Cancel step setting by setting to 0.0
12124 * @param obj Pointer to gesture-layer.
12125 * @param s new roatate step value.
12127 * @ingroup Elm_Gesture_Layer
12129 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12132 * This function called to attach gesture-layer to an Evas_Object.
12133 * @param obj Pointer to gesture-layer.
12134 * @param t Pointer to underlying object (AKA Target)
12136 * @return TRUE, FALSE on success, failure.
12138 * @ingroup Elm_Gesture_Layer
12140 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12143 * Call this function to construct a new gesture-layer object.
12144 * This does not activate the gesture layer. You have to
12145 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12147 * @param parent the parent object.
12149 * @return Pointer to new gesture-layer object.
12151 * @ingroup Elm_Gesture_Layer
12153 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12156 * @defgroup Thumb Thumb
12158 * @image html img/widget/thumb/preview-00.png
12159 * @image latex img/widget/thumb/preview-00.eps
12161 * A thumb object is used for displaying the thumbnail of an image or video.
12162 * You must have compiled Elementary with Ethumb_Client support and the DBus
12163 * service must be present and auto-activated in order to have thumbnails to
12166 * Once the thumbnail object becomes visible, it will check if there is a
12167 * previously generated thumbnail image for the file set on it. If not, it
12168 * will start generating this thumbnail.
12170 * Different config settings will cause different thumbnails to be generated
12171 * even on the same file.
12173 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12174 * Ethumb documentation to change this path, and to see other configuration
12177 * Signals that you can add callbacks for are:
12179 * - "clicked" - This is called when a user has clicked the thumb without dragging
12181 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12182 * - "press" - This is called when a user has pressed down the thumb.
12183 * - "generate,start" - The thumbnail generation started.
12184 * - "generate,stop" - The generation process stopped.
12185 * - "generate,error" - The generation failed.
12186 * - "load,error" - The thumbnail image loading failed.
12188 * available styles:
12192 * An example of use of thumbnail:
12194 * - @ref thumb_example_01
12198 * @addtogroup Thumb
12203 * @enum _Elm_Thumb_Animation_Setting
12204 * @typedef Elm_Thumb_Animation_Setting
12206 * Used to set if a video thumbnail is animating or not.
12210 typedef enum _Elm_Thumb_Animation_Setting
12212 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12213 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12214 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12215 ELM_THUMB_ANIMATION_LAST
12216 } Elm_Thumb_Animation_Setting;
12219 * Add a new thumb object to the parent.
12221 * @param parent The parent object.
12222 * @return The new object or NULL if it cannot be created.
12224 * @see elm_thumb_file_set()
12225 * @see elm_thumb_ethumb_client_get()
12229 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12231 * Reload thumbnail if it was generated before.
12233 * @param obj The thumb object to reload
12235 * This is useful if the ethumb client configuration changed, like its
12236 * size, aspect or any other property one set in the handle returned
12237 * by elm_thumb_ethumb_client_get().
12239 * If the options didn't change, the thumbnail won't be generated again, but
12240 * the old one will still be used.
12242 * @see elm_thumb_file_set()
12246 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12248 * Set the file that will be used as thumbnail.
12250 * @param obj The thumb object.
12251 * @param file The path to file that will be used as thumb.
12252 * @param key The key used in case of an EET file.
12254 * The file can be an image or a video (in that case, acceptable extensions are:
12255 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12256 * function elm_thumb_animate().
12258 * @see elm_thumb_file_get()
12259 * @see elm_thumb_reload()
12260 * @see elm_thumb_animate()
12264 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12266 * Get the image or video path and key used to generate the thumbnail.
12268 * @param obj The thumb object.
12269 * @param file Pointer to filename.
12270 * @param key Pointer to key.
12272 * @see elm_thumb_file_set()
12273 * @see elm_thumb_path_get()
12277 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12279 * Get the path and key to the image or video generated by ethumb.
12281 * One just need to make sure that the thumbnail was generated before getting
12282 * its path; otherwise, the path will be NULL. One way to do that is by asking
12283 * for the path when/after the "generate,stop" smart callback is called.
12285 * @param obj The thumb object.
12286 * @param file Pointer to thumb path.
12287 * @param key Pointer to thumb key.
12289 * @see elm_thumb_file_get()
12293 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12295 * Set the animation state for the thumb object. If its content is an animated
12296 * video, you may start/stop the animation or tell it to play continuously and
12299 * @param obj The thumb object.
12300 * @param setting The animation setting.
12302 * @see elm_thumb_file_set()
12306 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12308 * Get the animation state for the thumb object.
12310 * @param obj The thumb object.
12311 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12314 * @see elm_thumb_animate_set()
12318 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12320 * Get the ethumb_client handle so custom configuration can be made.
12322 * @return Ethumb_Client instance or NULL.
12324 * This must be called before the objects are created to be sure no object is
12325 * visible and no generation started.
12327 * Example of usage:
12330 * #include <Elementary.h>
12331 * #ifndef ELM_LIB_QUICKLAUNCH
12333 * elm_main(int argc, char **argv)
12335 * Ethumb_Client *client;
12337 * elm_need_ethumb();
12341 * client = elm_thumb_ethumb_client_get();
12344 * ERR("could not get ethumb_client");
12347 * ethumb_client_size_set(client, 100, 100);
12348 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12351 * // Create elm_thumb objects here
12361 * @note There's only one client handle for Ethumb, so once a configuration
12362 * change is done to it, any other request for thumbnails (for any thumbnail
12363 * object) will use that configuration. Thus, this configuration is global.
12367 EAPI void *elm_thumb_ethumb_client_get(void);
12369 * Get the ethumb_client connection state.
12371 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12374 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12376 * Make the thumbnail 'editable'.
12378 * @param obj Thumb object.
12379 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12381 * This means the thumbnail is a valid drag target for drag and drop, and can be
12382 * cut or pasted too.
12384 * @see elm_thumb_editable_get()
12388 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12390 * Make the thumbnail 'editable'.
12392 * @param obj Thumb object.
12393 * @return Editability.
12395 * This means the thumbnail is a valid drag target for drag and drop, and can be
12396 * cut or pasted too.
12398 * @see elm_thumb_editable_set()
12402 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12409 * @defgroup Hoversel Hoversel
12411 * @image html img/widget/hoversel/preview-00.png
12412 * @image latex img/widget/hoversel/preview-00.eps
12414 * A hoversel is a button that pops up a list of items (automatically
12415 * choosing the direction to display) that have a label and, optionally, an
12416 * icon to select from. It is a convenience widget to avoid the need to do
12417 * all the piecing together yourself. It is intended for a small number of
12418 * items in the hoversel menu (no more than 8), though is capable of many
12421 * Signals that you can add callbacks for are:
12422 * "clicked" - the user clicked the hoversel button and popped up the sel
12423 * "selected" - an item in the hoversel list is selected. event_info is the item
12424 * "dismissed" - the hover is dismissed
12426 * See @ref tutorial_hoversel for an example.
12429 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12431 * @brief Add a new Hoversel object
12433 * @param parent The parent object
12434 * @return The new object or NULL if it cannot be created
12436 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12438 * @brief This sets the hoversel to expand horizontally.
12440 * @param obj The hoversel object
12441 * @param horizontal If true, the hover will expand horizontally to the
12444 * @note The initial button will display horizontally regardless of this
12447 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12449 * @brief This returns whether the hoversel is set to expand horizontally.
12451 * @param obj The hoversel object
12452 * @return If true, the hover will expand horizontally to the right.
12454 * @see elm_hoversel_horizontal_set()
12456 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12458 * @brief Set the Hover parent
12460 * @param obj The hoversel object
12461 * @param parent The parent to use
12463 * Sets the hover parent object, the area that will be darkened when the
12464 * hoversel is clicked. Should probably be the window that the hoversel is
12465 * in. See @ref Hover objects for more information.
12467 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12469 * @brief Get the Hover parent
12471 * @param obj The hoversel object
12472 * @return The used parent
12474 * Gets the hover parent object.
12476 * @see elm_hoversel_hover_parent_set()
12478 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12480 * @brief Set the hoversel button label
12482 * @param obj The hoversel object
12483 * @param label The label text.
12485 * This sets the label of the button that is always visible (before it is
12486 * clicked and expanded).
12488 * @deprecated elm_object_text_set()
12490 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12492 * @brief Get the hoversel button label
12494 * @param obj The hoversel object
12495 * @return The label text.
12497 * @deprecated elm_object_text_get()
12499 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12501 * @brief Set the icon of the hoversel button
12503 * @param obj The hoversel object
12504 * @param icon The icon object
12506 * Sets the icon of the button that is always visible (before it is clicked
12507 * and expanded). Once the icon object is set, a previously set one will be
12508 * deleted, if you want to keep that old content object, use the
12509 * elm_hoversel_icon_unset() function.
12511 * @see elm_button_icon_set()
12513 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12515 * @brief Get the icon of the hoversel button
12517 * @param obj The hoversel object
12518 * @return The icon object
12520 * Get the icon of the button that is always visible (before it is clicked
12521 * and expanded). Also see elm_button_icon_get().
12523 * @see elm_hoversel_icon_set()
12525 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12527 * @brief Get and unparent the icon of the hoversel button
12529 * @param obj The hoversel object
12530 * @return The icon object that was being used
12532 * Unparent and return the icon of the button that is always visible
12533 * (before it is clicked and expanded).
12535 * @see elm_hoversel_icon_set()
12536 * @see elm_button_icon_unset()
12538 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12540 * @brief This triggers the hoversel popup from code, the same as if the user
12541 * had clicked the button.
12543 * @param obj The hoversel object
12545 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12547 * @brief This dismisses the hoversel popup as if the user had clicked
12548 * outside the hover.
12550 * @param obj The hoversel object
12552 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12554 * @brief Returns whether the hoversel is expanded.
12556 * @param obj The hoversel object
12557 * @return This will return EINA_TRUE if the hoversel is expanded or
12558 * EINA_FALSE if it is not expanded.
12560 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12562 * @brief This will remove all the children items from the hoversel.
12564 * @param obj The hoversel object
12566 * @warning Should @b not be called while the hoversel is active; use
12567 * elm_hoversel_expanded_get() to check first.
12569 * @see elm_hoversel_item_del_cb_set()
12570 * @see elm_hoversel_item_del()
12572 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12574 * @brief Get the list of items within the given hoversel.
12576 * @param obj The hoversel object
12577 * @return Returns a list of Elm_Hoversel_Item*
12579 * @see elm_hoversel_item_add()
12581 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12583 * @brief Add an item to the hoversel button
12585 * @param obj The hoversel object
12586 * @param label The text label to use for the item (NULL if not desired)
12587 * @param icon_file An image file path on disk to use for the icon or standard
12588 * icon name (NULL if not desired)
12589 * @param icon_type The icon type if relevant
12590 * @param func Convenience function to call when this item is selected
12591 * @param data Data to pass to item-related functions
12592 * @return A handle to the item added.
12594 * This adds an item to the hoversel to show when it is clicked. Note: if you
12595 * need to use an icon from an edje file then use
12596 * elm_hoversel_item_icon_set() right after the this function, and set
12597 * icon_file to NULL here.
12599 * For more information on what @p icon_file and @p icon_type are see the
12600 * @ref Icon "icon documentation".
12602 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);
12604 * @brief Delete an item from the hoversel
12606 * @param item The item to delete
12608 * This deletes the item from the hoversel (should not be called while the
12609 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12611 * @see elm_hoversel_item_add()
12612 * @see elm_hoversel_item_del_cb_set()
12614 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12616 * @brief Set the function to be called when an item from the hoversel is
12619 * @param item The item to set the callback on
12620 * @param func The function called
12622 * That function will receive these parameters:
12623 * @li void *item_data
12624 * @li Evas_Object *the_item_object
12625 * @li Elm_Hoversel_Item *the_object_struct
12627 * @see elm_hoversel_item_add()
12629 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12631 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12632 * that will be passed to associated function callbacks.
12634 * @param item The item to get the data from
12635 * @return The data pointer set with elm_hoversel_item_add()
12637 * @see elm_hoversel_item_add()
12639 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12641 * @brief This returns the label text of the given hoversel item.
12643 * @param item The item to get the label
12644 * @return The label text of the hoversel item
12646 * @see elm_hoversel_item_add()
12648 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12650 * @brief This sets the icon for the given hoversel item.
12652 * @param item The item to set the icon
12653 * @param icon_file An image file path on disk to use for the icon or standard
12655 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12656 * to NULL if the icon is not an edje file
12657 * @param icon_type The icon type
12659 * The icon can be loaded from the standard set, from an image file, or from
12662 * @see elm_hoversel_item_add()
12664 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);
12666 * @brief Get the icon object of the hoversel item
12668 * @param item The item to get the icon from
12669 * @param icon_file The image file path on disk used for the icon or standard
12671 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12672 * if the icon is not an edje file
12673 * @param icon_type The icon type
12675 * @see elm_hoversel_item_icon_set()
12676 * @see elm_hoversel_item_add()
12678 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);
12684 * @defgroup Toolbar Toolbar
12685 * @ingroup Elementary
12687 * @image html img/widget/toolbar/preview-00.png
12688 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12690 * @image html img/toolbar.png
12691 * @image latex img/toolbar.eps width=\textwidth
12693 * A toolbar is a widget that displays a list of items inside
12694 * a box. It can be scrollable, show a menu with items that don't fit
12695 * to toolbar size or even crop them.
12697 * Only one item can be selected at a time.
12699 * Items can have multiple states, or show menus when selected by the user.
12701 * Smart callbacks one can listen to:
12702 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12704 * Available styles for it:
12706 * - @c "transparent" - no background or shadow, just show the content
12708 * List of examples:
12709 * @li @ref toolbar_example_01
12710 * @li @ref toolbar_example_02
12711 * @li @ref toolbar_example_03
12715 * @addtogroup Toolbar
12720 * @enum _Elm_Toolbar_Shrink_Mode
12721 * @typedef Elm_Toolbar_Shrink_Mode
12723 * Set toolbar's items display behavior, it can be scrollabel,
12724 * show a menu with exceeding items, or simply hide them.
12726 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12729 * Values <b> don't </b> work as bitmask, only one can be choosen.
12731 * @see elm_toolbar_mode_shrink_set()
12732 * @see elm_toolbar_mode_shrink_get()
12736 typedef enum _Elm_Toolbar_Shrink_Mode
12738 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12739 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12740 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12741 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12742 } Elm_Toolbar_Shrink_Mode;
12744 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(). */
12746 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(). */
12749 * Add a new toolbar widget to the given parent Elementary
12750 * (container) object.
12752 * @param parent The parent object.
12753 * @return a new toolbar widget handle or @c NULL, on errors.
12755 * This function inserts a new toolbar widget on the canvas.
12759 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12762 * Set the icon size, in pixels, to be used by toolbar items.
12764 * @param obj The toolbar object
12765 * @param icon_size The icon size in pixels
12767 * @note Default value is @c 32. It reads value from elm config.
12769 * @see elm_toolbar_icon_size_get()
12773 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12776 * Get the icon size, in pixels, to be used by toolbar items.
12778 * @param obj The toolbar object.
12779 * @return The icon size in pixels.
12781 * @see elm_toolbar_icon_size_set() for details.
12785 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12788 * Sets icon lookup order, for toolbar items' icons.
12790 * @param obj The toolbar object.
12791 * @param order The icon lookup order.
12793 * Icons added before calling this function will not be affected.
12794 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12796 * @see elm_toolbar_icon_order_lookup_get()
12800 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12803 * Gets the icon lookup order.
12805 * @param obj The toolbar object.
12806 * @return The icon lookup order.
12808 * @see elm_toolbar_icon_order_lookup_set() for details.
12812 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12815 * Set whether the toolbar items' should be selected by the user or not.
12817 * @param obj The toolbar object.
12818 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12821 * This will turn off the ability to select items entirely and they will
12822 * neither appear selected nor emit selected signals. The clicked
12823 * callback function will still be called.
12825 * Selection is enabled by default.
12827 * @see elm_toolbar_no_select_mode_get().
12831 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12834 * Set whether the toolbar items' should be selected by the user or not.
12836 * @param obj The toolbar object.
12837 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12838 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12840 * @see elm_toolbar_no_select_mode_set() for details.
12844 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12847 * Append item to the toolbar.
12849 * @param obj The toolbar object.
12850 * @param icon A string with icon name or the absolute path of an image file.
12851 * @param label The label of the item.
12852 * @param func The function to call when the item is clicked.
12853 * @param data The data to associate with the item for related callbacks.
12854 * @return The created item or @c NULL upon failure.
12856 * A new item will be created and appended to the toolbar, i.e., will
12857 * be set as @b last item.
12859 * Items created with this method can be deleted with
12860 * elm_toolbar_item_del().
12862 * Associated @p data can be properly freed when item is deleted if a
12863 * callback function is set with elm_toolbar_item_del_cb_set().
12865 * If a function is passed as argument, it will be called everytime this item
12866 * is selected, i.e., the user clicks over an unselected item.
12867 * If such function isn't needed, just passing
12868 * @c NULL as @p func is enough. The same should be done for @p data.
12870 * Toolbar will load icon image from fdo or current theme.
12871 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12872 * If an absolute path is provided it will load it direct from a file.
12874 * @see elm_toolbar_item_icon_set()
12875 * @see elm_toolbar_item_del()
12876 * @see elm_toolbar_item_del_cb_set()
12880 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);
12883 * Prepend item to the toolbar.
12885 * @param obj The toolbar object.
12886 * @param icon A string with icon name or the absolute path of an image file.
12887 * @param label The label of the item.
12888 * @param func The function to call when the item is clicked.
12889 * @param data The data to associate with the item for related callbacks.
12890 * @return The created item or @c NULL upon failure.
12892 * A new item will be created and prepended to the toolbar, i.e., will
12893 * be set as @b first item.
12895 * Items created with this method can be deleted with
12896 * elm_toolbar_item_del().
12898 * Associated @p data can be properly freed when item is deleted if a
12899 * callback function is set with elm_toolbar_item_del_cb_set().
12901 * If a function is passed as argument, it will be called everytime this item
12902 * is selected, i.e., the user clicks over an unselected item.
12903 * If such function isn't needed, just passing
12904 * @c NULL as @p func is enough. The same should be done for @p data.
12906 * Toolbar will load icon image from fdo or current theme.
12907 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12908 * If an absolute path is provided it will load it direct from a file.
12910 * @see elm_toolbar_item_icon_set()
12911 * @see elm_toolbar_item_del()
12912 * @see elm_toolbar_item_del_cb_set()
12916 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);
12919 * Insert a new item into the toolbar object before item @p before.
12921 * @param obj The toolbar object.
12922 * @param before The toolbar item to insert before.
12923 * @param icon A string with icon name or the absolute path of an image file.
12924 * @param label The label of the item.
12925 * @param func The function to call when the item is clicked.
12926 * @param data The data to associate with the item for related callbacks.
12927 * @return The created item or @c NULL upon failure.
12929 * A new item will be created and added to the toolbar. Its position in
12930 * this toolbar will be just before item @p before.
12932 * Items created with this method can be deleted with
12933 * elm_toolbar_item_del().
12935 * Associated @p data can be properly freed when item is deleted if a
12936 * callback function is set with elm_toolbar_item_del_cb_set().
12938 * If a function is passed as argument, it will be called everytime this item
12939 * is selected, i.e., the user clicks over an unselected item.
12940 * If such function isn't needed, just passing
12941 * @c NULL as @p func is enough. The same should be done for @p data.
12943 * Toolbar will load icon image from fdo or current theme.
12944 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12945 * If an absolute path is provided it will load it direct from a file.
12947 * @see elm_toolbar_item_icon_set()
12948 * @see elm_toolbar_item_del()
12949 * @see elm_toolbar_item_del_cb_set()
12953 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);
12956 * Insert a new item into the toolbar object after item @p after.
12958 * @param obj The toolbar object.
12959 * @param before The toolbar item to insert before.
12960 * @param icon A string with icon name or the absolute path of an image file.
12961 * @param label The label of the item.
12962 * @param func The function to call when the item is clicked.
12963 * @param data The data to associate with the item for related callbacks.
12964 * @return The created item or @c NULL upon failure.
12966 * A new item will be created and added to the toolbar. Its position in
12967 * this toolbar will be just after item @p after.
12969 * Items created with this method can be deleted with
12970 * elm_toolbar_item_del().
12972 * Associated @p data can be properly freed when item is deleted if a
12973 * callback function is set with elm_toolbar_item_del_cb_set().
12975 * If a function is passed as argument, it will be called everytime this item
12976 * is selected, i.e., the user clicks over an unselected item.
12977 * If such function isn't needed, just passing
12978 * @c NULL as @p func is enough. The same should be done for @p data.
12980 * Toolbar will load icon image from fdo or current theme.
12981 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12982 * If an absolute path is provided it will load it direct from a file.
12984 * @see elm_toolbar_item_icon_set()
12985 * @see elm_toolbar_item_del()
12986 * @see elm_toolbar_item_del_cb_set()
12990 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);
12993 * Get the first item in the given toolbar widget's list of
12996 * @param obj The toolbar object
12997 * @return The first item or @c NULL, if it has no items (and on
13000 * @see elm_toolbar_item_append()
13001 * @see elm_toolbar_last_item_get()
13005 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13008 * Get the last item in the given toolbar widget's list of
13011 * @param obj The toolbar object
13012 * @return The last item or @c NULL, if it has no items (and on
13015 * @see elm_toolbar_item_prepend()
13016 * @see elm_toolbar_first_item_get()
13020 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13023 * Get the item after @p item in toolbar.
13025 * @param item The toolbar item.
13026 * @return The item after @p item, or @c NULL if none or on failure.
13028 * @note If it is the last item, @c NULL will be returned.
13030 * @see elm_toolbar_item_append()
13034 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13037 * Get the item before @p item in toolbar.
13039 * @param item The toolbar item.
13040 * @return The item before @p item, or @c NULL if none or on failure.
13042 * @note If it is the first item, @c NULL will be returned.
13044 * @see elm_toolbar_item_prepend()
13048 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13051 * Get the toolbar object from an item.
13053 * @param item The item.
13054 * @return The toolbar object.
13056 * This returns the toolbar object itself that an item belongs to.
13060 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13063 * Set the priority of a toolbar item.
13065 * @param item The toolbar item.
13066 * @param priority The item priority. The default is zero.
13068 * This is used only when the toolbar shrink mode is set to
13069 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13070 * When space is less than required, items with low priority
13071 * will be removed from the toolbar and added to a dynamically-created menu,
13072 * while items with higher priority will remain on the toolbar,
13073 * with the same order they were added.
13075 * @see elm_toolbar_item_priority_get()
13079 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13082 * Get the priority of a toolbar item.
13084 * @param item The toolbar item.
13085 * @return The @p item priority, or @c 0 on failure.
13087 * @see elm_toolbar_item_priority_set() for details.
13091 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13094 * Get the label of item.
13096 * @param item The item of toolbar.
13097 * @return The label of item.
13099 * The return value is a pointer to the label associated to @p item when
13100 * it was created, with function elm_toolbar_item_append() or similar,
13102 * with function elm_toolbar_item_label_set. If no label
13103 * was passed as argument, it will return @c NULL.
13105 * @see elm_toolbar_item_label_set() for more details.
13106 * @see elm_toolbar_item_append()
13110 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13113 * Set the label of item.
13115 * @param item The item of toolbar.
13116 * @param text The label of item.
13118 * The label to be displayed by the item.
13119 * Label will be placed at icons bottom (if set).
13121 * If a label was passed as argument on item creation, with function
13122 * elm_toolbar_item_append() or similar, it will be already
13123 * displayed by the item.
13125 * @see elm_toolbar_item_label_get()
13126 * @see elm_toolbar_item_append()
13130 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13133 * Return the data associated with a given toolbar widget item.
13135 * @param item The toolbar widget item handle.
13136 * @return The data associated with @p item.
13138 * @see elm_toolbar_item_data_set()
13142 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13145 * Set the data associated with a given toolbar widget item.
13147 * @param item The toolbar widget item handle.
13148 * @param data The new data pointer to set to @p item.
13150 * This sets new item data on @p item.
13152 * @warning The old data pointer won't be touched by this function, so
13153 * the user had better to free that old data himself/herself.
13157 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13160 * Returns a pointer to a toolbar item by its label.
13162 * @param obj The toolbar object.
13163 * @param label The label of the item to find.
13165 * @return The pointer to the toolbar item matching @p label or @c NULL
13170 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13173 * Get whether the @p item is selected or not.
13175 * @param item The toolbar item.
13176 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13177 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13179 * @see elm_toolbar_selected_item_set() for details.
13180 * @see elm_toolbar_item_selected_get()
13184 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13187 * Set the selected state of an item.
13189 * @param item The toolbar item
13190 * @param selected The selected state
13192 * This sets the selected state of the given item @p it.
13193 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13195 * If a new item is selected the previosly selected will be unselected.
13196 * Previoulsy selected item can be get with function
13197 * elm_toolbar_selected_item_get().
13199 * Selected items will be highlighted.
13201 * @see elm_toolbar_item_selected_get()
13202 * @see elm_toolbar_selected_item_get()
13206 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13209 * Get the selected item.
13211 * @param obj The toolbar object.
13212 * @return The selected toolbar item.
13214 * The selected item can be unselected with function
13215 * elm_toolbar_item_selected_set().
13217 * The selected item always will be highlighted on toolbar.
13219 * @see elm_toolbar_selected_items_get()
13223 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13226 * Set the icon associated with @p item.
13228 * @param obj The parent of this item.
13229 * @param item The toolbar item.
13230 * @param icon A string with icon name or the absolute path of an image file.
13232 * Toolbar will load icon image from fdo or current theme.
13233 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13234 * If an absolute path is provided it will load it direct from a file.
13236 * @see elm_toolbar_icon_order_lookup_set()
13237 * @see elm_toolbar_icon_order_lookup_get()
13241 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13244 * Get the string used to set the icon of @p item.
13246 * @param item The toolbar item.
13247 * @return The string associated with the icon object.
13249 * @see elm_toolbar_item_icon_set() for details.
13253 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13256 * Delete them item from the toolbar.
13258 * @param item The item of toolbar to be deleted.
13260 * @see elm_toolbar_item_append()
13261 * @see elm_toolbar_item_del_cb_set()
13265 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13268 * Set the function called when a toolbar item is freed.
13270 * @param item The item to set the callback on.
13271 * @param func The function called.
13273 * If there is a @p func, then it will be called prior item's memory release.
13274 * That will be called with the following arguments:
13276 * @li item's Evas object;
13279 * This way, a data associated to a toolbar item could be properly freed.
13283 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13286 * Get a value whether toolbar item is disabled or not.
13288 * @param item The item.
13289 * @return The disabled state.
13291 * @see elm_toolbar_item_disabled_set() for more details.
13295 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13298 * Sets the disabled/enabled state of a toolbar item.
13300 * @param item The item.
13301 * @param disabled The disabled state.
13303 * A disabled item cannot be selected or unselected. It will also
13304 * change its appearance (generally greyed out). This sets the
13305 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13310 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13313 * Set or unset item as a separator.
13315 * @param item The toolbar item.
13316 * @param setting @c EINA_TRUE to set item @p item as separator or
13317 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13319 * Items aren't set as separator by default.
13321 * If set as separator it will display separator theme, so won't display
13324 * @see elm_toolbar_item_separator_get()
13328 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13331 * Get a value whether item is a separator or not.
13333 * @param item The toolbar item.
13334 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13335 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13337 * @see elm_toolbar_item_separator_set() for details.
13341 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13344 * Set the shrink state of toolbar @p obj.
13346 * @param obj The toolbar object.
13347 * @param shrink_mode Toolbar's items display behavior.
13349 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13350 * but will enforce a minimun size so all the items will fit, won't scroll
13351 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13352 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13353 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13357 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13360 * Get the shrink mode of toolbar @p obj.
13362 * @param obj The toolbar object.
13363 * @return Toolbar's items display behavior.
13365 * @see elm_toolbar_mode_shrink_set() for details.
13369 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13372 * Enable/disable homogenous mode.
13374 * @param obj The toolbar object
13375 * @param homogeneous Assume the items within the toolbar are of the
13376 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13378 * This will enable the homogeneous mode where items are of the same size.
13379 * @see elm_toolbar_homogeneous_get()
13383 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13386 * Get whether the homogenous mode is enabled.
13388 * @param obj The toolbar object.
13389 * @return Assume the items within the toolbar are of the same height
13390 * and width (EINA_TRUE = on, EINA_FALSE = off).
13392 * @see elm_toolbar_homogeneous_set()
13396 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13399 * Enable/disable homogenous mode.
13401 * @param obj The toolbar object
13402 * @param homogeneous Assume the items within the toolbar are of the
13403 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13405 * This will enable the homogeneous mode where items are of the same size.
13406 * @see elm_toolbar_homogeneous_get()
13408 * @deprecated use elm_toolbar_homogeneous_set() instead.
13412 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13415 * Get whether the homogenous mode is enabled.
13417 * @param obj The toolbar object.
13418 * @return Assume the items within the toolbar are of the same height
13419 * and width (EINA_TRUE = on, EINA_FALSE = off).
13421 * @see elm_toolbar_homogeneous_set()
13422 * @deprecated use elm_toolbar_homogeneous_get() instead.
13426 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13429 * Set the parent object of the toolbar items' menus.
13431 * @param obj The toolbar object.
13432 * @param parent The parent of the menu objects.
13434 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13436 * For more details about setting the parent for toolbar menus, see
13437 * elm_menu_parent_set().
13439 * @see elm_menu_parent_set() for details.
13440 * @see elm_toolbar_item_menu_set() for details.
13444 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13447 * Get the parent object of the toolbar items' menus.
13449 * @param obj The toolbar object.
13450 * @return The parent of the menu objects.
13452 * @see elm_toolbar_menu_parent_set() for details.
13456 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13459 * Set the alignment of the items.
13461 * @param obj The toolbar object.
13462 * @param align The new alignment, a float between <tt> 0.0 </tt>
13463 * and <tt> 1.0 </tt>.
13465 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13466 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13469 * Centered items by default.
13471 * @see elm_toolbar_align_get()
13475 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13478 * Get the alignment of the items.
13480 * @param obj The toolbar object.
13481 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13484 * @see elm_toolbar_align_set() for details.
13488 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13491 * Set whether the toolbar item opens a menu.
13493 * @param item The toolbar item.
13494 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13496 * A toolbar item can be set to be a menu, using this function.
13498 * Once it is set to be a menu, it can be manipulated through the
13499 * menu-like function elm_toolbar_menu_parent_set() and the other
13500 * elm_menu functions, using the Evas_Object @c menu returned by
13501 * elm_toolbar_item_menu_get().
13503 * So, items to be displayed in this item's menu should be added with
13504 * elm_menu_item_add().
13506 * The following code exemplifies the most basic usage:
13508 * tb = elm_toolbar_add(win)
13509 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13510 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13511 * elm_toolbar_menu_parent_set(tb, win);
13512 * menu = elm_toolbar_item_menu_get(item);
13513 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13514 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13518 * @see elm_toolbar_item_menu_get()
13522 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13525 * Get toolbar item's menu.
13527 * @param item The toolbar item.
13528 * @return Item's menu object or @c NULL on failure.
13530 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13531 * this function will set it.
13533 * @see elm_toolbar_item_menu_set() for details.
13537 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13540 * Add a new state to @p item.
13542 * @param item The item.
13543 * @param icon A string with icon name or the absolute path of an image file.
13544 * @param label The label of the new state.
13545 * @param func The function to call when the item is clicked when this
13546 * state is selected.
13547 * @param data The data to associate with the state.
13548 * @return The toolbar item state, or @c NULL upon failure.
13550 * Toolbar will load icon image from fdo or current theme.
13551 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13552 * If an absolute path is provided it will load it direct from a file.
13554 * States created with this function can be removed with
13555 * elm_toolbar_item_state_del().
13557 * @see elm_toolbar_item_state_del()
13558 * @see elm_toolbar_item_state_sel()
13559 * @see elm_toolbar_item_state_get()
13563 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);
13566 * Delete a previoulsy added state to @p item.
13568 * @param item The toolbar item.
13569 * @param state The state to be deleted.
13570 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13572 * @see elm_toolbar_item_state_add()
13574 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13577 * Set @p state as the current state of @p it.
13579 * @param it The item.
13580 * @param state The state to use.
13581 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13583 * If @p state is @c NULL, it won't select any state and the default item's
13584 * icon and label will be used. It's the same behaviour than
13585 * elm_toolbar_item_state_unser().
13587 * @see elm_toolbar_item_state_unset()
13591 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13594 * Unset the state of @p it.
13596 * @param it The item.
13598 * The default icon and label from this item will be displayed.
13600 * @see elm_toolbar_item_state_set() for more details.
13604 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13607 * Get the current state of @p it.
13609 * @param item The item.
13610 * @return The selected state or @c NULL if none is selected or on failure.
13612 * @see elm_toolbar_item_state_set() for details.
13613 * @see elm_toolbar_item_state_unset()
13614 * @see elm_toolbar_item_state_add()
13618 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13621 * Get the state after selected state in toolbar's @p item.
13623 * @param it The toolbar item to change state.
13624 * @return The state after current state, or @c NULL on failure.
13626 * If last state is selected, this function will return first state.
13628 * @see elm_toolbar_item_state_set()
13629 * @see elm_toolbar_item_state_add()
13633 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13636 * Get the state before selected state in toolbar's @p item.
13638 * @param it The toolbar item to change state.
13639 * @return The state before current state, or @c NULL on failure.
13641 * If first state is selected, this function will return last state.
13643 * @see elm_toolbar_item_state_set()
13644 * @see elm_toolbar_item_state_add()
13648 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13651 * Set the text to be shown in a given toolbar item's tooltips.
13653 * @param item Target item.
13654 * @param text The text to set in the content.
13656 * Setup the text as tooltip to object. The item can have only one tooltip,
13657 * so any previous tooltip data - set with this function or
13658 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13660 * @see elm_object_tooltip_text_set() for more details.
13664 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13667 * Set the content to be shown in the tooltip item.
13669 * Setup the tooltip to item. The item can have only one tooltip,
13670 * so any previous tooltip data is removed. @p func(with @p data) will
13671 * be called every time that need show the tooltip and it should
13672 * return a valid Evas_Object. This object is then managed fully by
13673 * tooltip system and is deleted when the tooltip is gone.
13675 * @param item the toolbar item being attached a tooltip.
13676 * @param func the function used to create the tooltip contents.
13677 * @param data what to provide to @a func as callback data/context.
13678 * @param del_cb called when data is not needed anymore, either when
13679 * another callback replaces @a func, the tooltip is unset with
13680 * elm_toolbar_item_tooltip_unset() or the owner @a item
13681 * dies. This callback receives as the first parameter the
13682 * given @a data, and @c event_info is the item.
13684 * @see elm_object_tooltip_content_cb_set() for more details.
13688 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);
13691 * Unset tooltip from item.
13693 * @param item toolbar item to remove previously set tooltip.
13695 * Remove tooltip from item. The callback provided as del_cb to
13696 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13697 * it is not used anymore.
13699 * @see elm_object_tooltip_unset() for more details.
13700 * @see elm_toolbar_item_tooltip_content_cb_set()
13704 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13707 * Sets a different style for this item tooltip.
13709 * @note before you set a style you should define a tooltip with
13710 * elm_toolbar_item_tooltip_content_cb_set() or
13711 * elm_toolbar_item_tooltip_text_set()
13713 * @param item toolbar item with tooltip already set.
13714 * @param style the theme style to use (default, transparent, ...)
13716 * @see elm_object_tooltip_style_set() for more details.
13720 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13723 * Get the style for this item tooltip.
13725 * @param item toolbar item with tooltip already set.
13726 * @return style the theme style in use, defaults to "default". If the
13727 * object does not have a tooltip set, then NULL is returned.
13729 * @see elm_object_tooltip_style_get() for more details.
13730 * @see elm_toolbar_item_tooltip_style_set()
13734 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13737 * Set the type of mouse pointer/cursor decoration to be shown,
13738 * when the mouse pointer is over the given toolbar widget item
13740 * @param item toolbar item to customize cursor on
13741 * @param cursor the cursor type's name
13743 * This function works analogously as elm_object_cursor_set(), but
13744 * here the cursor's changing area is restricted to the item's
13745 * area, and not the whole widget's. Note that that item cursors
13746 * have precedence over widget cursors, so that a mouse over an
13747 * item with custom cursor set will always show @b that cursor.
13749 * If this function is called twice for an object, a previously set
13750 * cursor will be unset on the second call.
13752 * @see elm_object_cursor_set()
13753 * @see elm_toolbar_item_cursor_get()
13754 * @see elm_toolbar_item_cursor_unset()
13758 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13761 * Get the type of mouse pointer/cursor decoration set to be shown,
13762 * when the mouse pointer is over the given toolbar widget item
13764 * @param item toolbar item with custom cursor set
13765 * @return the cursor type's name or @c NULL, if no custom cursors
13766 * were set to @p item (and on errors)
13768 * @see elm_object_cursor_get()
13769 * @see elm_toolbar_item_cursor_set()
13770 * @see elm_toolbar_item_cursor_unset()
13774 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13777 * Unset any custom mouse pointer/cursor decoration set to be
13778 * shown, when the mouse pointer is over the given toolbar widget
13779 * item, thus making it show the @b default cursor again.
13781 * @param item a toolbar item
13783 * Use this call to undo any custom settings on this item's cursor
13784 * decoration, bringing it back to defaults (no custom style set).
13786 * @see elm_object_cursor_unset()
13787 * @see elm_toolbar_item_cursor_set()
13791 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13794 * Set a different @b style for a given custom cursor set for a
13797 * @param item toolbar item with custom cursor set
13798 * @param style the <b>theme style</b> to use (e.g. @c "default",
13799 * @c "transparent", etc)
13801 * This function only makes sense when one is using custom mouse
13802 * cursor decorations <b>defined in a theme file</b>, which can have,
13803 * given a cursor name/type, <b>alternate styles</b> on it. It
13804 * works analogously as elm_object_cursor_style_set(), but here
13805 * applyed only to toolbar item objects.
13807 * @warning Before you set a cursor style you should have definen a
13808 * custom cursor previously on the item, with
13809 * elm_toolbar_item_cursor_set()
13811 * @see elm_toolbar_item_cursor_engine_only_set()
13812 * @see elm_toolbar_item_cursor_style_get()
13816 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13819 * Get the current @b style set for a given toolbar item's custom
13822 * @param item toolbar item with custom cursor set.
13823 * @return style the cursor style in use. If the object does not
13824 * have a cursor set, then @c NULL is returned.
13826 * @see elm_toolbar_item_cursor_style_set() for more details
13830 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13833 * Set if the (custom)cursor for a given toolbar item should be
13834 * searched in its theme, also, or should only rely on the
13835 * rendering engine.
13837 * @param item item with custom (custom) cursor already set on
13838 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13839 * only on those provided by the rendering engine, @c EINA_FALSE to
13840 * have them searched on the widget's theme, as well.
13842 * @note This call is of use only if you've set a custom cursor
13843 * for toolbar items, with elm_toolbar_item_cursor_set().
13845 * @note By default, cursors will only be looked for between those
13846 * provided by the rendering engine.
13850 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13853 * Get if the (custom) cursor for a given toolbar item is being
13854 * searched in its theme, also, or is only relying on the rendering
13857 * @param item a toolbar item
13858 * @return @c EINA_TRUE, if cursors are being looked for only on
13859 * those provided by the rendering engine, @c EINA_FALSE if they
13860 * are being searched on the widget's theme, as well.
13862 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13866 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13869 * Change a toolbar's orientation
13870 * @param obj The toolbar object
13871 * @param vertical If @c EINA_TRUE, the toolbar is vertical
13872 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13875 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13878 * Get a toolbar's orientation
13879 * @param obj The toolbar object
13880 * @return If @c EINA_TRUE, the toolbar is vertical
13881 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13884 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13891 * @defgroup Tooltips Tooltips
13893 * The Tooltip is an (internal, for now) smart object used to show a
13894 * content in a frame on mouse hover of objects(or widgets), with
13895 * tips/information about them.
13900 EAPI double elm_tooltip_delay_get(void);
13901 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
13902 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13903 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13904 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13905 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);
13906 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13907 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13908 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13909 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13910 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13917 * @defgroup Cursors Cursors
13919 * The Elementary cursor is an internal smart object used to
13920 * customize the mouse cursor displayed over objects (or
13921 * widgets). In the most common scenario, the cursor decoration
13922 * comes from the graphical @b engine Elementary is running
13923 * on. Those engines may provide different decorations for cursors,
13924 * and Elementary provides functions to choose them (think of X11
13925 * cursors, as an example).
13927 * There's also the possibility of, besides using engine provided
13928 * cursors, also use ones coming from Edje theming files. Both
13929 * globally and per widget, Elementary makes it possible for one to
13930 * make the cursors lookup to be held on engines only or on
13931 * Elementary's theme file, too.
13937 * Set the cursor to be shown when mouse is over the object
13939 * Set the cursor that will be displayed when mouse is over the
13940 * object. The object can have only one cursor set to it, so if
13941 * this function is called twice for an object, the previous set
13943 * If using X cursors, a definition of all the valid cursor names
13944 * is listed on Elementary_Cursors.h. If an invalid name is set
13945 * the default cursor will be used.
13947 * @param obj the object being set a cursor.
13948 * @param cursor the cursor name to be used.
13952 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13955 * Get the cursor to be shown when mouse is over the object
13957 * @param obj an object with cursor already set.
13958 * @return the cursor name.
13962 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13965 * Unset cursor for object
13967 * Unset cursor for object, and set the cursor to default if the mouse
13968 * was over this object.
13970 * @param obj Target object
13971 * @see elm_object_cursor_set()
13975 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13978 * Sets a different style for this object cursor.
13980 * @note before you set a style you should define a cursor with
13981 * elm_object_cursor_set()
13983 * @param obj an object with cursor already set.
13984 * @param style the theme style to use (default, transparent, ...)
13988 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13991 * Get the style for this object cursor.
13993 * @param obj an object with cursor already set.
13994 * @return style the theme style in use, defaults to "default". If the
13995 * object does not have a cursor set, then NULL is returned.
13999 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14002 * Set if the cursor set should be searched on the theme or should use
14003 * the provided by the engine, only.
14005 * @note before you set if should look on theme you should define a cursor
14006 * with elm_object_cursor_set(). By default it will only look for cursors
14007 * provided by the engine.
14009 * @param obj an object with cursor already set.
14010 * @param engine_only boolean to define it cursors should be looked only
14011 * between the provided by the engine or searched on widget's theme as well.
14015 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14018 * Get the cursor engine only usage for this object cursor.
14020 * @param obj an object with cursor already set.
14021 * @return engine_only boolean to define it cursors should be
14022 * looked only between the provided by the engine or searched on
14023 * widget's theme as well. If the object does not have a cursor
14024 * set, then EINA_FALSE is returned.
14028 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14031 * Get the configured cursor engine only usage
14033 * This gets the globally configured exclusive usage of engine cursors.
14035 * @return 1 if only engine cursors should be used
14038 EAPI int elm_cursor_engine_only_get(void);
14041 * Set the configured cursor engine only usage
14043 * This sets the globally configured exclusive usage of engine cursors.
14044 * It won't affect cursors set before changing this value.
14046 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14047 * look for them on theme before.
14048 * @return EINA_TRUE if value is valid and setted (0 or 1)
14051 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14058 * @defgroup Menu Menu
14060 * @image html img/widget/menu/preview-00.png
14061 * @image latex img/widget/menu/preview-00.eps
14063 * A menu is a list of items displayed above its parent. When the menu is
14064 * showing its parent is darkened. Each item can have a sub-menu. The menu
14065 * object can be used to display a menu on a right click event, in a toolbar,
14068 * Signals that you can add callbacks for are:
14069 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14070 * event_info is NULL.
14072 * @see @ref tutorial_menu
14075 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14077 * @brief Add a new menu to the parent
14079 * @param parent The parent object.
14080 * @return The new object or NULL if it cannot be created.
14082 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14084 * @brief Set the parent for the given menu widget
14086 * @param obj The menu object.
14087 * @param parent The new parent.
14089 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14091 * @brief Get the parent for the given menu widget
14093 * @param obj The menu object.
14094 * @return The parent.
14096 * @see elm_menu_parent_set()
14098 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14100 * @brief Move the menu to a new position
14102 * @param obj The menu object.
14103 * @param x The new position.
14104 * @param y The new position.
14106 * Sets the top-left position of the menu to (@p x,@p y).
14108 * @note @p x and @p y coordinates are relative to parent.
14110 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14112 * @brief Close a opened menu
14114 * @param obj the menu object
14117 * Hides the menu and all it's sub-menus.
14119 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14121 * @brief Returns a list of @p item's items.
14123 * @param obj The menu object
14124 * @return An Eina_List* of @p item's items
14126 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14128 * @brief Get the Evas_Object of an Elm_Menu_Item
14130 * @param item The menu item object.
14131 * @return The edje object containing the swallowed content
14133 * @warning Don't manipulate this object!
14135 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14137 * @brief Add an item at the end of the given menu widget
14139 * @param obj The menu object.
14140 * @param parent The parent menu item (optional)
14141 * @param icon A icon display on the item. The icon will be destryed by the menu.
14142 * @param label The label of the item.
14143 * @param func Function called when the user select the item.
14144 * @param data Data sent by the callback.
14145 * @return Returns the new item.
14147 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);
14149 * @brief Add an object swallowed in an item at the end of the given menu
14152 * @param obj The menu object.
14153 * @param parent The parent menu item (optional)
14154 * @param subobj The object to swallow
14155 * @param func Function called when the user select the item.
14156 * @param data Data sent by the callback.
14157 * @return Returns the new item.
14159 * Add an evas object as an item to the menu.
14161 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);
14163 * @brief Set the label of a menu item
14165 * @param item The menu item object.
14166 * @param label The label to set for @p item
14168 * @warning Don't use this funcion on items created with
14169 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14171 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14173 * @brief Get the label of a menu item
14175 * @param item The menu item object.
14176 * @return The label of @p item
14178 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14180 * @brief Set the icon of a menu item to the standard icon with name @p icon
14182 * @param item The menu item object.
14183 * @param icon The icon object to set for the content of @p item
14185 * Once this icon is set, any previously set icon will be deleted.
14187 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14189 * @brief Get the string representation from the icon of a menu item
14191 * @param item The menu item object.
14192 * @return The string representation of @p item's icon or NULL
14194 * @see elm_menu_item_object_icon_name_set()
14196 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14198 * @brief Set the content object of a menu item
14200 * @param item The menu item object
14201 * @param The content object or NULL
14202 * @return EINA_TRUE on success, else EINA_FALSE
14204 * Use this function to change the object swallowed by a menu item, deleting
14205 * any previously swallowed object.
14207 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14209 * @brief Get the content object of a menu item
14211 * @param item The menu item object
14212 * @return The content object or NULL
14213 * @note If @p item was added with elm_menu_item_add_object, this
14214 * function will return the object passed, else it will return the
14217 * @see elm_menu_item_object_content_set()
14219 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14221 * @brief Set the selected state of @p item.
14223 * @param item The menu item object.
14224 * @param selected The selected/unselected state of the item
14226 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14228 * @brief Get the selected state of @p item.
14230 * @param item The menu item object.
14231 * @return The selected/unselected state of the item
14233 * @see elm_menu_item_selected_set()
14235 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14237 * @brief Set the disabled state of @p item.
14239 * @param item The menu item object.
14240 * @param disabled The enabled/disabled state of the item
14242 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14244 * @brief Get the disabled state of @p item.
14246 * @param item The menu item object.
14247 * @return The enabled/disabled state of the item
14249 * @see elm_menu_item_disabled_set()
14251 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14253 * @brief Add a separator item to menu @p obj under @p parent.
14255 * @param obj The menu object
14256 * @param parent The item to add the separator under
14257 * @return The created item or NULL on failure
14259 * This is item is a @ref Separator.
14261 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14263 * @brief Returns whether @p item is a separator.
14265 * @param item The item to check
14266 * @return If true, @p item is a separator
14268 * @see elm_menu_item_separator_add()
14270 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14272 * @brief Deletes an item from the menu.
14274 * @param item The item to delete.
14276 * @see elm_menu_item_add()
14278 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14280 * @brief Set the function called when a menu item is deleted.
14282 * @param item The item to set the callback on
14283 * @param func The function called
14285 * @see elm_menu_item_add()
14286 * @see elm_menu_item_del()
14288 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14290 * @brief Returns the data associated with menu item @p item.
14292 * @param item The item
14293 * @return The data associated with @p item or NULL if none was set.
14295 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14297 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14299 * @brief Sets the data to be associated with menu item @p item.
14301 * @param item The item
14302 * @param data The data to be associated with @p item
14304 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14306 * @brief Returns a list of @p item's subitems.
14308 * @param item The item
14309 * @return An Eina_List* of @p item's subitems
14311 * @see elm_menu_add()
14313 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14315 * @brief Get the position of a menu item
14317 * @param item The menu item
14318 * @return The item's index
14320 * This function returns the index position of a menu item in a menu.
14321 * For a sub-menu, this number is relative to the first item in the sub-menu.
14323 * @note Index values begin with 0
14325 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14327 * @brief @brief Return a menu item's owner menu
14329 * @param item The menu item
14330 * @return The menu object owning @p item, or NULL on failure
14332 * Use this function to get the menu object owning an item.
14334 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14336 * @brief Get the selected item in the menu
14338 * @param obj The menu object
14339 * @return The selected item, or NULL if none
14341 * @see elm_menu_item_selected_get()
14342 * @see elm_menu_item_selected_set()
14344 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14346 * @brief Get the last item in the menu
14348 * @param obj The menu object
14349 * @return The last item, or NULL if none
14351 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14353 * @brief Get the first item in the menu
14355 * @param obj The menu object
14356 * @return The first item, or NULL if none
14358 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14360 * @brief Get the next item in the menu.
14362 * @param item The menu item object.
14363 * @return The item after it, or NULL if none
14365 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14367 * @brief Get the previous item in the menu.
14369 * @param item The menu item object.
14370 * @return The item before it, or NULL if none
14372 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14378 * @defgroup List List
14379 * @ingroup Elementary
14381 * @image html img/widget/list/preview-00.png
14382 * @image latex img/widget/list/preview-00.eps width=\textwidth
14384 * @image html img/list.png
14385 * @image latex img/list.eps width=\textwidth
14387 * A list widget is a container whose children are displayed vertically or
14388 * horizontally, in order, and can be selected.
14389 * The list can accept only one or multiple items selection. Also has many
14390 * modes of items displaying.
14392 * A list is a very simple type of list widget. For more robust
14393 * lists, @ref Genlist should probably be used.
14395 * Smart callbacks one can listen to:
14396 * - @c "activated" - The user has double-clicked or pressed
14397 * (enter|return|spacebar) on an item. The @c event_info parameter
14398 * is the item that was activated.
14399 * - @c "clicked,double" - The user has double-clicked an item.
14400 * The @c event_info parameter is the item that was double-clicked.
14401 * - "selected" - when the user selected an item
14402 * - "unselected" - when the user unselected an item
14403 * - "longpressed" - an item in the list is long-pressed
14404 * - "scroll,edge,top" - the list is scrolled until the top edge
14405 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14406 * - "scroll,edge,left" - the list is scrolled until the left edge
14407 * - "scroll,edge,right" - the list is scrolled until the right edge
14409 * Available styles for it:
14412 * List of examples:
14413 * @li @ref list_example_01
14414 * @li @ref list_example_02
14415 * @li @ref list_example_03
14424 * @enum _Elm_List_Mode
14425 * @typedef Elm_List_Mode
14427 * Set list's resize behavior, transverse axis scroll and
14428 * items cropping. See each mode's description for more details.
14430 * @note Default value is #ELM_LIST_SCROLL.
14432 * Values <b> don't </b> work as bitmask, only one can be choosen.
14434 * @see elm_list_mode_set()
14435 * @see elm_list_mode_get()
14439 typedef enum _Elm_List_Mode
14441 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. */
14442 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). */
14443 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. */
14444 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. */
14445 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14448 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(). */
14451 * Add a new list widget to the given parent Elementary
14452 * (container) object.
14454 * @param parent The parent object.
14455 * @return a new list widget handle or @c NULL, on errors.
14457 * This function inserts a new list widget on the canvas.
14461 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14466 * @param obj The list object
14468 * @note Call before running show() on the list object.
14469 * @warning If not called, it won't display the list properly.
14472 * li = elm_list_add(win);
14473 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14474 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14476 * evas_object_show(li);
14481 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14484 * Enable or disable multiple items selection on the list object.
14486 * @param obj The list object
14487 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14490 * Disabled by default. If disabled, the user can select a single item of
14491 * the list each time. Selected items are highlighted on list.
14492 * If enabled, many items can be selected.
14494 * If a selected item is selected again, it will be unselected.
14496 * @see elm_list_multi_select_get()
14500 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14503 * Get a value whether multiple items selection is enabled or not.
14505 * @see elm_list_multi_select_set() for details.
14507 * @param obj The list object.
14508 * @return @c EINA_TRUE means multiple items selection is enabled.
14509 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14510 * @c EINA_FALSE is returned.
14514 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14517 * Set which mode to use for the list object.
14519 * @param obj The list object
14520 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14521 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14523 * Set list's resize behavior, transverse axis scroll and
14524 * items cropping. See each mode's description for more details.
14526 * @note Default value is #ELM_LIST_SCROLL.
14528 * Only one can be set, if a previous one was set, it will be changed
14529 * by the new mode set. Bitmask won't work as well.
14531 * @see elm_list_mode_get()
14535 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14538 * Get the mode the list is at.
14540 * @param obj The list object
14541 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14542 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14544 * @note see elm_list_mode_set() for more information.
14548 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14551 * Enable or disable horizontal mode on the list object.
14553 * @param obj The list object.
14554 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14555 * disable it, i.e., to enable vertical mode.
14557 * @note Vertical mode is set by default.
14559 * On horizontal mode items are displayed on list from left to right,
14560 * instead of from top to bottom. Also, the list will scroll horizontally.
14561 * Each item will presents left icon on top and right icon, or end, at
14564 * @see elm_list_horizontal_get()
14568 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14571 * Get a value whether horizontal mode is enabled or not.
14573 * @param obj The list object.
14574 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14575 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14576 * @c EINA_FALSE is returned.
14578 * @see elm_list_horizontal_set() for details.
14582 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14585 * Enable or disable always select mode on the list object.
14587 * @param obj The list object
14588 * @param always_select @c EINA_TRUE to enable always select mode or
14589 * @c EINA_FALSE to disable it.
14591 * @note Always select mode is disabled by default.
14593 * Default behavior of list items is to only call its callback function
14594 * the first time it's pressed, i.e., when it is selected. If a selected
14595 * item is pressed again, and multi-select is disabled, it won't call
14596 * this function (if multi-select is enabled it will unselect the item).
14598 * If always select is enabled, it will call the callback function
14599 * everytime a item is pressed, so it will call when the item is selected,
14600 * and again when a selected item is pressed.
14602 * @see elm_list_always_select_mode_get()
14603 * @see elm_list_multi_select_set()
14607 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14610 * Get a value whether always select mode is enabled or not, meaning that
14611 * an item will always call its callback function, even if already selected.
14613 * @param obj The list object
14614 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14615 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14616 * @c EINA_FALSE is returned.
14618 * @see elm_list_always_select_mode_set() for details.
14622 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14625 * Set bouncing behaviour when the scrolled content reaches an edge.
14627 * Tell the internal scroller object whether it should bounce or not
14628 * when it reaches the respective edges for each axis.
14630 * @param obj The list object
14631 * @param h_bounce Whether to bounce or not in the horizontal axis.
14632 * @param v_bounce Whether to bounce or not in the vertical axis.
14634 * @see elm_scroller_bounce_set()
14638 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14641 * Get the bouncing behaviour of the internal scroller.
14643 * Get whether the internal scroller should bounce when the edge of each
14644 * axis is reached scrolling.
14646 * @param obj The list object.
14647 * @param h_bounce Pointer where to store the bounce state of the horizontal
14649 * @param v_bounce Pointer where to store the bounce state of the vertical
14652 * @see elm_scroller_bounce_get()
14653 * @see elm_list_bounce_set()
14657 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14660 * Set the scrollbar policy.
14662 * @param obj The list object
14663 * @param policy_h Horizontal scrollbar policy.
14664 * @param policy_v Vertical scrollbar policy.
14666 * This sets the scrollbar visibility policy for the given scroller.
14667 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14668 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14669 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14670 * This applies respectively for the horizontal and vertical scrollbars.
14672 * The both are disabled by default, i.e., are set to
14673 * #ELM_SCROLLER_POLICY_OFF.
14677 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14680 * Get the scrollbar policy.
14682 * @see elm_list_scroller_policy_get() for details.
14684 * @param obj The list object.
14685 * @param policy_h Pointer where to store horizontal scrollbar policy.
14686 * @param policy_v Pointer where to store vertical scrollbar policy.
14690 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);
14693 * Append a new item to the list object.
14695 * @param obj The list object.
14696 * @param label The label of the list item.
14697 * @param icon The icon object to use for the left side of the item. An
14698 * icon can be any Evas object, but usually it is an icon created
14699 * with elm_icon_add().
14700 * @param end The icon object to use for the right side of the item. An
14701 * icon can be any Evas object.
14702 * @param func The function to call when the item is clicked.
14703 * @param data The data to associate with the item for related callbacks.
14705 * @return The created item or @c NULL upon failure.
14707 * A new item will be created and appended to the list, i.e., will
14708 * be set as @b last item.
14710 * Items created with this method can be deleted with
14711 * elm_list_item_del().
14713 * Associated @p data can be properly freed when item is deleted if a
14714 * callback function is set with elm_list_item_del_cb_set().
14716 * If a function is passed as argument, it will be called everytime this item
14717 * is selected, i.e., the user clicks over an unselected item.
14718 * If always select is enabled it will call this function every time
14719 * user clicks over an item (already selected or not).
14720 * If such function isn't needed, just passing
14721 * @c NULL as @p func is enough. The same should be done for @p data.
14723 * Simple example (with no function callback or data associated):
14725 * li = elm_list_add(win);
14726 * ic = elm_icon_add(win);
14727 * elm_icon_file_set(ic, "path/to/image", NULL);
14728 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14729 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14731 * evas_object_show(li);
14734 * @see elm_list_always_select_mode_set()
14735 * @see elm_list_item_del()
14736 * @see elm_list_item_del_cb_set()
14737 * @see elm_list_clear()
14738 * @see elm_icon_add()
14742 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);
14745 * Prepend a new item to the list object.
14747 * @param obj The list object.
14748 * @param label The label of the list item.
14749 * @param icon The icon object to use for the left side of the item. An
14750 * icon can be any Evas object, but usually it is an icon created
14751 * with elm_icon_add().
14752 * @param end The icon object to use for the right side of the item. An
14753 * icon can be any Evas object.
14754 * @param func The function to call when the item is clicked.
14755 * @param data The data to associate with the item for related callbacks.
14757 * @return The created item or @c NULL upon failure.
14759 * A new item will be created and prepended to the list, i.e., will
14760 * be set as @b first item.
14762 * Items created with this method can be deleted with
14763 * elm_list_item_del().
14765 * Associated @p data can be properly freed when item is deleted if a
14766 * callback function is set with elm_list_item_del_cb_set().
14768 * If a function is passed as argument, it will be called everytime this item
14769 * is selected, i.e., the user clicks over an unselected item.
14770 * If always select is enabled it will call this function every time
14771 * user clicks over an item (already selected or not).
14772 * If such function isn't needed, just passing
14773 * @c NULL as @p func is enough. The same should be done for @p data.
14775 * @see elm_list_item_append() for a simple code example.
14776 * @see elm_list_always_select_mode_set()
14777 * @see elm_list_item_del()
14778 * @see elm_list_item_del_cb_set()
14779 * @see elm_list_clear()
14780 * @see elm_icon_add()
14784 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);
14787 * Insert a new item into the list object before item @p before.
14789 * @param obj The list object.
14790 * @param before The list item to insert before.
14791 * @param label The label of the list item.
14792 * @param icon The icon object to use for the left side of the item. An
14793 * icon can be any Evas object, but usually it is an icon created
14794 * with elm_icon_add().
14795 * @param end The icon object to use for the right side of the item. An
14796 * icon can be any Evas object.
14797 * @param func The function to call when the item is clicked.
14798 * @param data The data to associate with the item for related callbacks.
14800 * @return The created item or @c NULL upon failure.
14802 * A new item will be created and added to the list. Its position in
14803 * this list will be just before item @p before.
14805 * Items created with this method can be deleted with
14806 * elm_list_item_del().
14808 * Associated @p data can be properly freed when item is deleted if a
14809 * callback function is set with elm_list_item_del_cb_set().
14811 * If a function is passed as argument, it will be called everytime this item
14812 * is selected, i.e., the user clicks over an unselected item.
14813 * If always select is enabled it will call this function every time
14814 * user clicks over an item (already selected or not).
14815 * If such function isn't needed, just passing
14816 * @c NULL as @p func is enough. The same should be done for @p data.
14818 * @see elm_list_item_append() for a simple code example.
14819 * @see elm_list_always_select_mode_set()
14820 * @see elm_list_item_del()
14821 * @see elm_list_item_del_cb_set()
14822 * @see elm_list_clear()
14823 * @see elm_icon_add()
14827 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);
14830 * Insert a new item into the list object after item @p after.
14832 * @param obj The list object.
14833 * @param after The list item to insert after.
14834 * @param label The label of the list item.
14835 * @param icon The icon object to use for the left side of the item. An
14836 * icon can be any Evas object, but usually it is an icon created
14837 * with elm_icon_add().
14838 * @param end The icon object to use for the right side of the item. An
14839 * icon can be any Evas object.
14840 * @param func The function to call when the item is clicked.
14841 * @param data The data to associate with the item for related callbacks.
14843 * @return The created item or @c NULL upon failure.
14845 * A new item will be created and added to the list. Its position in
14846 * this list will be just after item @p after.
14848 * Items created with this method can be deleted with
14849 * elm_list_item_del().
14851 * Associated @p data can be properly freed when item is deleted if a
14852 * callback function is set with elm_list_item_del_cb_set().
14854 * If a function is passed as argument, it will be called everytime this item
14855 * is selected, i.e., the user clicks over an unselected item.
14856 * If always select is enabled it will call this function every time
14857 * user clicks over an item (already selected or not).
14858 * If such function isn't needed, just passing
14859 * @c NULL as @p func is enough. The same should be done for @p data.
14861 * @see elm_list_item_append() for a simple code example.
14862 * @see elm_list_always_select_mode_set()
14863 * @see elm_list_item_del()
14864 * @see elm_list_item_del_cb_set()
14865 * @see elm_list_clear()
14866 * @see elm_icon_add()
14870 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);
14873 * Insert a new item into the sorted list object.
14875 * @param obj The list object.
14876 * @param label The label of the list item.
14877 * @param icon The icon object to use for the left side of the item. An
14878 * icon can be any Evas object, but usually it is an icon created
14879 * with elm_icon_add().
14880 * @param end The icon object to use for the right side of the item. An
14881 * icon can be any Evas object.
14882 * @param func The function to call when the item is clicked.
14883 * @param data The data to associate with the item for related callbacks.
14884 * @param cmp_func The comparing function to be used to sort list
14885 * items <b>by #Elm_List_Item item handles</b>. This function will
14886 * receive two items and compare them, returning a non-negative integer
14887 * if the second item should be place after the first, or negative value
14888 * if should be placed before.
14890 * @return The created item or @c NULL upon failure.
14892 * @note This function inserts values into a list object assuming it was
14893 * sorted and the result will be sorted.
14895 * A new item will be created and added to the list. Its position in
14896 * this list will be found comparing the new item with previously inserted
14897 * items using function @p cmp_func.
14899 * Items created with this method can be deleted with
14900 * elm_list_item_del().
14902 * Associated @p data can be properly freed when item is deleted if a
14903 * callback function is set with elm_list_item_del_cb_set().
14905 * If a function is passed as argument, it will be called everytime this item
14906 * is selected, i.e., the user clicks over an unselected item.
14907 * If always select is enabled it will call this function every time
14908 * user clicks over an item (already selected or not).
14909 * If such function isn't needed, just passing
14910 * @c NULL as @p func is enough. The same should be done for @p data.
14912 * @see elm_list_item_append() for a simple code example.
14913 * @see elm_list_always_select_mode_set()
14914 * @see elm_list_item_del()
14915 * @see elm_list_item_del_cb_set()
14916 * @see elm_list_clear()
14917 * @see elm_icon_add()
14921 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);
14924 * Remove all list's items.
14926 * @param obj The list object
14928 * @see elm_list_item_del()
14929 * @see elm_list_item_append()
14933 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14936 * Get a list of all the list items.
14938 * @param obj The list object
14939 * @return An @c Eina_List of list items, #Elm_List_Item,
14940 * or @c NULL on failure.
14942 * @see elm_list_item_append()
14943 * @see elm_list_item_del()
14944 * @see elm_list_clear()
14948 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14951 * Get the selected item.
14953 * @param obj The list object.
14954 * @return The selected list item.
14956 * The selected item can be unselected with function
14957 * elm_list_item_selected_set().
14959 * The selected item always will be highlighted on list.
14961 * @see elm_list_selected_items_get()
14965 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14968 * Return a list of the currently selected list items.
14970 * @param obj The list object.
14971 * @return An @c Eina_List of list items, #Elm_List_Item,
14972 * or @c NULL on failure.
14974 * Multiple items can be selected if multi select is enabled. It can be
14975 * done with elm_list_multi_select_set().
14977 * @see elm_list_selected_item_get()
14978 * @see elm_list_multi_select_set()
14982 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14985 * Set the selected state of an item.
14987 * @param item The list item
14988 * @param selected The selected state
14990 * This sets the selected state of the given item @p it.
14991 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14993 * If a new item is selected the previosly selected will be unselected,
14994 * unless multiple selection is enabled with elm_list_multi_select_set().
14995 * Previoulsy selected item can be get with function
14996 * elm_list_selected_item_get().
14998 * Selected items will be highlighted.
15000 * @see elm_list_item_selected_get()
15001 * @see elm_list_selected_item_get()
15002 * @see elm_list_multi_select_set()
15006 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15009 * Get whether the @p item is selected or not.
15011 * @param item The list item.
15012 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15013 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15015 * @see elm_list_selected_item_set() for details.
15016 * @see elm_list_item_selected_get()
15020 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15023 * Set or unset item as a separator.
15025 * @param it The list item.
15026 * @param setting @c EINA_TRUE to set item @p it as separator or
15027 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15029 * Items aren't set as separator by default.
15031 * If set as separator it will display separator theme, so won't display
15034 * @see elm_list_item_separator_get()
15038 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15041 * Get a value whether item is a separator or not.
15043 * @see elm_list_item_separator_set() for details.
15045 * @param it The list item.
15046 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15047 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15051 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15054 * Show @p item in the list view.
15056 * @param item The list item to be shown.
15058 * It won't animate list until item is visible. If such behavior is wanted,
15059 * use elm_list_bring_in() intead.
15063 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15066 * Bring in the given item to list view.
15068 * @param item The item.
15070 * This causes list to jump to the given item @p item and show it
15071 * (by scrolling), if it is not fully visible.
15073 * This may use animation to do so and take a period of time.
15075 * If animation isn't wanted, elm_list_item_show() can be used.
15079 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15082 * Delete them item from the list.
15084 * @param item The item of list to be deleted.
15086 * If deleting all list items is required, elm_list_clear()
15087 * should be used instead of getting items list and deleting each one.
15089 * @see elm_list_clear()
15090 * @see elm_list_item_append()
15091 * @see elm_list_item_del_cb_set()
15095 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15098 * Set the function called when a list item is freed.
15100 * @param item The item to set the callback on
15101 * @param func The function called
15103 * If there is a @p func, then it will be called prior item's memory release.
15104 * That will be called with the following arguments:
15106 * @li item's Evas object;
15109 * This way, a data associated to a list item could be properly freed.
15113 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15116 * Get the data associated to the item.
15118 * @param item The list item
15119 * @return The data associated to @p item
15121 * The return value is a pointer to data associated to @p item when it was
15122 * created, with function elm_list_item_append() or similar. If no data
15123 * was passed as argument, it will return @c NULL.
15125 * @see elm_list_item_append()
15129 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15132 * Get the left side icon associated to the item.
15134 * @param item The list item
15135 * @return The left side icon associated to @p item
15137 * The return value is a pointer to the icon associated to @p item when
15139 * created, with function elm_list_item_append() or similar, or later
15140 * with function elm_list_item_icon_set(). If no icon
15141 * was passed as argument, it will return @c NULL.
15143 * @see elm_list_item_append()
15144 * @see elm_list_item_icon_set()
15148 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15151 * Set the left side icon associated to the item.
15153 * @param item The list item
15154 * @param icon The left side icon object to associate with @p item
15156 * The icon object to use at left side of the item. An
15157 * icon can be any Evas object, but usually it is an icon created
15158 * with elm_icon_add().
15160 * Once the icon object is set, a previously set one will be deleted.
15161 * @warning Setting the same icon for two items will cause the icon to
15162 * dissapear from the first item.
15164 * If an icon was passed as argument on item creation, with function
15165 * elm_list_item_append() or similar, it will be already
15166 * associated to the item.
15168 * @see elm_list_item_append()
15169 * @see elm_list_item_icon_get()
15173 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15176 * Get the right side icon associated to the item.
15178 * @param item The list item
15179 * @return The right side icon associated to @p item
15181 * The return value is a pointer to the icon associated to @p item when
15183 * created, with function elm_list_item_append() or similar, or later
15184 * with function elm_list_item_icon_set(). If no icon
15185 * was passed as argument, it will return @c NULL.
15187 * @see elm_list_item_append()
15188 * @see elm_list_item_icon_set()
15192 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15195 * Set the right side icon associated to the item.
15197 * @param item The list item
15198 * @param end The right side icon object to associate with @p item
15200 * The icon object to use at right side of the item. An
15201 * icon can be any Evas object, but usually it is an icon created
15202 * with elm_icon_add().
15204 * Once the icon object is set, a previously set one will be deleted.
15205 * @warning Setting the same icon for two items will cause the icon to
15206 * dissapear from the first item.
15208 * If an icon was passed as argument on item creation, with function
15209 * elm_list_item_append() or similar, it will be already
15210 * associated to the item.
15212 * @see elm_list_item_append()
15213 * @see elm_list_item_end_get()
15217 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15220 * Gets the base object of the item.
15222 * @param item The list item
15223 * @return The base object associated with @p item
15225 * Base object is the @c Evas_Object that represents that item.
15229 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15232 * Get the label of item.
15234 * @param item The item of list.
15235 * @return The label of item.
15237 * The return value is a pointer to the label associated to @p item when
15238 * it was created, with function elm_list_item_append(), or later
15239 * with function elm_list_item_label_set. If no label
15240 * was passed as argument, it will return @c NULL.
15242 * @see elm_list_item_label_set() for more details.
15243 * @see elm_list_item_append()
15247 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15250 * Set the label of item.
15252 * @param item The item of list.
15253 * @param text The label of item.
15255 * The label to be displayed by the item.
15256 * Label will be placed between left and right side icons (if set).
15258 * If a label was passed as argument on item creation, with function
15259 * elm_list_item_append() or similar, it will be already
15260 * displayed by the item.
15262 * @see elm_list_item_label_get()
15263 * @see elm_list_item_append()
15267 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15271 * Get the item before @p it in list.
15273 * @param it The list item.
15274 * @return The item before @p it, or @c NULL if none or on failure.
15276 * @note If it is the first item, @c NULL will be returned.
15278 * @see elm_list_item_append()
15279 * @see elm_list_items_get()
15283 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15286 * Get the item after @p it in list.
15288 * @param it The list item.
15289 * @return The item after @p it, or @c NULL if none or on failure.
15291 * @note If it is the last item, @c NULL will be returned.
15293 * @see elm_list_item_append()
15294 * @see elm_list_items_get()
15298 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15301 * Sets the disabled/enabled state of a list item.
15303 * @param it The item.
15304 * @param disabled The disabled state.
15306 * A disabled item cannot be selected or unselected. It will also
15307 * change its appearance (generally greyed out). This sets the
15308 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15313 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15316 * Get a value whether list item is disabled or not.
15318 * @param it The item.
15319 * @return The disabled state.
15321 * @see elm_list_item_disabled_set() for more details.
15325 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15328 * Set the text to be shown in a given list item's tooltips.
15330 * @param item Target item.
15331 * @param text The text to set in the content.
15333 * Setup the text as tooltip to object. The item can have only one tooltip,
15334 * so any previous tooltip data - set with this function or
15335 * elm_list_item_tooltip_content_cb_set() - is removed.
15337 * @see elm_object_tooltip_text_set() for more details.
15341 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15345 * @brief Disable size restrictions on an object's tooltip
15346 * @param item The tooltip's anchor object
15347 * @param disable If EINA_TRUE, size restrictions are disabled
15348 * @return EINA_FALSE on failure, EINA_TRUE on success
15350 * This function allows a tooltip to expand beyond its parant window's canvas.
15351 * It will instead be limited only by the size of the display.
15353 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15355 * @brief Retrieve size restriction state of an object's tooltip
15356 * @param obj The tooltip's anchor object
15357 * @return If EINA_TRUE, size restrictions are disabled
15359 * This function returns whether a tooltip is allowed to expand beyond
15360 * its parant window's canvas.
15361 * It will instead be limited only by the size of the display.
15363 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15366 * Set the content to be shown in the tooltip item.
15368 * Setup the tooltip to item. The item can have only one tooltip,
15369 * so any previous tooltip data is removed. @p func(with @p data) will
15370 * be called every time that need show the tooltip and it should
15371 * return a valid Evas_Object. This object is then managed fully by
15372 * tooltip system and is deleted when the tooltip is gone.
15374 * @param item the list item being attached a tooltip.
15375 * @param func the function used to create the tooltip contents.
15376 * @param data what to provide to @a func as callback data/context.
15377 * @param del_cb called when data is not needed anymore, either when
15378 * another callback replaces @a func, the tooltip is unset with
15379 * elm_list_item_tooltip_unset() or the owner @a item
15380 * dies. This callback receives as the first parameter the
15381 * given @a data, and @c event_info is the item.
15383 * @see elm_object_tooltip_content_cb_set() for more details.
15387 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);
15390 * Unset tooltip from item.
15392 * @param item list item to remove previously set tooltip.
15394 * Remove tooltip from item. The callback provided as del_cb to
15395 * elm_list_item_tooltip_content_cb_set() will be called to notify
15396 * it is not used anymore.
15398 * @see elm_object_tooltip_unset() for more details.
15399 * @see elm_list_item_tooltip_content_cb_set()
15403 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15406 * Sets a different style for this item tooltip.
15408 * @note before you set a style you should define a tooltip with
15409 * elm_list_item_tooltip_content_cb_set() or
15410 * elm_list_item_tooltip_text_set()
15412 * @param item list item with tooltip already set.
15413 * @param style the theme style to use (default, transparent, ...)
15415 * @see elm_object_tooltip_style_set() for more details.
15419 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15422 * Get the style for this item tooltip.
15424 * @param item list item with tooltip already set.
15425 * @return style the theme style in use, defaults to "default". If the
15426 * object does not have a tooltip set, then NULL is returned.
15428 * @see elm_object_tooltip_style_get() for more details.
15429 * @see elm_list_item_tooltip_style_set()
15433 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15436 * Set the type of mouse pointer/cursor decoration to be shown,
15437 * when the mouse pointer is over the given list widget item
15439 * @param item list item to customize cursor on
15440 * @param cursor the cursor type's name
15442 * This function works analogously as elm_object_cursor_set(), but
15443 * here the cursor's changing area is restricted to the item's
15444 * area, and not the whole widget's. Note that that item cursors
15445 * have precedence over widget cursors, so that a mouse over an
15446 * item with custom cursor set will always show @b that cursor.
15448 * If this function is called twice for an object, a previously set
15449 * cursor will be unset on the second call.
15451 * @see elm_object_cursor_set()
15452 * @see elm_list_item_cursor_get()
15453 * @see elm_list_item_cursor_unset()
15457 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15460 * Get the type of mouse pointer/cursor decoration set to be shown,
15461 * when the mouse pointer is over the given list widget item
15463 * @param item list item with custom cursor set
15464 * @return the cursor type's name or @c NULL, if no custom cursors
15465 * were set to @p item (and on errors)
15467 * @see elm_object_cursor_get()
15468 * @see elm_list_item_cursor_set()
15469 * @see elm_list_item_cursor_unset()
15473 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15476 * Unset any custom mouse pointer/cursor decoration set to be
15477 * shown, when the mouse pointer is over the given list widget
15478 * item, thus making it show the @b default cursor again.
15480 * @param item a list item
15482 * Use this call to undo any custom settings on this item's cursor
15483 * decoration, bringing it back to defaults (no custom style set).
15485 * @see elm_object_cursor_unset()
15486 * @see elm_list_item_cursor_set()
15490 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15493 * Set a different @b style for a given custom cursor set for a
15496 * @param item list item with custom cursor set
15497 * @param style the <b>theme style</b> to use (e.g. @c "default",
15498 * @c "transparent", etc)
15500 * This function only makes sense when one is using custom mouse
15501 * cursor decorations <b>defined in a theme file</b>, which can have,
15502 * given a cursor name/type, <b>alternate styles</b> on it. It
15503 * works analogously as elm_object_cursor_style_set(), but here
15504 * applyed only to list item objects.
15506 * @warning Before you set a cursor style you should have definen a
15507 * custom cursor previously on the item, with
15508 * elm_list_item_cursor_set()
15510 * @see elm_list_item_cursor_engine_only_set()
15511 * @see elm_list_item_cursor_style_get()
15515 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15518 * Get the current @b style set for a given list item's custom
15521 * @param item list item with custom cursor set.
15522 * @return style the cursor style in use. If the object does not
15523 * have a cursor set, then @c NULL is returned.
15525 * @see elm_list_item_cursor_style_set() for more details
15529 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15532 * Set if the (custom)cursor for a given list item should be
15533 * searched in its theme, also, or should only rely on the
15534 * rendering engine.
15536 * @param item item with custom (custom) cursor already set on
15537 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15538 * only on those provided by the rendering engine, @c EINA_FALSE to
15539 * have them searched on the widget's theme, as well.
15541 * @note This call is of use only if you've set a custom cursor
15542 * for list items, with elm_list_item_cursor_set().
15544 * @note By default, cursors will only be looked for between those
15545 * provided by the rendering engine.
15549 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15552 * Get if the (custom) cursor for a given list item is being
15553 * searched in its theme, also, or is only relying on the rendering
15556 * @param item a list item
15557 * @return @c EINA_TRUE, if cursors are being looked for only on
15558 * those provided by the rendering engine, @c EINA_FALSE if they
15559 * are being searched on the widget's theme, as well.
15561 * @see elm_list_item_cursor_engine_only_set(), for more details
15565 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15572 * @defgroup Slider Slider
15573 * @ingroup Elementary
15575 * @image html img/widget/slider/preview-00.png
15576 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15578 * The slider adds a dragable “slider” widget for selecting the value of
15579 * something within a range.
15581 * A slider can be horizontal or vertical. It can contain an Icon and has a
15582 * primary label as well as a units label (that is formatted with floating
15583 * point values and thus accepts a printf-style format string, like
15584 * “%1.2f units”. There is also an indicator string that may be somewhere
15585 * else (like on the slider itself) that also accepts a format string like
15586 * units. Label, Icon Unit and Indicator strings/objects are optional.
15588 * A slider may be inverted which means values invert, with high vales being
15589 * on the left or top and low values on the right or bottom (as opposed to
15590 * normally being low on the left or top and high on the bottom and right).
15592 * The slider should have its minimum and maximum values set by the
15593 * application with elm_slider_min_max_set() and value should also be set by
15594 * the application before use with elm_slider_value_set(). The span of the
15595 * slider is its length (horizontally or vertically). This will be scaled by
15596 * the object or applications scaling factor. At any point code can query the
15597 * slider for its value with elm_slider_value_get().
15599 * Smart callbacks one can listen to:
15600 * - "changed" - Whenever the slider value is changed by the user.
15601 * - "slider,drag,start" - dragging the slider indicator around has started.
15602 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15603 * - "delay,changed" - A short time after the value is changed by the user.
15604 * This will be called only when the user stops dragging for
15605 * a very short period or when they release their
15606 * finger/mouse, so it avoids possibly expensive reactions to
15607 * the value change.
15609 * Available styles for it:
15612 * Here is an example on its usage:
15613 * @li @ref slider_example
15617 * @addtogroup Slider
15622 * Add a new slider widget to the given parent Elementary
15623 * (container) object.
15625 * @param parent The parent object.
15626 * @return a new slider widget handle or @c NULL, on errors.
15628 * This function inserts a new slider widget on the canvas.
15632 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15635 * Set the label of a given slider widget
15637 * @param obj The progress bar object
15638 * @param label The text label string, in UTF-8
15641 * @deprecated use elm_object_text_set() instead.
15643 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15646 * Get the label of a given slider widget
15648 * @param obj The progressbar object
15649 * @return The text label string, in UTF-8
15652 * @deprecated use elm_object_text_get() instead.
15654 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15657 * Set the icon object of the slider object.
15659 * @param obj The slider object.
15660 * @param icon The icon object.
15662 * On horizontal mode, icon is placed at left, and on vertical mode,
15665 * @note Once the icon object is set, a previously set one will be deleted.
15666 * If you want to keep that old content object, use the
15667 * elm_slider_icon_unset() function.
15669 * @warning If the object being set does not have minimum size hints set,
15670 * it won't get properly displayed.
15674 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15677 * Unset an icon set on a given slider widget.
15679 * @param obj The slider object.
15680 * @return The icon object that was being used, if any was set, or
15681 * @c NULL, otherwise (and on errors).
15683 * On horizontal mode, icon is placed at left, and on vertical mode,
15686 * This call will unparent and return the icon object which was set
15687 * for this widget, previously, on success.
15689 * @see elm_slider_icon_set() for more details
15690 * @see elm_slider_icon_get()
15694 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15697 * Retrieve the icon object set for a given slider widget.
15699 * @param obj The slider object.
15700 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15701 * otherwise (and on errors).
15703 * On horizontal mode, icon is placed at left, and on vertical mode,
15706 * @see elm_slider_icon_set() for more details
15707 * @see elm_slider_icon_unset()
15711 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15714 * Set the end object of the slider object.
15716 * @param obj The slider object.
15717 * @param end The end object.
15719 * On horizontal mode, end is placed at left, and on vertical mode,
15720 * placed at bottom.
15722 * @note Once the icon object is set, a previously set one will be deleted.
15723 * If you want to keep that old content object, use the
15724 * elm_slider_end_unset() function.
15726 * @warning If the object being set does not have minimum size hints set,
15727 * it won't get properly displayed.
15731 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15734 * Unset an end object set on a given slider widget.
15736 * @param obj The slider object.
15737 * @return The end object that was being used, if any was set, or
15738 * @c NULL, otherwise (and on errors).
15740 * On horizontal mode, end is placed at left, and on vertical mode,
15741 * placed at bottom.
15743 * This call will unparent and return the icon object which was set
15744 * for this widget, previously, on success.
15746 * @see elm_slider_end_set() for more details.
15747 * @see elm_slider_end_get()
15751 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15754 * Retrieve the end object set for a given slider widget.
15756 * @param obj The slider object.
15757 * @return The end object's handle, if @p obj had one set, or @c NULL,
15758 * otherwise (and on errors).
15760 * On horizontal mode, icon is placed at right, and on vertical mode,
15761 * placed at bottom.
15763 * @see elm_slider_end_set() for more details.
15764 * @see elm_slider_end_unset()
15768 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15771 * Set the (exact) length of the bar region of a given slider widget.
15773 * @param obj The slider object.
15774 * @param size The length of the slider's bar region.
15776 * This sets the minimum width (when in horizontal mode) or height
15777 * (when in vertical mode) of the actual bar area of the slider
15778 * @p obj. This in turn affects the object's minimum size. Use
15779 * this when you're not setting other size hints expanding on the
15780 * given direction (like weight and alignment hints) and you would
15781 * like it to have a specific size.
15783 * @note Icon, end, label, indicator and unit text around @p obj
15784 * will require their
15785 * own space, which will make @p obj to require more the @p size,
15788 * @see elm_slider_span_size_get()
15792 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15795 * Get the length set for the bar region of a given slider widget
15797 * @param obj The slider object.
15798 * @return The length of the slider's bar region.
15800 * If that size was not set previously, with
15801 * elm_slider_span_size_set(), this call will return @c 0.
15805 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15808 * Set the format string for the unit label.
15810 * @param obj The slider object.
15811 * @param format The format string for the unit display.
15813 * Unit label is displayed all the time, if set, after slider's bar.
15814 * In horizontal mode, at right and in vertical mode, at bottom.
15816 * If @c NULL, unit label won't be visible. If not it sets the format
15817 * string for the label text. To the label text is provided a floating point
15818 * value, so the label text can display up to 1 floating point value.
15819 * Note that this is optional.
15821 * Use a format string such as "%1.2f meters" for example, and it will
15822 * display values like: "3.14 meters" for a value equal to 3.14159.
15824 * Default is unit label disabled.
15826 * @see elm_slider_indicator_format_get()
15830 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15833 * Get the unit label format of the slider.
15835 * @param obj The slider object.
15836 * @return The unit label format string in UTF-8.
15838 * Unit label is displayed all the time, if set, after slider's bar.
15839 * In horizontal mode, at right and in vertical mode, at bottom.
15841 * @see elm_slider_unit_format_set() for more
15842 * information on how this works.
15846 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15849 * Set the format string for the indicator label.
15851 * @param obj The slider object.
15852 * @param indicator The format string for the indicator display.
15854 * The slider may display its value somewhere else then unit label,
15855 * for example, above the slider knob that is dragged around. This function
15856 * sets the format string used for this.
15858 * If @c NULL, indicator label won't be visible. If not it sets the format
15859 * string for the label text. To the label text is provided a floating point
15860 * value, so the label text can display up to 1 floating point value.
15861 * Note that this is optional.
15863 * Use a format string such as "%1.2f meters" for example, and it will
15864 * display values like: "3.14 meters" for a value equal to 3.14159.
15866 * Default is indicator label disabled.
15868 * @see elm_slider_indicator_format_get()
15872 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15875 * Get the indicator label format of the slider.
15877 * @param obj The slider object.
15878 * @return The indicator label format string in UTF-8.
15880 * The slider may display its value somewhere else then unit label,
15881 * for example, above the slider knob that is dragged around. This function
15882 * gets the format string used for this.
15884 * @see elm_slider_indicator_format_set() for more
15885 * information on how this works.
15889 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15892 * Set the format function pointer for the indicator label
15894 * @param obj The slider object.
15895 * @param func The indicator format function.
15896 * @param free_func The freeing function for the format string.
15898 * Set the callback function to format the indicator string.
15900 * @see elm_slider_indicator_format_set() for more info on how this works.
15904 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);
15907 * Set the format function pointer for the units label
15909 * @param obj The slider object.
15910 * @param func The units format function.
15911 * @param free_func The freeing function for the format string.
15913 * Set the callback function to format the indicator string.
15915 * @see elm_slider_units_format_set() for more info on how this works.
15919 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);
15922 * Set the orientation of a given slider widget.
15924 * @param obj The slider object.
15925 * @param horizontal Use @c EINA_TRUE to make @p obj to be
15926 * @b horizontal, @c EINA_FALSE to make it @b vertical.
15928 * Use this function to change how your slider is to be
15929 * disposed: vertically or horizontally.
15931 * By default it's displayed horizontally.
15933 * @see elm_slider_horizontal_get()
15937 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15940 * Retrieve the orientation of a given slider widget
15942 * @param obj The slider object.
15943 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15944 * @c EINA_FALSE if it's @b vertical (and on errors).
15946 * @see elm_slider_horizontal_set() for more details.
15950 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15953 * Set the minimum and maximum values for the slider.
15955 * @param obj The slider object.
15956 * @param min The minimum value.
15957 * @param max The maximum value.
15959 * Define the allowed range of values to be selected by the user.
15961 * If actual value is less than @p min, it will be updated to @p min. If it
15962 * is bigger then @p max, will be updated to @p max. Actual value can be
15963 * get with elm_slider_value_get().
15965 * By default, min is equal to 0.0, and max is equal to 1.0.
15967 * @warning Maximum must be greater than minimum, otherwise behavior
15970 * @see elm_slider_min_max_get()
15974 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
15977 * Get the minimum and maximum values of the slider.
15979 * @param obj The slider object.
15980 * @param min Pointer where to store the minimum value.
15981 * @param max Pointer where to store the maximum value.
15983 * @note If only one value is needed, the other pointer can be passed
15986 * @see elm_slider_min_max_set() for details.
15990 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
15993 * Set the value the slider displays.
15995 * @param obj The slider object.
15996 * @param val The value to be displayed.
15998 * Value will be presented on the unit label following format specified with
15999 * elm_slider_unit_format_set() and on indicator with
16000 * elm_slider_indicator_format_set().
16002 * @warning The value must to be between min and max values. This values
16003 * are set by elm_slider_min_max_set().
16005 * @see elm_slider_value_get()
16006 * @see elm_slider_unit_format_set()
16007 * @see elm_slider_indicator_format_set()
16008 * @see elm_slider_min_max_set()
16012 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16015 * Get the value displayed by the spinner.
16017 * @param obj The spinner object.
16018 * @return The value displayed.
16020 * @see elm_spinner_value_set() for details.
16024 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16027 * Invert a given slider widget's displaying values order
16029 * @param obj The slider object.
16030 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16031 * @c EINA_FALSE to bring it back to default, non-inverted values.
16033 * A slider may be @b inverted, in which state it gets its
16034 * values inverted, with high vales being on the left or top and
16035 * low values on the right or bottom, as opposed to normally have
16036 * the low values on the former and high values on the latter,
16037 * respectively, for horizontal and vertical modes.
16039 * @see elm_slider_inverted_get()
16043 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16046 * Get whether a given slider widget's displaying values are
16049 * @param obj The slider object.
16050 * @return @c EINA_TRUE, if @p obj has inverted values,
16051 * @c EINA_FALSE otherwise (and on errors).
16053 * @see elm_slider_inverted_set() for more details.
16057 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16060 * Set whether to enlarge slider indicator (augmented knob) or not.
16062 * @param obj The slider object.
16063 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16064 * let the knob always at default size.
16066 * By default, indicator will be bigger while dragged by the user.
16068 * @warning It won't display values set with
16069 * elm_slider_indicator_format_set() if you disable indicator.
16073 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16076 * Get whether a given slider widget's enlarging indicator or not.
16078 * @param obj The slider object.
16079 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16080 * @c EINA_FALSE otherwise (and on errors).
16082 * @see elm_slider_indicator_show_set() for details.
16086 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16093 * @addtogroup Actionslider Actionslider
16095 * @image html img/widget/actionslider/preview-00.png
16096 * @image latex img/widget/actionslider/preview-00.eps
16098 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16099 * properties. The indicator is the element the user drags to choose a label.
16100 * When the position is set with magnet, when released the indicator will be
16101 * moved to it if it's nearest the magnetized position.
16103 * @note By default all positions are set as enabled.
16105 * Signals that you can add callbacks for are:
16107 * "selected" - when user selects an enabled position (the label is passed
16110 * "pos_changed" - when the indicator reaches any of the positions("left",
16111 * "right" or "center").
16113 * See an example of actionslider usage @ref actionslider_example_page "here"
16116 typedef enum _Elm_Actionslider_Pos
16118 ELM_ACTIONSLIDER_NONE = 0,
16119 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16120 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16121 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16122 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16123 } Elm_Actionslider_Pos;
16126 * Add a new actionslider to the parent.
16128 * @param parent The parent object
16129 * @return The new actionslider object or NULL if it cannot be created
16131 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16133 * Set actionslider labels.
16135 * @param obj The actionslider object
16136 * @param left_label The label to be set on the left.
16137 * @param center_label The label to be set on the center.
16138 * @param right_label The label to be set on the right.
16139 * @deprecated use elm_object_text_set() instead.
16141 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);
16143 * Get actionslider labels.
16145 * @param obj The actionslider object
16146 * @param left_label A char** to place the left_label of @p obj into.
16147 * @param center_label A char** to place the center_label of @p obj into.
16148 * @param right_label A char** to place the right_label of @p obj into.
16149 * @deprecated use elm_object_text_set() instead.
16151 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);
16153 * Get actionslider selected label.
16155 * @param obj The actionslider object
16156 * @return The selected label
16158 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16160 * Set actionslider indicator position.
16162 * @param obj The actionslider object.
16163 * @param pos The position of the indicator.
16165 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16167 * Get actionslider indicator position.
16169 * @param obj The actionslider object.
16170 * @return The position of the indicator.
16172 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16174 * Set actionslider magnet position. To make multiple positions magnets @c or
16175 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16177 * @param obj The actionslider object.
16178 * @param pos Bit mask indicating the magnet positions.
16180 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16182 * Get actionslider magnet position.
16184 * @param obj The actionslider object.
16185 * @return The positions with magnet property.
16187 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16189 * Set actionslider enabled position. To set multiple positions as enabled @c or
16190 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16192 * @note All the positions are enabled by default.
16194 * @param obj The actionslider object.
16195 * @param pos Bit mask indicating the enabled positions.
16197 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16199 * Get actionslider enabled position.
16201 * @param obj The actionslider object.
16202 * @return The enabled positions.
16204 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16206 * Set the label used on the indicator.
16208 * @param obj The actionslider object
16209 * @param label The label to be set on the indicator.
16210 * @deprecated use elm_object_text_set() instead.
16212 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16214 * Get the label used on the indicator object.
16216 * @param obj The actionslider object
16217 * @return The indicator label
16218 * @deprecated use elm_object_text_get() instead.
16220 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16226 * @defgroup Genlist Genlist
16228 * @image html img/widget/genlist/preview-00.png
16229 * @image latex img/widget/genlist/preview-00.eps
16230 * @image html img/genlist.png
16231 * @image latex img/genlist.eps
16233 * This widget aims to have more expansive list than the simple list in
16234 * Elementary that could have more flexible items and allow many more entries
16235 * while still being fast and low on memory usage. At the same time it was
16236 * also made to be able to do tree structures. But the price to pay is more
16237 * complexity when it comes to usage. If all you want is a simple list with
16238 * icons and a single label, use the normal @ref List object.
16240 * Genlist has a fairly large API, mostly because it's relatively complex,
16241 * trying to be both expansive, powerful and efficient. First we will begin
16242 * an overview on the theory behind genlist.
16244 * @section Genlist_Item_Class Genlist item classes - creating items
16246 * In order to have the ability to add and delete items on the fly, genlist
16247 * implements a class (callback) system where the application provides a
16248 * structure with information about that type of item (genlist may contain
16249 * multiple different items with different classes, states and styles).
16250 * Genlist will call the functions in this struct (methods) when an item is
16251 * "realized" (i.e., created dynamically, while the user is scrolling the
16252 * grid). All objects will simply be deleted when no longer needed with
16253 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16254 * following members:
16255 * - @c item_style - This is a constant string and simply defines the name
16256 * of the item style. It @b must be specified and the default should be @c
16258 * - @c mode_item_style - This is a constant string and simply defines the
16259 * name of the style that will be used for mode animations. It can be left
16260 * as @c NULL if you don't plan to use Genlist mode. See
16261 * elm_genlist_item_mode_set() for more info.
16263 * - @c func - A struct with pointers to functions that will be called when
16264 * an item is going to be actually created. All of them receive a @c data
16265 * parameter that will point to the same data passed to
16266 * elm_genlist_item_append() and related item creation functions, and a @c
16267 * obj parameter that points to the genlist object itself.
16269 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16270 * state_get and @c del. The 3 first functions also receive a @c part
16271 * parameter described below. A brief description of these functions follows:
16273 * - @c label_get - The @c part parameter is the name string of one of the
16274 * existing text parts in the Edje group implementing the item's theme.
16275 * This function @b must return a strdup'()ed string, as the caller will
16276 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16277 * - @c icon_get - The @c part parameter is the name string of one of the
16278 * existing (icon) swallow parts in the Edje group implementing the item's
16279 * theme. It must return @c NULL, when no icon is desired, or a valid
16280 * object handle, otherwise. The object will be deleted by the genlist on
16281 * its deletion or when the item is "unrealized". See
16282 * #Elm_Genlist_Item_Icon_Get_Cb.
16283 * - @c func.state_get - The @c part parameter is the name string of one of
16284 * the state parts in the Edje group implementing the item's theme. Return
16285 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16286 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16287 * and @c "elm" as "emission" and "source" arguments, respectively, when
16288 * the state is true (the default is false), where @c XXX is the name of
16289 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16290 * - @c func.del - This is intended for use when genlist items are deleted,
16291 * so any data attached to the item (e.g. its data parameter on creation)
16292 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16294 * available item styles:
16296 * - default_style - The text part is a textblock
16298 * @image html img/widget/genlist/preview-04.png
16299 * @image latex img/widget/genlist/preview-04.eps
16303 * @image html img/widget/genlist/preview-01.png
16304 * @image latex img/widget/genlist/preview-01.eps
16306 * - icon_top_text_bottom
16308 * @image html img/widget/genlist/preview-02.png
16309 * @image latex img/widget/genlist/preview-02.eps
16313 * @image html img/widget/genlist/preview-03.png
16314 * @image latex img/widget/genlist/preview-03.eps
16316 * @section Genlist_Items Structure of items
16318 * An item in a genlist can have 0 or more text labels (they can be regular
16319 * text or textblock Evas objects - that's up to the style to determine), 0
16320 * or more icons (which are simply objects swallowed into the genlist item's
16321 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16322 * behavior left to the user to define. The Edje part names for each of
16323 * these properties will be looked up, in the theme file for the genlist,
16324 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16325 * "states", respectively. For each of those properties, if more than one
16326 * part is provided, they must have names listed separated by spaces in the
16327 * data fields. For the default genlist item theme, we have @b one label
16328 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16329 * "elm.swallow.end") and @b no state parts.
16331 * A genlist item may be at one of several styles. Elementary provides one
16332 * by default - "default", but this can be extended by system or application
16333 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16336 * @section Genlist_Manipulation Editing and Navigating
16338 * Items can be added by several calls. All of them return a @ref
16339 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16340 * They all take a data parameter that is meant to be used for a handle to
16341 * the applications internal data (eg the struct with the original item
16342 * data). The parent parameter is the parent genlist item this belongs to if
16343 * it is a tree or an indexed group, and NULL if there is no parent. The
16344 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16345 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16346 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16347 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16348 * is set then this item is group index item that is displayed at the top
16349 * until the next group comes. The func parameter is a convenience callback
16350 * that is called when the item is selected and the data parameter will be
16351 * the func_data parameter, obj be the genlist object and event_info will be
16352 * the genlist item.
16354 * elm_genlist_item_append() adds an item to the end of the list, or if
16355 * there is a parent, to the end of all the child items of the parent.
16356 * elm_genlist_item_prepend() is the same but adds to the beginning of
16357 * the list or children list. elm_genlist_item_insert_before() inserts at
16358 * item before another item and elm_genlist_item_insert_after() inserts after
16359 * the indicated item.
16361 * The application can clear the list with elm_genlist_clear() which deletes
16362 * all the items in the list and elm_genlist_item_del() will delete a specific
16363 * item. elm_genlist_item_subitems_clear() will clear all items that are
16364 * children of the indicated parent item.
16366 * To help inspect list items you can jump to the item at the top of the list
16367 * with elm_genlist_first_item_get() which will return the item pointer, and
16368 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16369 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16370 * and previous items respectively relative to the indicated item. Using
16371 * these calls you can walk the entire item list/tree. Note that as a tree
16372 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16373 * let you know which item is the parent (and thus know how to skip them if
16376 * @section Genlist_Muti_Selection Multi-selection
16378 * If the application wants multiple items to be able to be selected,
16379 * elm_genlist_multi_select_set() can enable this. If the list is
16380 * single-selection only (the default), then elm_genlist_selected_item_get()
16381 * will return the selected item, if any, or NULL I none is selected. If the
16382 * list is multi-select then elm_genlist_selected_items_get() will return a
16383 * list (that is only valid as long as no items are modified (added, deleted,
16384 * selected or unselected)).
16386 * @section Genlist_Usage_Hints Usage hints
16388 * There are also convenience functions. elm_genlist_item_genlist_get() will
16389 * return the genlist object the item belongs to. elm_genlist_item_show()
16390 * will make the scroller scroll to show that specific item so its visible.
16391 * elm_genlist_item_data_get() returns the data pointer set by the item
16392 * creation functions.
16394 * If an item changes (state of boolean changes, label or icons change),
16395 * then use elm_genlist_item_update() to have genlist update the item with
16396 * the new state. Genlist will re-realize the item thus call the functions
16397 * in the _Elm_Genlist_Item_Class for that item.
16399 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16400 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16401 * to expand/contract an item and get its expanded state, use
16402 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16403 * again to make an item disabled (unable to be selected and appear
16404 * differently) use elm_genlist_item_disabled_set() to set this and
16405 * elm_genlist_item_disabled_get() to get the disabled state.
16407 * In general to indicate how the genlist should expand items horizontally to
16408 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16409 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16410 * mode means that if items are too wide to fit, the scroller will scroll
16411 * horizontally. Otherwise items are expanded to fill the width of the
16412 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16413 * to the viewport width and limited to that size. This can be combined with
16414 * a different style that uses edjes' ellipsis feature (cutting text off like
16417 * Items will only call their selection func and callback when first becoming
16418 * selected. Any further clicks will do nothing, unless you enable always
16419 * select with elm_genlist_always_select_mode_set(). This means even if
16420 * selected, every click will make the selected callbacks be called.
16421 * elm_genlist_no_select_mode_set() will turn off the ability to select
16422 * items entirely and they will neither appear selected nor call selected
16423 * callback functions.
16425 * Remember that you can create new styles and add your own theme augmentation
16426 * per application with elm_theme_extension_add(). If you absolutely must
16427 * have a specific style that overrides any theme the user or system sets up
16428 * you can use elm_theme_overlay_add() to add such a file.
16430 * @section Genlist_Implementation Implementation
16432 * Evas tracks every object you create. Every time it processes an event
16433 * (mouse move, down, up etc.) it needs to walk through objects and find out
16434 * what event that affects. Even worse every time it renders display updates,
16435 * in order to just calculate what to re-draw, it needs to walk through many
16436 * many many objects. Thus, the more objects you keep active, the more
16437 * overhead Evas has in just doing its work. It is advisable to keep your
16438 * active objects to the minimum working set you need. Also remember that
16439 * object creation and deletion carries an overhead, so there is a
16440 * middle-ground, which is not easily determined. But don't keep massive lists
16441 * of objects you can't see or use. Genlist does this with list objects. It
16442 * creates and destroys them dynamically as you scroll around. It groups them
16443 * into blocks so it can determine the visibility etc. of a whole block at
16444 * once as opposed to having to walk the whole list. This 2-level list allows
16445 * for very large numbers of items to be in the list (tests have used up to
16446 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16447 * may be different sizes, every item added needs to be calculated as to its
16448 * size and thus this presents a lot of overhead on populating the list, this
16449 * genlist employs a queue. Any item added is queued and spooled off over
16450 * time, actually appearing some time later, so if your list has many members
16451 * you may find it takes a while for them to all appear, with your process
16452 * consuming a lot of CPU while it is busy spooling.
16454 * Genlist also implements a tree structure, but it does so with callbacks to
16455 * the application, with the application filling in tree structures when
16456 * requested (allowing for efficient building of a very deep tree that could
16457 * even be used for file-management). See the above smart signal callbacks for
16460 * @section Genlist_Smart_Events Genlist smart events
16462 * Signals that you can add callbacks for are:
16463 * - @c "activated" - The user has double-clicked or pressed
16464 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16465 * item that was activated.
16466 * - @c "clicked,double" - The user has double-clicked an item. The @c
16467 * event_info parameter is the item that was double-clicked.
16468 * - @c "selected" - This is called when a user has made an item selected.
16469 * The event_info parameter is the genlist item that was selected.
16470 * - @c "unselected" - This is called when a user has made an item
16471 * unselected. The event_info parameter is the genlist item that was
16473 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16474 * called and the item is now meant to be expanded. The event_info
16475 * parameter is the genlist item that was indicated to expand. It is the
16476 * job of this callback to then fill in the child items.
16477 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16478 * called and the item is now meant to be contracted. The event_info
16479 * parameter is the genlist item that was indicated to contract. It is the
16480 * job of this callback to then delete the child items.
16481 * - @c "expand,request" - This is called when a user has indicated they want
16482 * to expand a tree branch item. The callback should decide if the item can
16483 * expand (has any children) and then call elm_genlist_item_expanded_set()
16484 * appropriately to set the state. The event_info parameter is the genlist
16485 * item that was indicated to expand.
16486 * - @c "contract,request" - This is called when a user has indicated they
16487 * want to contract a tree branch item. The callback should decide if the
16488 * item can contract (has any children) and then call
16489 * elm_genlist_item_expanded_set() appropriately to set the state. The
16490 * event_info parameter is the genlist item that was indicated to contract.
16491 * - @c "realized" - This is called when the item in the list is created as a
16492 * real evas object. event_info parameter is the genlist item that was
16493 * created. The object may be deleted at any time, so it is up to the
16494 * caller to not use the object pointer from elm_genlist_item_object_get()
16495 * in a way where it may point to freed objects.
16496 * - @c "unrealized" - This is called just before an item is unrealized.
16497 * After this call icon objects provided will be deleted and the item
16498 * object itself delete or be put into a floating cache.
16499 * - @c "drag,start,up" - This is called when the item in the list has been
16500 * dragged (not scrolled) up.
16501 * - @c "drag,start,down" - This is called when the item in the list has been
16502 * dragged (not scrolled) down.
16503 * - @c "drag,start,left" - This is called when the item in the list has been
16504 * dragged (not scrolled) left.
16505 * - @c "drag,start,right" - This is called when the item in the list has
16506 * been dragged (not scrolled) right.
16507 * - @c "drag,stop" - This is called when the item in the list has stopped
16509 * - @c "drag" - This is called when the item in the list is being dragged.
16510 * - @c "longpressed" - This is called when the item is pressed for a certain
16511 * amount of time. By default it's 1 second.
16512 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16514 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16515 * until the bottom edge.
16516 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16517 * until the left edge.
16518 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16519 * until the right edge.
16520 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16522 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16524 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16526 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16528 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16529 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16530 * multi-touch pinched in.
16531 * - @c "swipe" - This is called when the genlist is swiped.
16533 * @section Genlist_Examples Examples
16535 * Here is a list of examples that use the genlist, trying to show some of
16536 * its capabilities:
16537 * - @ref genlist_example_01
16538 * - @ref genlist_example_02
16539 * - @ref genlist_example_03
16540 * - @ref genlist_example_04
16541 * - @ref genlist_example_05
16545 * @addtogroup Genlist
16550 * @enum _Elm_Genlist_Item_Flags
16551 * @typedef Elm_Genlist_Item_Flags
16553 * Defines if the item is of any special type (has subitems or it's the
16554 * index of a group), or is just a simple item.
16558 typedef enum _Elm_Genlist_Item_Flags
16560 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16561 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16562 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16563 } Elm_Genlist_Item_Flags;
16564 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16565 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16566 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16567 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16568 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. */
16569 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. */
16570 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16571 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16573 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16574 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16575 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16576 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16579 * @struct _Elm_Genlist_Item_Class
16581 * Genlist item class definition structs.
16583 * This struct contains the style and fetching functions that will define the
16584 * contents of each item.
16586 * @see @ref Genlist_Item_Class
16588 struct _Elm_Genlist_Item_Class
16590 const char *item_style; /**< style of this class. */
16593 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16594 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16595 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16596 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16597 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16599 const char *mode_item_style;
16603 * Add a new genlist widget to the given parent Elementary
16604 * (container) object
16606 * @param parent The parent object
16607 * @return a new genlist widget handle or @c NULL, on errors
16609 * This function inserts a new genlist widget on the canvas.
16611 * @see elm_genlist_item_append()
16612 * @see elm_genlist_item_del()
16613 * @see elm_genlist_clear()
16617 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16619 * Remove all items from a given genlist widget.
16621 * @param obj The genlist object
16623 * This removes (and deletes) all items in @p obj, leaving it empty.
16625 * @see elm_genlist_item_del(), to remove just one item.
16629 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16631 * Enable or disable multi-selection in the genlist
16633 * @param obj The genlist object
16634 * @param multi Multi-select enable/disable. Default is disabled.
16636 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16637 * the list. This allows more than 1 item to be selected. To retrieve the list
16638 * of selected items, use elm_genlist_selected_items_get().
16640 * @see elm_genlist_selected_items_get()
16641 * @see elm_genlist_multi_select_get()
16645 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16647 * Gets if multi-selection in genlist is enabled or disabled.
16649 * @param obj The genlist object
16650 * @return Multi-select enabled/disabled
16651 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16653 * @see elm_genlist_multi_select_set()
16657 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16659 * This sets the horizontal stretching mode.
16661 * @param obj The genlist object
16662 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16664 * This sets the mode used for sizing items horizontally. Valid modes
16665 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16666 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16667 * the scroller will scroll horizontally. Otherwise items are expanded
16668 * to fill the width of the viewport of the scroller. If it is
16669 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16670 * limited to that size.
16672 * @see elm_genlist_horizontal_get()
16676 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16677 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16679 * Gets the horizontal stretching mode.
16681 * @param obj The genlist object
16682 * @return The mode to use
16683 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16685 * @see elm_genlist_horizontal_set()
16689 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16690 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16692 * Set the always select mode.
16694 * @param obj The genlist object
16695 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16696 * EINA_FALSE = off). Default is @c EINA_FALSE.
16698 * Items will only call their selection func and callback when first
16699 * becoming selected. Any further clicks will do nothing, unless you
16700 * enable always select with elm_genlist_always_select_mode_set().
16701 * This means that, even if selected, every click will make the selected
16702 * callbacks be called.
16704 * @see elm_genlist_always_select_mode_get()
16708 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16710 * Get the always select mode.
16712 * @param obj The genlist object
16713 * @return The always select mode
16714 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16716 * @see elm_genlist_always_select_mode_set()
16720 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16722 * Enable/disable the no select mode.
16724 * @param obj The genlist object
16725 * @param no_select The no select mode
16726 * (EINA_TRUE = on, EINA_FALSE = off)
16728 * This will turn off the ability to select items entirely and they
16729 * will neither appear selected nor call selected callback functions.
16731 * @see elm_genlist_no_select_mode_get()
16735 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16737 * Gets whether the no select mode is enabled.
16739 * @param obj The genlist object
16740 * @return The no select mode
16741 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16743 * @see elm_genlist_no_select_mode_set()
16747 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16749 * Enable/disable compress mode.
16751 * @param obj The genlist object
16752 * @param compress The compress mode
16753 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16755 * This will enable the compress mode where items are "compressed"
16756 * horizontally to fit the genlist scrollable viewport width. This is
16757 * special for genlist. Do not rely on
16758 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16759 * work as genlist needs to handle it specially.
16761 * @see elm_genlist_compress_mode_get()
16765 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16767 * Get whether the compress mode is enabled.
16769 * @param obj The genlist object
16770 * @return The compress mode
16771 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16773 * @see elm_genlist_compress_mode_set()
16777 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16779 * Enable/disable height-for-width mode.
16781 * @param obj The genlist object
16782 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16783 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16785 * With height-for-width mode the item width will be fixed (restricted
16786 * to a minimum of) to the list width when calculating its size in
16787 * order to allow the height to be calculated based on it. This allows,
16788 * for instance, text block to wrap lines if the Edje part is
16789 * configured with "text.min: 0 1".
16791 * @note This mode will make list resize slower as it will have to
16792 * recalculate every item height again whenever the list width
16795 * @note When height-for-width mode is enabled, it also enables
16796 * compress mode (see elm_genlist_compress_mode_set()) and
16797 * disables homogeneous (see elm_genlist_homogeneous_set()).
16801 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16803 * Get whether the height-for-width mode is enabled.
16805 * @param obj The genlist object
16806 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16811 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16813 * Enable/disable horizontal and vertical bouncing effect.
16815 * @param obj The genlist object
16816 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16817 * EINA_FALSE = off). Default is @c EINA_FALSE.
16818 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16819 * EINA_FALSE = off). Default is @c EINA_TRUE.
16821 * This will enable or disable the scroller bouncing effect for the
16822 * genlist. See elm_scroller_bounce_set() for details.
16824 * @see elm_scroller_bounce_set()
16825 * @see elm_genlist_bounce_get()
16829 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16831 * Get whether the horizontal and vertical bouncing effect is enabled.
16833 * @param obj The genlist object
16834 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16836 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16839 * @see elm_genlist_bounce_set()
16843 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16845 * Enable/disable homogenous mode.
16847 * @param obj The genlist object
16848 * @param homogeneous Assume the items within the genlist are of the
16849 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16852 * This will enable the homogeneous mode where items are of the same
16853 * height and width so that genlist may do the lazy-loading at its
16854 * maximum (which increases the performance for scrolling the list). This
16855 * implies 'compressed' mode.
16857 * @see elm_genlist_compress_mode_set()
16858 * @see elm_genlist_homogeneous_get()
16862 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16864 * Get whether the homogenous mode is enabled.
16866 * @param obj The genlist object
16867 * @return Assume the items within the genlist are of the same height
16868 * and width (EINA_TRUE = on, EINA_FALSE = off)
16870 * @see elm_genlist_homogeneous_set()
16874 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16876 * Set the maximum number of items within an item block
16878 * @param obj The genlist object
16879 * @param n Maximum number of items within an item block. Default is 32.
16881 * This will configure the block count to tune to the target with
16882 * particular performance matrix.
16884 * A block of objects will be used to reduce the number of operations due to
16885 * many objects in the screen. It can determine the visibility, or if the
16886 * object has changed, it theme needs to be updated, etc. doing this kind of
16887 * calculation to the entire block, instead of per object.
16889 * The default value for the block count is enough for most lists, so unless
16890 * you know you will have a lot of objects visible in the screen at the same
16891 * time, don't try to change this.
16893 * @see elm_genlist_block_count_get()
16894 * @see @ref Genlist_Implementation
16898 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16900 * Get the maximum number of items within an item block
16902 * @param obj The genlist object
16903 * @return Maximum number of items within an item block
16905 * @see elm_genlist_block_count_set()
16909 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16911 * Set the timeout in seconds for the longpress event.
16913 * @param obj The genlist object
16914 * @param timeout timeout in seconds. Default is 1.
16916 * This option will change how long it takes to send an event "longpressed"
16917 * after the mouse down signal is sent to the list. If this event occurs, no
16918 * "clicked" event will be sent.
16920 * @see elm_genlist_longpress_timeout_set()
16924 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16926 * Get the timeout in seconds for the longpress event.
16928 * @param obj The genlist object
16929 * @return timeout in seconds
16931 * @see elm_genlist_longpress_timeout_get()
16935 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16937 * Append a new item in a given genlist widget.
16939 * @param obj The genlist object
16940 * @param itc The item class for the item
16941 * @param data The item data
16942 * @param parent The parent item, or NULL if none
16943 * @param flags Item flags
16944 * @param func Convenience function called when the item is selected
16945 * @param func_data Data passed to @p func above.
16946 * @return A handle to the item added or @c NULL if not possible
16948 * This adds the given item to the end of the list or the end of
16949 * the children list if the @p parent is given.
16951 * @see elm_genlist_item_prepend()
16952 * @see elm_genlist_item_insert_before()
16953 * @see elm_genlist_item_insert_after()
16954 * @see elm_genlist_item_del()
16958 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);
16960 * Prepend a new item in a given genlist widget.
16962 * @param obj The genlist object
16963 * @param itc The item class for the item
16964 * @param data The item data
16965 * @param parent The parent item, or NULL if none
16966 * @param flags Item flags
16967 * @param func Convenience function called when the item is selected
16968 * @param func_data Data passed to @p func above.
16969 * @return A handle to the item added or NULL if not possible
16971 * This adds an item to the beginning of the list or beginning of the
16972 * children of the parent if given.
16974 * @see elm_genlist_item_append()
16975 * @see elm_genlist_item_insert_before()
16976 * @see elm_genlist_item_insert_after()
16977 * @see elm_genlist_item_del()
16981 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);
16983 * Insert an item before another in a genlist widget
16985 * @param obj The genlist object
16986 * @param itc The item class for the item
16987 * @param data The item data
16988 * @param before The item to place this new one before.
16989 * @param flags Item flags
16990 * @param func Convenience function called when the item is selected
16991 * @param func_data Data passed to @p func above.
16992 * @return A handle to the item added or @c NULL if not possible
16994 * This inserts an item before another in the list. It will be in the
16995 * same tree level or group as the item it is inserted before.
16997 * @see elm_genlist_item_append()
16998 * @see elm_genlist_item_prepend()
16999 * @see elm_genlist_item_insert_after()
17000 * @see elm_genlist_item_del()
17004 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);
17006 * Insert an item after another in a genlist widget
17008 * @param obj The genlist object
17009 * @param itc The item class for the item
17010 * @param data The item data
17011 * @param after The item to place this new one after.
17012 * @param flags Item flags
17013 * @param func Convenience function called when the item is selected
17014 * @param func_data Data passed to @p func above.
17015 * @return A handle to the item added or @c NULL if not possible
17017 * This inserts an item after another in the list. It will be in the
17018 * same tree level or group as the item it is inserted after.
17020 * @see elm_genlist_item_append()
17021 * @see elm_genlist_item_prepend()
17022 * @see elm_genlist_item_insert_before()
17023 * @see elm_genlist_item_del()
17027 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);
17029 * Insert a new item into the sorted genlist object
17031 * @param obj The genlist object
17032 * @param itc The item class for the item
17033 * @param data The item data
17034 * @param parent The parent item, or NULL if none
17035 * @param flags Item flags
17036 * @param comp The function called for the sort
17037 * @param func Convenience function called when item selected
17038 * @param func_data Data passed to @p func above.
17039 * @return A handle to the item added or NULL if not possible
17043 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);
17044 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);
17045 /* operations to retrieve existing items */
17047 * Get the selectd item in the genlist.
17049 * @param obj The genlist object
17050 * @return The selected item, or NULL if none is selected.
17052 * This gets the selected item in the list (if multi-selection is enabled, only
17053 * the item that was first selected in the list is returned - which is not very
17054 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17057 * If no item is selected, NULL is returned.
17059 * @see elm_genlist_selected_items_get()
17063 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17065 * Get a list of selected items in the genlist.
17067 * @param obj The genlist object
17068 * @return The list of selected items, or NULL if none are selected.
17070 * It returns a list of the selected items. This list pointer is only valid so
17071 * long as the selection doesn't change (no items are selected or unselected, or
17072 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17073 * pointers. The order of the items in this list is the order which they were
17074 * selected, i.e. the first item in this list is the first item that was
17075 * selected, and so on.
17077 * @note If not in multi-select mode, consider using function
17078 * elm_genlist_selected_item_get() instead.
17080 * @see elm_genlist_multi_select_set()
17081 * @see elm_genlist_selected_item_get()
17085 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17087 * Get a list of realized items in genlist
17089 * @param obj The genlist object
17090 * @return The list of realized items, nor NULL if none are realized.
17092 * This returns a list of the realized items in the genlist. The list
17093 * contains Elm_Genlist_Item pointers. The list must be freed by the
17094 * caller when done with eina_list_free(). The item pointers in the
17095 * list are only valid so long as those items are not deleted or the
17096 * genlist is not deleted.
17098 * @see elm_genlist_realized_items_update()
17102 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17104 * Get the item that is at the x, y canvas coords.
17106 * @param obj The gelinst object.
17107 * @param x The input x coordinate
17108 * @param y The input y coordinate
17109 * @param posret The position relative to the item returned here
17110 * @return The item at the coordinates or NULL if none
17112 * This returns the item at the given coordinates (which are canvas
17113 * relative, not object-relative). If an item is at that coordinate,
17114 * that item handle is returned, and if @p posret is not NULL, the
17115 * integer pointed to is set to a value of -1, 0 or 1, depending if
17116 * the coordinate is on the upper portion of that item (-1), on the
17117 * middle section (0) or on the lower part (1). If NULL is returned as
17118 * an item (no item found there), then posret may indicate -1 or 1
17119 * based if the coordinate is above or below all items respectively in
17124 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);
17126 * Get the first item in the genlist
17128 * This returns the first item in the list.
17130 * @param obj The genlist object
17131 * @return The first item, or NULL if none
17135 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137 * Get the last item in the genlist
17139 * This returns the last item in the list.
17141 * @return The last item, or NULL if none
17145 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17147 * Set the scrollbar policy
17149 * @param obj The genlist object
17150 * @param policy_h Horizontal scrollbar policy.
17151 * @param policy_v Vertical scrollbar policy.
17153 * This sets the scrollbar visibility policy for the given genlist
17154 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17155 * made visible if it is needed, and otherwise kept hidden.
17156 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17157 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17158 * respectively for the horizontal and vertical scrollbars. Default is
17159 * #ELM_SMART_SCROLLER_POLICY_AUTO
17161 * @see elm_genlist_scroller_policy_get()
17165 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17167 * Get the scrollbar policy
17169 * @param obj The genlist object
17170 * @param policy_h Pointer to store the horizontal scrollbar policy.
17171 * @param policy_v Pointer to store the vertical scrollbar policy.
17173 * @see elm_genlist_scroller_policy_set()
17177 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);
17179 * Get the @b next item in a genlist widget's internal list of items,
17180 * given a handle to one of those items.
17182 * @param item The genlist item to fetch next from
17183 * @return The item after @p item, or @c NULL if there's none (and
17186 * This returns the item placed after the @p item, on the container
17189 * @see elm_genlist_item_prev_get()
17193 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17195 * Get the @b previous item in a genlist widget's internal list of items,
17196 * given a handle to one of those items.
17198 * @param item The genlist item to fetch previous from
17199 * @return The item before @p item, or @c NULL if there's none (and
17202 * This returns the item placed before the @p item, on the container
17205 * @see elm_genlist_item_next_get()
17209 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17211 * Get the genlist object's handle which contains a given genlist
17214 * @param item The item to fetch the container from
17215 * @return The genlist (parent) object
17217 * This returns the genlist object itself that an item belongs to.
17221 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17223 * Get the parent item of the given item
17225 * @param it The item
17226 * @return The parent of the item or @c NULL if it has no parent.
17228 * This returns the item that was specified as parent of the item @p it on
17229 * elm_genlist_item_append() and insertion related functions.
17233 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17235 * Remove all sub-items (children) of the given item
17237 * @param it The item
17239 * This removes all items that are children (and their descendants) of the
17240 * given item @p it.
17242 * @see elm_genlist_clear()
17243 * @see elm_genlist_item_del()
17247 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17249 * Set whether a given genlist item is selected or not
17251 * @param it The item
17252 * @param selected Use @c EINA_TRUE, to make it selected, @c
17253 * EINA_FALSE to make it unselected
17255 * This sets the selected state of an item. If multi selection is
17256 * not enabled on the containing genlist and @p selected is @c
17257 * EINA_TRUE, any other previously selected items will get
17258 * unselected in favor of this new one.
17260 * @see elm_genlist_item_selected_get()
17264 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17266 * Get whether a given genlist item is selected or not
17268 * @param it The item
17269 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17271 * @see elm_genlist_item_selected_set() for more details
17275 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17277 * Sets the expanded state of an item.
17279 * @param it The item
17280 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17282 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17285 * The theme will respond to this change visually, and a signal "expanded" or
17286 * "contracted" will be sent from the genlist with a pointer to the item that
17287 * has been expanded/contracted.
17289 * Calling this function won't show or hide any child of this item (if it is
17290 * a parent). You must manually delete and create them on the callbacks fo
17291 * the "expanded" or "contracted" signals.
17293 * @see elm_genlist_item_expanded_get()
17297 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17299 * Get the expanded state of an item
17301 * @param it The item
17302 * @return The expanded state
17304 * This gets the expanded state of an item.
17306 * @see elm_genlist_item_expanded_set()
17310 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17312 * Get the depth of expanded item
17314 * @param it The genlist item object
17315 * @return The depth of expanded item
17319 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17321 * Set whether a given genlist item is disabled or not.
17323 * @param it The item
17324 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17325 * to enable it back.
17327 * A disabled item cannot be selected or unselected. It will also
17328 * change its appearance, to signal the user it's disabled.
17330 * @see elm_genlist_item_disabled_get()
17334 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17336 * Get whether a given genlist item is disabled or not.
17338 * @param it The item
17339 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17342 * @see elm_genlist_item_disabled_set() for more details
17346 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17348 * Sets the display only state of an item.
17350 * @param it The item
17351 * @param display_only @c EINA_TRUE if the item is display only, @c
17352 * EINA_FALSE otherwise.
17354 * A display only item cannot be selected or unselected. It is for
17355 * display only and not selecting or otherwise clicking, dragging
17356 * etc. by the user, thus finger size rules will not be applied to
17359 * It's good to set group index items to display only state.
17361 * @see elm_genlist_item_display_only_get()
17365 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17367 * Get the display only state of an item
17369 * @param it The item
17370 * @return @c EINA_TRUE if the item is display only, @c
17371 * EINA_FALSE otherwise.
17373 * @see elm_genlist_item_display_only_set()
17377 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17379 * Show the portion of a genlist's internal list containing a given
17380 * item, immediately.
17382 * @param it The item to display
17384 * This causes genlist to jump to the given item @p it and show it (by
17385 * immediately scrolling to that position), if it is not fully visible.
17387 * @see elm_genlist_item_bring_in()
17388 * @see elm_genlist_item_top_show()
17389 * @see elm_genlist_item_middle_show()
17393 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17395 * Animatedly bring in, to the visible are of a genlist, a given
17398 * @param it The item to display
17400 * This causes genlist to jump to the given item @p it and show it (by
17401 * animatedly scrolling), if it is not fully visible. This may use animation
17402 * to do so and take a period of time
17404 * @see elm_genlist_item_show()
17405 * @see elm_genlist_item_top_bring_in()
17406 * @see elm_genlist_item_middle_bring_in()
17410 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17412 * Show the portion of a genlist's internal list containing a given
17413 * item, immediately.
17415 * @param it The item to display
17417 * This causes genlist to jump to the given item @p it and show it (by
17418 * immediately scrolling to that position), if it is not fully visible.
17420 * The item will be positioned at the top of the genlist viewport.
17422 * @see elm_genlist_item_show()
17423 * @see elm_genlist_item_top_bring_in()
17427 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17429 * Animatedly bring in, to the visible are of a genlist, a given
17432 * @param it The item
17434 * This causes genlist to jump to the given item @p it and show it (by
17435 * animatedly scrolling), if it is not fully visible. This may use animation
17436 * to do so and take a period of time
17438 * The item will be positioned at the top of the genlist viewport.
17440 * @see elm_genlist_item_bring_in()
17441 * @see elm_genlist_item_top_show()
17445 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17447 * Show the portion of a genlist's internal list containing a given
17448 * item, immediately.
17450 * @param it The item to display
17452 * This causes genlist to jump to the given item @p it and show it (by
17453 * immediately scrolling to that position), if it is not fully visible.
17455 * The item will be positioned at the middle of the genlist viewport.
17457 * @see elm_genlist_item_show()
17458 * @see elm_genlist_item_middle_bring_in()
17462 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17464 * Animatedly bring in, to the visible are of a genlist, a given
17467 * @param it The item
17469 * This causes genlist to jump to the given item @p it and show it (by
17470 * animatedly scrolling), if it is not fully visible. This may use animation
17471 * to do so and take a period of time
17473 * The item will be positioned at the middle of the genlist viewport.
17475 * @see elm_genlist_item_bring_in()
17476 * @see elm_genlist_item_middle_show()
17480 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17482 * Remove a genlist item from the its parent, deleting it.
17484 * @param item The item to be removed.
17485 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17487 * @see elm_genlist_clear(), to remove all items in a genlist at
17492 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17494 * Return the data associated to a given genlist item
17496 * @param item The genlist item.
17497 * @return the data associated to this item.
17499 * This returns the @c data value passed on the
17500 * elm_genlist_item_append() and related item addition calls.
17502 * @see elm_genlist_item_append()
17503 * @see elm_genlist_item_data_set()
17507 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17509 * Set the data associated to a given genlist item
17511 * @param item The genlist item
17512 * @param data The new data pointer to set on it
17514 * This @b overrides the @c data value passed on the
17515 * elm_genlist_item_append() and related item addition calls. This
17516 * function @b won't call elm_genlist_item_update() automatically,
17517 * so you'd issue it afterwards if you want to hove the item
17518 * updated to reflect the that new data.
17520 * @see elm_genlist_item_data_get()
17524 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17526 * Tells genlist to "orphan" icons fetchs by the item class
17528 * @param it The item
17530 * This instructs genlist to release references to icons in the item,
17531 * meaning that they will no longer be managed by genlist and are
17532 * floating "orphans" that can be re-used elsewhere if the user wants
17537 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17539 * Get the real Evas object created to implement the view of a
17540 * given genlist item
17542 * @param item The genlist item.
17543 * @return the Evas object implementing this item's view.
17545 * This returns the actual Evas object used to implement the
17546 * specified genlist item's view. This may be @c NULL, as it may
17547 * not have been created or may have been deleted, at any time, by
17548 * the genlist. <b>Do not modify this object</b> (move, resize,
17549 * show, hide, etc.), as the genlist is controlling it. This
17550 * function is for querying, emitting custom signals or hooking
17551 * lower level callbacks for events on that object. Do not delete
17552 * this object under any circumstances.
17554 * @see elm_genlist_item_data_get()
17558 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17560 * Update the contents of an item
17562 * @param it The item
17564 * This updates an item by calling all the item class functions again
17565 * to get the icons, labels and states. Use this when the original
17566 * item data has changed and the changes are desired to be reflected.
17568 * Use elm_genlist_realized_items_update() to update all already realized
17571 * @see elm_genlist_realized_items_update()
17575 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17577 * Update the item class of an item
17579 * @param it The item
17580 * @param itc The item class for the item
17582 * This sets another class fo the item, changing the way that it is
17583 * displayed. After changing the item class, elm_genlist_item_update() is
17584 * called on the item @p it.
17588 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17589 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17591 * Set the text to be shown in a given genlist item's tooltips.
17593 * @param item The genlist item
17594 * @param text The text to set in the content
17596 * This call will setup the text to be used as tooltip to that item
17597 * (analogous to elm_object_tooltip_text_set(), but being item
17598 * tooltips with higher precedence than object tooltips). It can
17599 * have only one tooltip at a time, so any previous tooltip data
17600 * will get removed.
17602 * In order to set an icon or something else as a tooltip, look at
17603 * elm_genlist_item_tooltip_content_cb_set().
17607 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17609 * Set the content to be shown in a given genlist item's tooltips
17611 * @param item The genlist item.
17612 * @param func The function returning the tooltip contents.
17613 * @param data What to provide to @a func as callback data/context.
17614 * @param del_cb Called when data is not needed anymore, either when
17615 * another callback replaces @p func, the tooltip is unset with
17616 * elm_genlist_item_tooltip_unset() or the owner @p item
17617 * dies. This callback receives as its first parameter the
17618 * given @p data, being @c event_info the item handle.
17620 * This call will setup the tooltip's contents to @p item
17621 * (analogous to elm_object_tooltip_content_cb_set(), but being
17622 * item tooltips with higher precedence than object tooltips). It
17623 * can have only one tooltip at a time, so any previous tooltip
17624 * content will get removed. @p func (with @p data) will be called
17625 * every time Elementary needs to show the tooltip and it should
17626 * return a valid Evas object, which will be fully managed by the
17627 * tooltip system, getting deleted when the tooltip is gone.
17629 * In order to set just a text as a tooltip, look at
17630 * elm_genlist_item_tooltip_text_set().
17634 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);
17636 * Unset a tooltip from a given genlist item
17638 * @param item genlist item to remove a previously set tooltip from.
17640 * This call removes any tooltip set on @p item. The callback
17641 * provided as @c del_cb to
17642 * elm_genlist_item_tooltip_content_cb_set() will be called to
17643 * notify it is not used anymore (and have resources cleaned, if
17646 * @see elm_genlist_item_tooltip_content_cb_set()
17650 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17652 * Set a different @b style for a given genlist item's tooltip.
17654 * @param item genlist item with tooltip set
17655 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17656 * "default", @c "transparent", etc)
17658 * Tooltips can have <b>alternate styles</b> to be displayed on,
17659 * which are defined by the theme set on Elementary. This function
17660 * works analogously as elm_object_tooltip_style_set(), but here
17661 * applied only to genlist item objects. The default style for
17662 * tooltips is @c "default".
17664 * @note before you set a style you should define a tooltip with
17665 * elm_genlist_item_tooltip_content_cb_set() or
17666 * elm_genlist_item_tooltip_text_set()
17668 * @see elm_genlist_item_tooltip_style_get()
17672 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17674 * Get the style set a given genlist item's tooltip.
17676 * @param item genlist item with tooltip already set on.
17677 * @return style the theme style in use, which defaults to
17678 * "default". If the object does not have a tooltip set,
17679 * then @c NULL is returned.
17681 * @see elm_genlist_item_tooltip_style_set() for more details
17685 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17687 * @brief Disable size restrictions on an object's tooltip
17688 * @param item The tooltip's anchor object
17689 * @param disable If EINA_TRUE, size restrictions are disabled
17690 * @return EINA_FALSE on failure, EINA_TRUE on success
17692 * This function allows a tooltip to expand beyond its parant window's canvas.
17693 * It will instead be limited only by the size of the display.
17695 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17697 * @brief Retrieve size restriction state of an object's tooltip
17698 * @param item The tooltip's anchor object
17699 * @return If EINA_TRUE, size restrictions are disabled
17701 * This function returns whether a tooltip is allowed to expand beyond
17702 * its parant window's canvas.
17703 * It will instead be limited only by the size of the display.
17705 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17707 * Set the type of mouse pointer/cursor decoration to be shown,
17708 * when the mouse pointer is over the given genlist widget item
17710 * @param item genlist item to customize cursor on
17711 * @param cursor the cursor type's name
17713 * This function works analogously as elm_object_cursor_set(), but
17714 * here the cursor's changing area is restricted to the item's
17715 * area, and not the whole widget's. Note that that item cursors
17716 * have precedence over widget cursors, so that a mouse over @p
17717 * item will always show cursor @p type.
17719 * If this function is called twice for an object, a previously set
17720 * cursor will be unset on the second call.
17722 * @see elm_object_cursor_set()
17723 * @see elm_genlist_item_cursor_get()
17724 * @see elm_genlist_item_cursor_unset()
17728 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17730 * Get the type of mouse pointer/cursor decoration set to be shown,
17731 * when the mouse pointer is over the given genlist widget item
17733 * @param item genlist item with custom cursor set
17734 * @return the cursor type's name or @c NULL, if no custom cursors
17735 * were set to @p item (and on errors)
17737 * @see elm_object_cursor_get()
17738 * @see elm_genlist_item_cursor_set() for more details
17739 * @see elm_genlist_item_cursor_unset()
17743 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17745 * Unset any custom mouse pointer/cursor decoration set to be
17746 * shown, when the mouse pointer is over the given genlist widget
17747 * item, thus making it show the @b default cursor again.
17749 * @param item a genlist item
17751 * Use this call to undo any custom settings on this item's cursor
17752 * decoration, bringing it back to defaults (no custom style set).
17754 * @see elm_object_cursor_unset()
17755 * @see elm_genlist_item_cursor_set() for more details
17759 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17761 * Set a different @b style for a given custom cursor set for a
17764 * @param item genlist item with custom cursor set
17765 * @param style the <b>theme style</b> to use (e.g. @c "default",
17766 * @c "transparent", etc)
17768 * This function only makes sense when one is using custom mouse
17769 * cursor decorations <b>defined in a theme file</b> , which can
17770 * have, given a cursor name/type, <b>alternate styles</b> on
17771 * it. It works analogously as elm_object_cursor_style_set(), but
17772 * here applied only to genlist item objects.
17774 * @warning Before you set a cursor style you should have defined a
17775 * custom cursor previously on the item, with
17776 * elm_genlist_item_cursor_set()
17778 * @see elm_genlist_item_cursor_engine_only_set()
17779 * @see elm_genlist_item_cursor_style_get()
17783 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17785 * Get the current @b style set for a given genlist item's custom
17788 * @param item genlist item with custom cursor set.
17789 * @return style the cursor style in use. If the object does not
17790 * have a cursor set, then @c NULL is returned.
17792 * @see elm_genlist_item_cursor_style_set() for more details
17796 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17798 * Set if the (custom) cursor for a given genlist item should be
17799 * searched in its theme, also, or should only rely on the
17800 * rendering engine.
17802 * @param item item with custom (custom) cursor already set on
17803 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17804 * only on those provided by the rendering engine, @c EINA_FALSE to
17805 * have them searched on the widget's theme, as well.
17807 * @note This call is of use only if you've set a custom cursor
17808 * for genlist items, with elm_genlist_item_cursor_set().
17810 * @note By default, cursors will only be looked for between those
17811 * provided by the rendering engine.
17815 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17817 * Get if the (custom) cursor for a given genlist item is being
17818 * searched in its theme, also, or is only relying on the rendering
17821 * @param item a genlist item
17822 * @return @c EINA_TRUE, if cursors are being looked for only on
17823 * those provided by the rendering engine, @c EINA_FALSE if they
17824 * are being searched on the widget's theme, as well.
17826 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17830 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17832 * Update the contents of all realized items.
17834 * @param obj The genlist object.
17836 * This updates all realized items by calling all the item class functions again
17837 * to get the icons, labels and states. Use this when the original
17838 * item data has changed and the changes are desired to be reflected.
17840 * To update just one item, use elm_genlist_item_update().
17842 * @see elm_genlist_realized_items_get()
17843 * @see elm_genlist_item_update()
17847 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17849 * Activate a genlist mode on an item
17851 * @param item The genlist item
17852 * @param mode Mode name
17853 * @param mode_set Boolean to define set or unset mode.
17855 * A genlist mode is a different way of selecting an item. Once a mode is
17856 * activated on an item, any other selected item is immediately unselected.
17857 * This feature provides an easy way of implementing a new kind of animation
17858 * for selecting an item, without having to entirely rewrite the item style
17859 * theme. However, the elm_genlist_selected_* API can't be used to get what
17860 * item is activate for a mode.
17862 * The current item style will still be used, but applying a genlist mode to
17863 * an item will select it using a different kind of animation.
17865 * The current active item for a mode can be found by
17866 * elm_genlist_mode_item_get().
17868 * The characteristics of genlist mode are:
17869 * - Only one mode can be active at any time, and for only one item.
17870 * - Genlist handles deactivating other items when one item is activated.
17871 * - A mode is defined in the genlist theme (edc), and more modes can easily
17873 * - A mode style and the genlist item style are different things. They
17874 * can be combined to provide a default style to the item, with some kind
17875 * of animation for that item when the mode is activated.
17877 * When a mode is activated on an item, a new view for that item is created.
17878 * The theme of this mode defines the animation that will be used to transit
17879 * the item from the old view to the new view. This second (new) view will be
17880 * active for that item while the mode is active on the item, and will be
17881 * destroyed after the mode is totally deactivated from that item.
17883 * @see elm_genlist_mode_get()
17884 * @see elm_genlist_mode_item_get()
17888 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17890 * Get the last (or current) genlist mode used.
17892 * @param obj The genlist object
17894 * This function just returns the name of the last used genlist mode. It will
17895 * be the current mode if it's still active.
17897 * @see elm_genlist_item_mode_set()
17898 * @see elm_genlist_mode_item_get()
17902 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17904 * Get active genlist mode item
17906 * @param obj The genlist object
17907 * @return The active item for that current mode. Or @c NULL if no item is
17908 * activated with any mode.
17910 * This function returns the item that was activated with a mode, by the
17911 * function elm_genlist_item_mode_set().
17913 * @see elm_genlist_item_mode_set()
17914 * @see elm_genlist_mode_get()
17918 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17923 * @param obj The genlist object
17924 * @param reorder_mode The reorder mode
17925 * (EINA_TRUE = on, EINA_FALSE = off)
17929 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17932 * Get the reorder mode
17934 * @param obj The genlist object
17935 * @return The reorder mode
17936 * (EINA_TRUE = on, EINA_FALSE = off)
17940 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17947 * @defgroup Check Check
17949 * @image html img/widget/check/preview-00.png
17950 * @image latex img/widget/check/preview-00.eps
17951 * @image html img/widget/check/preview-01.png
17952 * @image latex img/widget/check/preview-01.eps
17953 * @image html img/widget/check/preview-02.png
17954 * @image latex img/widget/check/preview-02.eps
17956 * @brief The check widget allows for toggling a value between true and
17959 * Check objects are a lot like radio objects in layout and functionality
17960 * except they do not work as a group, but independently and only toggle the
17961 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17962 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17963 * returns the current state. For convenience, like the radio objects, you
17964 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
17965 * for it to modify.
17967 * Signals that you can add callbacks for are:
17968 * "changed" - This is called whenever the user changes the state of one of
17969 * the check object(event_info is NULL).
17971 * @ref tutorial_check should give you a firm grasp of how to use this widget.
17975 * @brief Add a new Check object
17977 * @param parent The parent object
17978 * @return The new object or NULL if it cannot be created
17980 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17982 * @brief Set the text label of the check object
17984 * @param obj The check object
17985 * @param label The text label string in UTF-8
17987 * @deprecated use elm_object_text_set() instead.
17989 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17991 * @brief Get the text label of the check object
17993 * @param obj The check object
17994 * @return The text label string in UTF-8
17996 * @deprecated use elm_object_text_get() instead.
17998 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18000 * @brief Set the icon object of the check object
18002 * @param obj The check object
18003 * @param icon The icon object
18005 * Once the icon object is set, a previously set one will be deleted.
18006 * If you want to keep that old content object, use the
18007 * elm_check_icon_unset() function.
18009 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18011 * @brief Get the icon object of the check object
18013 * @param obj The check object
18014 * @return The icon object
18016 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18018 * @brief Unset the icon used for the check object
18020 * @param obj The check object
18021 * @return The icon object that was being used
18023 * Unparent and return the icon object which was set for this widget.
18025 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18027 * @brief Set the on/off state of the check object
18029 * @param obj The check object
18030 * @param state The state to use (1 == on, 0 == off)
18032 * This sets the state of the check. If set
18033 * with elm_check_state_pointer_set() the state of that variable is also
18034 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18036 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18038 * @brief Get the state of the check object
18040 * @param obj The check object
18041 * @return The boolean state
18043 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18045 * @brief Set a convenience pointer to a boolean to change
18047 * @param obj The check object
18048 * @param statep Pointer to the boolean to modify
18050 * This sets a pointer to a boolean, that, in addition to the check objects
18051 * state will also be modified directly. To stop setting the object pointed
18052 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18053 * then when this is called, the check objects state will also be modified to
18054 * reflect the value of the boolean @p statep points to, just like calling
18055 * elm_check_state_set().
18057 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18063 * @defgroup Radio Radio
18065 * @image html img/widget/radio/preview-00.png
18066 * @image latex img/widget/radio/preview-00.eps
18068 * @brief Radio is a widget that allows for 1 or more options to be displayed
18069 * and have the user choose only 1 of them.
18071 * A radio object contains an indicator, an optional Label and an optional
18072 * icon object. While it's possible to have a group of only one radio they,
18073 * are normally used in groups of 2 or more. To add a radio to a group use
18074 * elm_radio_group_add(). The radio object(s) will select from one of a set
18075 * of integer values, so any value they are configuring needs to be mapped to
18076 * a set of integers. To configure what value that radio object represents,
18077 * use elm_radio_state_value_set() to set the integer it represents. To set
18078 * the value the whole group(which one is currently selected) is to indicate
18079 * use elm_radio_value_set() on any group member, and to get the groups value
18080 * use elm_radio_value_get(). For convenience the radio objects are also able
18081 * to directly set an integer(int) to the value that is selected. To specify
18082 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18083 * The radio objects will modify this directly. That implies the pointer must
18084 * point to valid memory for as long as the radio objects exist.
18086 * Signals that you can add callbacks for are:
18087 * @li changed - This is called whenever the user changes the state of one of
18088 * the radio objects within the group of radio objects that work together.
18090 * @ref tutorial_radio show most of this API in action.
18094 * @brief Add a new radio to the parent
18096 * @param parent The parent object
18097 * @return The new object or NULL if it cannot be created
18099 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18101 * @brief Set the text label of the radio object
18103 * @param obj The radio object
18104 * @param label The text label string in UTF-8
18106 * @deprecated use elm_object_text_set() instead.
18108 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18110 * @brief Get the text label of the radio object
18112 * @param obj The radio object
18113 * @return The text label string in UTF-8
18115 * @deprecated use elm_object_text_set() instead.
18117 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18119 * @brief Set the icon object of the radio object
18121 * @param obj The radio object
18122 * @param icon The icon object
18124 * Once the icon object is set, a previously set one will be deleted. If you
18125 * want to keep that old content object, use the elm_radio_icon_unset()
18128 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18130 * @brief Get the icon object of the radio object
18132 * @param obj The radio object
18133 * @return The icon object
18135 * @see elm_radio_icon_set()
18137 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18139 * @brief Unset the icon used for the radio object
18141 * @param obj The radio object
18142 * @return The icon object that was being used
18144 * Unparent and return the icon object which was set for this widget.
18146 * @see elm_radio_icon_set()
18148 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18150 * @brief Add this radio to a group of other radio objects
18152 * @param obj The radio object
18153 * @param group Any object whose group the @p obj is to join.
18155 * Radio objects work in groups. Each member should have a different integer
18156 * value assigned. In order to have them work as a group, they need to know
18157 * about each other. This adds the given radio object to the group of which
18158 * the group object indicated is a member.
18160 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18162 * @brief Set the integer value that this radio object represents
18164 * @param obj The radio object
18165 * @param value The value to use if this radio object is selected
18167 * This sets the value of the radio.
18169 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18171 * @brief Get the integer value that this radio object represents
18173 * @param obj The radio object
18174 * @return The value used if this radio object is selected
18176 * This gets the value of the radio.
18178 * @see elm_radio_value_set()
18180 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18182 * @brief Set the value of the radio.
18184 * @param obj The radio object
18185 * @param value The value to use for the group
18187 * This sets the value of the radio group and will also set the value if
18188 * pointed to, to the value supplied, but will not call any callbacks.
18190 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18192 * @brief Get the state of the radio object
18194 * @param obj The radio object
18195 * @return The integer state
18197 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18199 * @brief Set a convenience pointer to a integer to change
18201 * @param obj The radio object
18202 * @param valuep Pointer to the integer to modify
18204 * This sets a pointer to a integer, that, in addition to the radio objects
18205 * state will also be modified directly. To stop setting the object pointed
18206 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18207 * when this is called, the radio objects state will also be modified to
18208 * reflect the value of the integer valuep points to, just like calling
18209 * elm_radio_value_set().
18211 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18217 * @defgroup Pager Pager
18219 * @image html img/widget/pager/preview-00.png
18220 * @image latex img/widget/pager/preview-00.eps
18222 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18224 * The flipping between “pages” of objects is animated. All content in pager
18225 * is kept in a stack, the last content to be added will be on the top of the
18226 * stack(be visible).
18228 * Objects can be pushed or popped from the stack or deleted as normal.
18229 * Pushes and pops will animate (and a pop will delete the object once the
18230 * animation is finished). Any object already in the pager can be promoted to
18231 * the top(from its current stacking position) through the use of
18232 * elm_pager_content_promote(). Objects are pushed to the top with
18233 * elm_pager_content_push() and when the top item is no longer wanted, simply
18234 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18235 * object is no longer needed and is not the top item, just delete it as
18236 * normal. You can query which objects are the top and bottom with
18237 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18239 * Signals that you can add callbacks for are:
18240 * "hide,finished" - when the previous page is hided
18242 * This widget has the following styles available:
18245 * @li fade_translucide
18246 * @li fade_invisible
18247 * @note This styles affect only the flipping animations, the appearance when
18248 * not animating is unaffected by styles.
18250 * @ref tutorial_pager gives a good overview of the usage of the API.
18254 * Add a new pager to the parent
18256 * @param parent The parent object
18257 * @return The new object or NULL if it cannot be created
18261 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18263 * @brief Push an object to the top of the pager stack (and show it).
18265 * @param obj The pager object
18266 * @param content The object to push
18268 * The object pushed becomes a child of the pager, it will be controlled and
18269 * deleted when the pager is deleted.
18271 * @note If the content is already in the stack use
18272 * elm_pager_content_promote().
18273 * @warning Using this function on @p content already in the stack results in
18274 * undefined behavior.
18276 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18278 * @brief Pop the object that is on top of the stack
18280 * @param obj The pager object
18282 * This pops the object that is on the top(visible) of the pager, makes it
18283 * disappear, then deletes the object. The object that was underneath it on
18284 * the stack will become visible.
18286 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18288 * @brief Moves an object already in the pager stack to the top of the stack.
18290 * @param obj The pager object
18291 * @param content The object to promote
18293 * This will take the @p content and move it to the top of the stack as
18294 * if it had been pushed there.
18296 * @note If the content isn't already in the stack use
18297 * elm_pager_content_push().
18298 * @warning Using this function on @p content not already in the stack
18299 * results in undefined behavior.
18301 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18303 * @brief Return the object at the bottom of the pager stack
18305 * @param obj The pager object
18306 * @return The bottom object or NULL if none
18308 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18310 * @brief Return the object at the top of the pager stack
18312 * @param obj The pager object
18313 * @return The top object or NULL if none
18315 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18321 * @defgroup Slideshow Slideshow
18323 * @image html img/widget/slideshow/preview-00.png
18324 * @image latex img/widget/slideshow/preview-00.eps
18326 * This widget, as the name indicates, is a pre-made image
18327 * slideshow panel, with API functions acting on (child) image
18328 * items presentation. Between those actions, are:
18329 * - advance to next/previous image
18330 * - select the style of image transition animation
18331 * - set the exhibition time for each image
18332 * - start/stop the slideshow
18334 * The transition animations are defined in the widget's theme,
18335 * consequently new animations can be added without having to
18336 * update the widget's code.
18338 * @section Slideshow_Items Slideshow items
18340 * For slideshow items, just like for @ref Genlist "genlist" ones,
18341 * the user defines a @b classes, specifying functions that will be
18342 * called on the item's creation and deletion times.
18344 * The #Elm_Slideshow_Item_Class structure contains the following
18347 * - @c func.get - When an item is displayed, this function is
18348 * called, and it's where one should create the item object, de
18349 * facto. For example, the object can be a pure Evas image object
18350 * or an Elementary @ref Photocam "photocam" widget. See
18351 * #SlideshowItemGetFunc.
18352 * - @c func.del - When an item is no more displayed, this function
18353 * is called, where the user must delete any data associated to
18354 * the item. See #SlideshowItemDelFunc.
18356 * @section Slideshow_Caching Slideshow caching
18358 * The slideshow provides facilities to have items adjacent to the
18359 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18360 * you, so that the system does not have to decode image data
18361 * anymore at the time it has to actually switch images on its
18362 * viewport. The user is able to set the numbers of items to be
18363 * cached @b before and @b after the current item, in the widget's
18366 * Smart events one can add callbacks for are:
18368 * - @c "changed" - when the slideshow switches its view to a new
18371 * List of examples for the slideshow widget:
18372 * @li @ref slideshow_example
18376 * @addtogroup Slideshow
18380 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18381 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18382 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18383 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18384 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18387 * @struct _Elm_Slideshow_Item_Class
18389 * Slideshow item class definition. See @ref Slideshow_Items for
18392 struct _Elm_Slideshow_Item_Class
18394 struct _Elm_Slideshow_Item_Class_Func
18396 SlideshowItemGetFunc get;
18397 SlideshowItemDelFunc del;
18399 }; /**< #Elm_Slideshow_Item_Class member definitions */
18402 * Add a new slideshow widget to the given parent Elementary
18403 * (container) object
18405 * @param parent The parent object
18406 * @return A new slideshow widget handle or @c NULL, on errors
18408 * This function inserts a new slideshow widget on the canvas.
18410 * @ingroup Slideshow
18412 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18415 * Add (append) a new item in a given slideshow widget.
18417 * @param obj The slideshow object
18418 * @param itc The item class for the item
18419 * @param data The item's data
18420 * @return A handle to the item added or @c NULL, on errors
18422 * Add a new item to @p obj's internal list of items, appending it.
18423 * The item's class must contain the function really fetching the
18424 * image object to show for this item, which could be an Evas image
18425 * object or an Elementary photo, for example. The @p data
18426 * parameter is going to be passed to both class functions of the
18429 * @see #Elm_Slideshow_Item_Class
18430 * @see elm_slideshow_item_sorted_insert()
18432 * @ingroup Slideshow
18434 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18437 * Insert a new item into the given slideshow widget, using the @p func
18438 * function to sort items (by item handles).
18440 * @param obj The slideshow object
18441 * @param itc The item class for the item
18442 * @param data The item's data
18443 * @param func The comparing function to be used to sort slideshow
18444 * items <b>by #Elm_Slideshow_Item item handles</b>
18445 * @return Returns The slideshow item handle, on success, or
18446 * @c NULL, on errors
18448 * Add a new item to @p obj's internal list of items, in a position
18449 * determined by the @p func comparing function. The item's class
18450 * must contain the function really fetching the image object to
18451 * show for this item, which could be an Evas image object or an
18452 * Elementary photo, for example. The @p data parameter is going to
18453 * be passed to both class functions of the item.
18455 * @see #Elm_Slideshow_Item_Class
18456 * @see elm_slideshow_item_add()
18458 * @ingroup Slideshow
18460 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);
18463 * Display a given slideshow widget's item, programmatically.
18465 * @param obj The slideshow object
18466 * @param item The item to display on @p obj's viewport
18468 * The change between the current item and @p item will use the
18469 * transition @p obj is set to use (@see
18470 * elm_slideshow_transition_set()).
18472 * @ingroup Slideshow
18474 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18477 * Slide to the @b next item, in a given slideshow widget
18479 * @param obj The slideshow object
18481 * The sliding animation @p obj is set to use will be the
18482 * transition effect used, after this call is issued.
18484 * @note If the end of the slideshow's internal list of items is
18485 * reached, it'll wrap around to the list's beginning, again.
18487 * @ingroup Slideshow
18489 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18492 * Slide to the @b previous item, in a given slideshow widget
18494 * @param obj The slideshow object
18496 * The sliding animation @p obj is set to use will be the
18497 * transition effect used, after this call is issued.
18499 * @note If the beginning of the slideshow's internal list of items
18500 * is reached, it'll wrap around to the list's end, again.
18502 * @ingroup Slideshow
18504 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18507 * Returns the list of sliding transition/effect names available, for a
18508 * given slideshow widget.
18510 * @param obj The slideshow object
18511 * @return The list of transitions (list of @b stringshared strings
18514 * The transitions, which come from @p obj's theme, must be an EDC
18515 * data item named @c "transitions" on the theme file, with (prefix)
18516 * names of EDC programs actually implementing them.
18518 * The available transitions for slideshows on the default theme are:
18519 * - @c "fade" - the current item fades out, while the new one
18520 * fades in to the slideshow's viewport.
18521 * - @c "black_fade" - the current item fades to black, and just
18522 * then, the new item will fade in.
18523 * - @c "horizontal" - the current item slides horizontally, until
18524 * it gets out of the slideshow's viewport, while the new item
18525 * comes from the left to take its place.
18526 * - @c "vertical" - the current item slides vertically, until it
18527 * gets out of the slideshow's viewport, while the new item comes
18528 * from the bottom to take its place.
18529 * - @c "square" - the new item starts to appear from the middle of
18530 * the current one, but with a tiny size, growing until its
18531 * target (full) size and covering the old one.
18533 * @warning The stringshared strings get no new references
18534 * exclusive to the user grabbing the list, here, so if you'd like
18535 * to use them out of this call's context, you'd better @c
18536 * eina_stringshare_ref() them.
18538 * @see elm_slideshow_transition_set()
18540 * @ingroup Slideshow
18542 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18545 * Set the current slide transition/effect in use for a given
18548 * @param obj The slideshow object
18549 * @param transition The new transition's name string
18551 * If @p transition is implemented in @p obj's theme (i.e., is
18552 * contained in the list returned by
18553 * elm_slideshow_transitions_get()), this new sliding effect will
18554 * be used on the widget.
18556 * @see elm_slideshow_transitions_get() for more details
18558 * @ingroup Slideshow
18560 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18563 * Get the current slide transition/effect in use for a given
18566 * @param obj The slideshow object
18567 * @return The current transition's name
18569 * @see elm_slideshow_transition_set() for more details
18571 * @ingroup Slideshow
18573 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18576 * Set the interval between each image transition on a given
18577 * slideshow widget, <b>and start the slideshow, itself</b>
18579 * @param obj The slideshow object
18580 * @param timeout The new displaying timeout for images
18582 * After this call, the slideshow widget will start cycling its
18583 * view, sequentially and automatically, with the images of the
18584 * items it has. The time between each new image displayed is going
18585 * to be @p timeout, in @b seconds. If a different timeout was set
18586 * previously and an slideshow was in progress, it will continue
18587 * with the new time between transitions, after this call.
18589 * @note A value less than or equal to 0 on @p timeout will disable
18590 * the widget's internal timer, thus halting any slideshow which
18591 * could be happening on @p obj.
18593 * @see elm_slideshow_timeout_get()
18595 * @ingroup Slideshow
18597 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18600 * Get the interval set for image transitions on a given slideshow
18603 * @param obj The slideshow object
18604 * @return Returns the timeout set on it
18606 * @see elm_slideshow_timeout_set() for more details
18608 * @ingroup Slideshow
18610 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18613 * Set if, after a slideshow is started, for a given slideshow
18614 * widget, its items should be displayed cyclically or not.
18616 * @param obj The slideshow object
18617 * @param loop Use @c EINA_TRUE to make it cycle through items or
18618 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18621 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18622 * ignore what is set by this functions, i.e., they'll @b always
18623 * cycle through items. This affects only the "automatic"
18624 * slideshow, as set by elm_slideshow_timeout_set().
18626 * @see elm_slideshow_loop_get()
18628 * @ingroup Slideshow
18630 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18633 * Get if, after a slideshow is started, for a given slideshow
18634 * widget, its items are to be displayed cyclically or not.
18636 * @param obj The slideshow object
18637 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18638 * through or @c EINA_FALSE, otherwise
18640 * @see elm_slideshow_loop_set() for more details
18642 * @ingroup Slideshow
18644 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18647 * Remove all items from a given slideshow widget
18649 * @param obj The slideshow object
18651 * This removes (and deletes) all items in @p obj, leaving it
18654 * @see elm_slideshow_item_del(), to remove just one item.
18656 * @ingroup Slideshow
18658 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18661 * Get the internal list of items in a given slideshow widget.
18663 * @param obj The slideshow object
18664 * @return The list of items (#Elm_Slideshow_Item as data) or
18665 * @c NULL on errors.
18667 * This list is @b not to be modified in any way and must not be
18668 * freed. Use the list members with functions like
18669 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18671 * @warning This list is only valid until @p obj object's internal
18672 * items list is changed. It should be fetched again with another
18673 * call to this function when changes happen.
18675 * @ingroup Slideshow
18677 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18680 * Delete a given item from a slideshow widget.
18682 * @param item The slideshow item
18684 * @ingroup Slideshow
18686 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18689 * Return the data associated with a given slideshow item
18691 * @param item The slideshow item
18692 * @return Returns the data associated to this item
18694 * @ingroup Slideshow
18696 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18699 * Returns the currently displayed item, in a given slideshow widget
18701 * @param obj The slideshow object
18702 * @return A handle to the item being displayed in @p obj or
18703 * @c NULL, if none is (and on errors)
18705 * @ingroup Slideshow
18707 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18710 * Get the real Evas object created to implement the view of a
18711 * given slideshow item
18713 * @param item The slideshow item.
18714 * @return the Evas object implementing this item's view.
18716 * This returns the actual Evas object used to implement the
18717 * specified slideshow item's view. This may be @c NULL, as it may
18718 * not have been created or may have been deleted, at any time, by
18719 * the slideshow. <b>Do not modify this object</b> (move, resize,
18720 * show, hide, etc.), as the slideshow is controlling it. This
18721 * function is for querying, emitting custom signals or hooking
18722 * lower level callbacks for events on that object. Do not delete
18723 * this object under any circumstances.
18725 * @see elm_slideshow_item_data_get()
18727 * @ingroup Slideshow
18729 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18732 * Get the the item, in a given slideshow widget, placed at
18733 * position @p nth, in its internal items list
18735 * @param obj The slideshow object
18736 * @param nth The number of the item to grab a handle to (0 being
18738 * @return The item stored in @p obj at position @p nth or @c NULL,
18739 * if there's no item with that index (and on errors)
18741 * @ingroup Slideshow
18743 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18746 * Set the current slide layout in use for a given slideshow widget
18748 * @param obj The slideshow object
18749 * @param layout The new layout's name string
18751 * If @p layout is implemented in @p obj's theme (i.e., is contained
18752 * in the list returned by elm_slideshow_layouts_get()), this new
18753 * images layout will be used on the widget.
18755 * @see elm_slideshow_layouts_get() for more details
18757 * @ingroup Slideshow
18759 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18762 * Get the current slide layout in use for a given slideshow widget
18764 * @param obj The slideshow object
18765 * @return The current layout's name
18767 * @see elm_slideshow_layout_set() for more details
18769 * @ingroup Slideshow
18771 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18774 * Returns the list of @b layout names available, for a given
18775 * slideshow widget.
18777 * @param obj The slideshow object
18778 * @return The list of layouts (list of @b stringshared strings
18781 * Slideshow layouts will change how the widget is to dispose each
18782 * image item in its viewport, with regard to cropping, scaling,
18785 * The layouts, which come from @p obj's theme, must be an EDC
18786 * data item name @c "layouts" on the theme file, with (prefix)
18787 * names of EDC programs actually implementing them.
18789 * The available layouts for slideshows on the default theme are:
18790 * - @c "fullscreen" - item images with original aspect, scaled to
18791 * touch top and down slideshow borders or, if the image's heigh
18792 * is not enough, left and right slideshow borders.
18793 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18794 * one, but always leaving 10% of the slideshow's dimensions of
18795 * distance between the item image's borders and the slideshow
18796 * borders, for each axis.
18798 * @warning The stringshared strings get no new references
18799 * exclusive to the user grabbing the list, here, so if you'd like
18800 * to use them out of this call's context, you'd better @c
18801 * eina_stringshare_ref() them.
18803 * @see elm_slideshow_layout_set()
18805 * @ingroup Slideshow
18807 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18810 * Set the number of items to cache, on a given slideshow widget,
18811 * <b>before the current item</b>
18813 * @param obj The slideshow object
18814 * @param count Number of items to cache before the current one
18816 * The default value for this property is @c 2. See
18817 * @ref Slideshow_Caching "slideshow caching" for more details.
18819 * @see elm_slideshow_cache_before_get()
18821 * @ingroup Slideshow
18823 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18826 * Retrieve the number of items to cache, on a given slideshow widget,
18827 * <b>before the current item</b>
18829 * @param obj The slideshow object
18830 * @return The number of items set to be cached before the current one
18832 * @see elm_slideshow_cache_before_set() for more details
18834 * @ingroup Slideshow
18836 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18839 * Set the number of items to cache, on a given slideshow widget,
18840 * <b>after the current item</b>
18842 * @param obj The slideshow object
18843 * @param count Number of items to cache after the current one
18845 * The default value for this property is @c 2. See
18846 * @ref Slideshow_Caching "slideshow caching" for more details.
18848 * @see elm_slideshow_cache_after_get()
18850 * @ingroup Slideshow
18852 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18855 * Retrieve the number of items to cache, on a given slideshow widget,
18856 * <b>after the current item</b>
18858 * @param obj The slideshow object
18859 * @return The number of items set to be cached after the current one
18861 * @see elm_slideshow_cache_after_set() for more details
18863 * @ingroup Slideshow
18865 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18868 * Get the number of items stored in a given slideshow widget
18870 * @param obj The slideshow object
18871 * @return The number of items on @p obj, at the moment of this call
18873 * @ingroup Slideshow
18875 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18882 * @defgroup Fileselector File Selector
18884 * @image html img/widget/fileselector/preview-00.png
18885 * @image latex img/widget/fileselector/preview-00.eps
18887 * A file selector is a widget that allows a user to navigate
18888 * through a file system, reporting file selections back via its
18891 * It contains shortcut buttons for home directory (@c ~) and to
18892 * jump one directory upwards (..), as well as cancel/ok buttons to
18893 * confirm/cancel a given selection. After either one of those two
18894 * former actions, the file selector will issue its @c "done" smart
18897 * There's a text entry on it, too, showing the name of the current
18898 * selection. There's the possibility of making it editable, so it
18899 * is useful on file saving dialogs on applications, where one
18900 * gives a file name to save contents to, in a given directory in
18901 * the system. This custom file name will be reported on the @c
18902 * "done" smart callback (explained in sequence).
18904 * Finally, it has a view to display file system items into in two
18909 * If Elementary is built with support of the Ethumb thumbnailing
18910 * library, the second form of view will display preview thumbnails
18911 * of files which it supports.
18913 * Smart callbacks one can register to:
18915 * - @c "selected" - the user has clicked on a file (when not in
18916 * folders-only mode) or directory (when in folders-only mode)
18917 * - @c "directory,open" - the list has been populated with new
18918 * content (@c event_info is a pointer to the directory's
18919 * path, a @b stringshared string)
18920 * - @c "done" - the user has clicked on the "ok" or "cancel"
18921 * buttons (@c event_info is a pointer to the selection's
18922 * path, a @b stringshared string)
18924 * Here is an example on its usage:
18925 * @li @ref fileselector_example
18929 * @addtogroup Fileselector
18934 * Defines how a file selector widget is to layout its contents
18935 * (file system entries).
18937 typedef enum _Elm_Fileselector_Mode
18939 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18940 ELM_FILESELECTOR_GRID, /**< layout as a grid */
18941 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18942 } Elm_Fileselector_Mode;
18945 * Add a new file selector widget to the given parent Elementary
18946 * (container) object
18948 * @param parent The parent object
18949 * @return a new file selector widget handle or @c NULL, on errors
18951 * This function inserts a new file selector widget on the canvas.
18953 * @ingroup Fileselector
18955 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18958 * Enable/disable the file name entry box where the user can type
18959 * in a name for a file, in a given file selector widget
18961 * @param obj The file selector object
18962 * @param is_save @c EINA_TRUE to make the file selector a "saving
18963 * dialog", @c EINA_FALSE otherwise
18965 * Having the entry editable is useful on file saving dialogs on
18966 * applications, where one gives a file name to save contents to,
18967 * in a given directory in the system. This custom file name will
18968 * be reported on the @c "done" smart callback.
18970 * @see elm_fileselector_is_save_get()
18972 * @ingroup Fileselector
18974 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
18977 * Get whether the given file selector is in "saving dialog" mode
18979 * @param obj The file selector object
18980 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
18981 * mode, @c EINA_FALSE otherwise (and on errors)
18983 * @see elm_fileselector_is_save_set() for more details
18985 * @ingroup Fileselector
18987 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18990 * Enable/disable folder-only view for a given file selector widget
18992 * @param obj The file selector object
18993 * @param only @c EINA_TRUE to make @p obj only display
18994 * directories, @c EINA_FALSE to make files to be displayed in it
18997 * If enabled, the widget's view will only display folder items,
19000 * @see elm_fileselector_folder_only_get()
19002 * @ingroup Fileselector
19004 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19007 * Get whether folder-only view is set for a given file selector
19010 * @param obj The file selector object
19011 * @return only @c EINA_TRUE if @p obj is only displaying
19012 * directories, @c EINA_FALSE if files are being displayed in it
19013 * too (and on errors)
19015 * @see elm_fileselector_folder_only_get()
19017 * @ingroup Fileselector
19019 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19022 * Enable/disable the "ok" and "cancel" buttons on a given file
19025 * @param obj The file selector object
19026 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19028 * @note A file selector without those buttons will never emit the
19029 * @c "done" smart event, and is only usable if one is just hooking
19030 * to the other two events.
19032 * @see elm_fileselector_buttons_ok_cancel_get()
19034 * @ingroup Fileselector
19036 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19039 * Get whether the "ok" and "cancel" buttons on a given file
19040 * selector widget are being shown.
19042 * @param obj The file selector object
19043 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19044 * otherwise (and on errors)
19046 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19048 * @ingroup Fileselector
19050 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19053 * Enable/disable a tree view in the given file selector widget,
19054 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19056 * @param obj The file selector object
19057 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19060 * In a tree view, arrows are created on the sides of directories,
19061 * allowing them to expand in place.
19063 * @note If it's in other mode, the changes made by this function
19064 * will only be visible when one switches back to "list" mode.
19066 * @see elm_fileselector_expandable_get()
19068 * @ingroup Fileselector
19070 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19073 * Get whether tree view is enabled for the given file selector
19076 * @param obj The file selector object
19077 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19078 * otherwise (and or errors)
19080 * @see elm_fileselector_expandable_set() for more details
19082 * @ingroup Fileselector
19084 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19087 * Set, programmatically, the @b directory that a given file
19088 * selector widget will display contents from
19090 * @param obj The file selector object
19091 * @param path The path to display in @p obj
19093 * This will change the @b directory that @p obj is displaying. It
19094 * will also clear the text entry area on the @p obj object, which
19095 * displays select files' names.
19097 * @see elm_fileselector_path_get()
19099 * @ingroup Fileselector
19101 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19104 * Get the parent directory's path that a given file selector
19105 * widget is displaying
19107 * @param obj The file selector object
19108 * @return The (full) path of the directory the file selector is
19109 * displaying, a @b stringshared string
19111 * @see elm_fileselector_path_set()
19113 * @ingroup Fileselector
19115 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19118 * Set, programmatically, the currently selected file/directory in
19119 * the given file selector widget
19121 * @param obj The file selector object
19122 * @param path The (full) path to a file or directory
19123 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19124 * latter case occurs if the directory or file pointed to do not
19127 * @see elm_fileselector_selected_get()
19129 * @ingroup Fileselector
19131 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19134 * Get the currently selected item's (full) path, in the given file
19137 * @param obj The file selector object
19138 * @return The absolute path of the selected item, a @b
19139 * stringshared string
19141 * @note Custom editions on @p obj object's text entry, if made,
19142 * will appear on the return string of this function, naturally.
19144 * @see elm_fileselector_selected_set() for more details
19146 * @ingroup Fileselector
19148 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19151 * Set the mode in which a given file selector widget will display
19152 * (layout) file system entries in its view
19154 * @param obj The file selector object
19155 * @param mode The mode of the fileselector, being it one of
19156 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19157 * first one, naturally, will display the files in a list. The
19158 * latter will make the widget to display its entries in a grid
19161 * @note By using elm_fileselector_expandable_set(), the user may
19162 * trigger a tree view for that list.
19164 * @note If Elementary is built with support of the Ethumb
19165 * thumbnailing library, the second form of view will display
19166 * preview thumbnails of files which it supports. You must have
19167 * elm_need_ethumb() called in your Elementary for thumbnailing to
19170 * @see elm_fileselector_expandable_set().
19171 * @see elm_fileselector_mode_get().
19173 * @ingroup Fileselector
19175 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19178 * Get the mode in which a given file selector widget is displaying
19179 * (layouting) file system entries in its view
19181 * @param obj The fileselector object
19182 * @return The mode in which the fileselector is at
19184 * @see elm_fileselector_mode_set() for more details
19186 * @ingroup Fileselector
19188 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19195 * @defgroup Progressbar Progress bar
19197 * The progress bar is a widget for visually representing the
19198 * progress status of a given job/task.
19200 * A progress bar may be horizontal or vertical. It may display an
19201 * icon besides it, as well as primary and @b units labels. The
19202 * former is meant to label the widget as a whole, while the
19203 * latter, which is formatted with floating point values (and thus
19204 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19205 * units"</c>), is meant to label the widget's <b>progress
19206 * value</b>. Label, icon and unit strings/objects are @b optional
19207 * for progress bars.
19209 * A progress bar may be @b inverted, in which state it gets its
19210 * values inverted, with high values being on the left or top and
19211 * low values on the right or bottom, as opposed to normally have
19212 * the low values on the former and high values on the latter,
19213 * respectively, for horizontal and vertical modes.
19215 * The @b span of the progress, as set by
19216 * elm_progressbar_span_size_set(), is its length (horizontally or
19217 * vertically), unless one puts size hints on the widget to expand
19218 * on desired directions, by any container. That length will be
19219 * scaled by the object or applications scaling factor. At any
19220 * point code can query the progress bar for its value with
19221 * elm_progressbar_value_get().
19223 * Available widget styles for progress bars:
19225 * - @c "wheel" (simple style, no text, no progression, only
19226 * "pulse" effect is available)
19228 * Here is an example on its usage:
19229 * @li @ref progressbar_example
19233 * Add a new progress bar widget to the given parent Elementary
19234 * (container) object
19236 * @param parent The parent object
19237 * @return a new progress bar widget handle or @c NULL, on errors
19239 * This function inserts a new progress bar widget on the canvas.
19241 * @ingroup Progressbar
19243 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19246 * Set whether a given progress bar widget is at "pulsing mode" or
19249 * @param obj The progress bar object
19250 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19251 * @c EINA_FALSE to put it back to its default one
19253 * By default, progress bars will display values from the low to
19254 * high value boundaries. There are, though, contexts in which the
19255 * state of progression of a given task is @b unknown. For those,
19256 * one can set a progress bar widget to a "pulsing state", to give
19257 * the user an idea that some computation is being held, but
19258 * without exact progress values. In the default theme it will
19259 * animate its bar with the contents filling in constantly and back
19260 * to non-filled, in a loop. To start and stop this pulsing
19261 * animation, one has to explicitly call elm_progressbar_pulse().
19263 * @see elm_progressbar_pulse_get()
19264 * @see elm_progressbar_pulse()
19266 * @ingroup Progressbar
19268 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19271 * Get whether a given progress bar widget is at "pulsing mode" or
19274 * @param obj The progress bar object
19275 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19276 * if it's in the default one (and on errors)
19278 * @ingroup Progressbar
19280 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19283 * Start/stop a given progress bar "pulsing" animation, if its
19286 * @param obj The progress bar object
19287 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19288 * @c EINA_FALSE to @b stop it
19290 * @note This call won't do anything if @p obj is not under "pulsing mode".
19292 * @see elm_progressbar_pulse_set() for more details.
19294 * @ingroup Progressbar
19296 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19299 * Set the progress value (in percentage) on a given progress bar
19302 * @param obj The progress bar object
19303 * @param val The progress value (@b must be between @c 0.0 and @c
19306 * Use this call to set progress bar levels.
19308 * @note If you passes a value out of the specified range for @p
19309 * val, it will be interpreted as the @b closest of the @b boundary
19310 * values in the range.
19312 * @ingroup Progressbar
19314 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19317 * Get the progress value (in percentage) on a given progress bar
19320 * @param obj The progress bar object
19321 * @return The value of the progressbar
19323 * @see elm_progressbar_value_set() for more details
19325 * @ingroup Progressbar
19327 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19330 * Set the label of a given progress bar widget
19332 * @param obj The progress bar object
19333 * @param label The text label string, in UTF-8
19335 * @ingroup Progressbar
19336 * @deprecated use elm_object_text_set() instead.
19338 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19341 * Get the label of a given progress bar widget
19343 * @param obj The progressbar object
19344 * @return The text label string, in UTF-8
19346 * @ingroup Progressbar
19347 * @deprecated use elm_object_text_set() instead.
19349 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19352 * Set the icon object of a given progress bar widget
19354 * @param obj The progress bar object
19355 * @param icon The icon object
19357 * Use this call to decorate @p obj with an icon next to it.
19359 * @note Once the icon object is set, a previously set one will be
19360 * deleted. If you want to keep that old content object, use the
19361 * elm_progressbar_icon_unset() function.
19363 * @see elm_progressbar_icon_get()
19365 * @ingroup Progressbar
19367 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19370 * Retrieve the icon object set for a given progress bar widget
19372 * @param obj The progress bar object
19373 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19374 * otherwise (and on errors)
19376 * @see elm_progressbar_icon_set() for more details
19378 * @ingroup Progressbar
19380 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19383 * Unset an icon set on a given progress bar widget
19385 * @param obj The progress bar object
19386 * @return The icon object that was being used, if any was set, or
19387 * @c NULL, otherwise (and on errors)
19389 * This call will unparent and return the icon object which was set
19390 * for this widget, previously, on success.
19392 * @see elm_progressbar_icon_set() for more details
19394 * @ingroup Progressbar
19396 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19399 * Set the (exact) length of the bar region of a given progress bar
19402 * @param obj The progress bar object
19403 * @param size The length of the progress bar's bar region
19405 * This sets the minimum width (when in horizontal mode) or height
19406 * (when in vertical mode) of the actual bar area of the progress
19407 * bar @p obj. This in turn affects the object's minimum size. Use
19408 * this when you're not setting other size hints expanding on the
19409 * given direction (like weight and alignment hints) and you would
19410 * like it to have a specific size.
19412 * @note Icon, label and unit text around @p obj will require their
19413 * own space, which will make @p obj to require more the @p size,
19416 * @see elm_progressbar_span_size_get()
19418 * @ingroup Progressbar
19420 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19423 * Get the length set for the bar region of a given progress bar
19426 * @param obj The progress bar object
19427 * @return The length of the progress bar's bar region
19429 * If that size was not set previously, with
19430 * elm_progressbar_span_size_set(), this call will return @c 0.
19432 * @ingroup Progressbar
19434 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19437 * Set the format string for a given progress bar widget's units
19440 * @param obj The progress bar object
19441 * @param format The format string for @p obj's units label
19443 * If @c NULL is passed on @p format, it will make @p obj's units
19444 * area to be hidden completely. If not, it'll set the <b>format
19445 * string</b> for the units label's @b text. The units label is
19446 * provided a floating point value, so the units text is up display
19447 * at most one floating point falue. Note that the units label is
19448 * optional. Use a format string such as "%1.2f meters" for
19451 * @note The default format string for a progress bar is an integer
19452 * percentage, as in @c "%.0f %%".
19454 * @see elm_progressbar_unit_format_get()
19456 * @ingroup Progressbar
19458 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19461 * Retrieve the format string set for a given progress bar widget's
19464 * @param obj The progress bar object
19465 * @return The format set string for @p obj's units label or
19466 * @c NULL, if none was set (and on errors)
19468 * @see elm_progressbar_unit_format_set() for more details
19470 * @ingroup Progressbar
19472 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19475 * Set the orientation of a given progress bar widget
19477 * @param obj The progress bar object
19478 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19479 * @b horizontal, @c EINA_FALSE to make it @b vertical
19481 * Use this function to change how your progress bar is to be
19482 * disposed: vertically or horizontally.
19484 * @see elm_progressbar_horizontal_get()
19486 * @ingroup Progressbar
19488 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19491 * Retrieve the orientation of a given progress bar widget
19493 * @param obj The progress bar object
19494 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19495 * @c EINA_FALSE if it's @b vertical (and on errors)
19497 * @see elm_progressbar_horizontal_set() for more details
19499 * @ingroup Progressbar
19501 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19504 * Invert a given progress bar widget's displaying values order
19506 * @param obj The progress bar object
19507 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19508 * @c EINA_FALSE to bring it back to default, non-inverted values.
19510 * A progress bar may be @b inverted, in which state it gets its
19511 * values inverted, with high values being on the left or top and
19512 * low values on the right or bottom, as opposed to normally have
19513 * the low values on the former and high values on the latter,
19514 * respectively, for horizontal and vertical modes.
19516 * @see elm_progressbar_inverted_get()
19518 * @ingroup Progressbar
19520 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19523 * Get whether a given progress bar widget's displaying values are
19526 * @param obj The progress bar object
19527 * @return @c EINA_TRUE, if @p obj has inverted values,
19528 * @c EINA_FALSE otherwise (and on errors)
19530 * @see elm_progressbar_inverted_set() for more details
19532 * @ingroup Progressbar
19534 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19537 * @defgroup Separator Separator
19539 * @brief Separator is a very thin object used to separate other objects.
19541 * A separator can be vertical or horizontal.
19543 * @ref tutorial_separator is a good example of how to use a separator.
19547 * @brief Add a separator object to @p parent
19549 * @param parent The parent object
19551 * @return The separator object, or NULL upon failure
19553 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19555 * @brief Set the horizontal mode of a separator object
19557 * @param obj The separator object
19558 * @param horizontal If true, the separator is horizontal
19560 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19562 * @brief Get the horizontal mode of a separator object
19564 * @param obj The separator object
19565 * @return If true, the separator is horizontal
19567 * @see elm_separator_horizontal_set()
19569 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19575 * @defgroup Spinner Spinner
19576 * @ingroup Elementary
19578 * @image html img/widget/spinner/preview-00.png
19579 * @image latex img/widget/spinner/preview-00.eps
19581 * A spinner is a widget which allows the user to increase or decrease
19582 * numeric values using arrow buttons, or edit values directly, clicking
19583 * over it and typing the new value.
19585 * By default the spinner will not wrap and has a label
19586 * of "%.0f" (just showing the integer value of the double).
19588 * A spinner has a label that is formatted with floating
19589 * point values and thus accepts a printf-style format string, like
19592 * It also allows specific values to be replaced by pre-defined labels.
19594 * Smart callbacks one can register to:
19596 * - "changed" - Whenever the spinner value is changed.
19597 * - "delay,changed" - A short time after the value is changed by the user.
19598 * This will be called only when the user stops dragging for a very short
19599 * period or when they release their finger/mouse, so it avoids possibly
19600 * expensive reactions to the value change.
19602 * Available styles for it:
19604 * - @c "vertical": up/down buttons at the right side and text left aligned.
19606 * Here is an example on its usage:
19607 * @ref spinner_example
19611 * @addtogroup Spinner
19616 * Add a new spinner widget to the given parent Elementary
19617 * (container) object.
19619 * @param parent The parent object.
19620 * @return a new spinner widget handle or @c NULL, on errors.
19622 * This function inserts a new spinner widget on the canvas.
19627 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19630 * Set the format string of the displayed label.
19632 * @param obj The spinner object.
19633 * @param fmt The format string for the label display.
19635 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19636 * string for the label text. The label text is provided a floating point
19637 * value, so the label text can display up to 1 floating point value.
19638 * Note that this is optional.
19640 * Use a format string such as "%1.2f meters" for example, and it will
19641 * display values like: "3.14 meters" for a value equal to 3.14159.
19643 * Default is "%0.f".
19645 * @see elm_spinner_label_format_get()
19649 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19652 * Get the label format of the spinner.
19654 * @param obj The spinner object.
19655 * @return The text label format string in UTF-8.
19657 * @see elm_spinner_label_format_set() for details.
19661 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19664 * Set the minimum and maximum values for the spinner.
19666 * @param obj The spinner object.
19667 * @param min The minimum value.
19668 * @param max The maximum value.
19670 * Define the allowed range of values to be selected by the user.
19672 * If actual value is less than @p min, it will be updated to @p min. If it
19673 * is bigger then @p max, will be updated to @p max. Actual value can be
19674 * get with elm_spinner_value_get().
19676 * By default, min is equal to 0, and max is equal to 100.
19678 * @warning Maximum must be greater than minimum.
19680 * @see elm_spinner_min_max_get()
19684 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19687 * Get the minimum and maximum values of the spinner.
19689 * @param obj The spinner object.
19690 * @param min Pointer where to store the minimum value.
19691 * @param max Pointer where to store the maximum value.
19693 * @note If only one value is needed, the other pointer can be passed
19696 * @see elm_spinner_min_max_set() for details.
19700 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19703 * Set the step used to increment or decrement the spinner value.
19705 * @param obj The spinner object.
19706 * @param step The step value.
19708 * This value will be incremented or decremented to the displayed value.
19709 * It will be incremented while the user keep right or top arrow pressed,
19710 * and will be decremented while the user keep left or bottom arrow pressed.
19712 * The interval to increment / decrement can be set with
19713 * elm_spinner_interval_set().
19715 * By default step value is equal to 1.
19717 * @see elm_spinner_step_get()
19721 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19724 * Get the step used to increment or decrement the spinner value.
19726 * @param obj The spinner object.
19727 * @return The step value.
19729 * @see elm_spinner_step_get() for more details.
19733 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19736 * Set the value the spinner displays.
19738 * @param obj The spinner object.
19739 * @param val The value to be displayed.
19741 * Value will be presented on the label following format specified with
19742 * elm_spinner_format_set().
19744 * @warning The value must to be between min and max values. This values
19745 * are set by elm_spinner_min_max_set().
19747 * @see elm_spinner_value_get().
19748 * @see elm_spinner_format_set().
19749 * @see elm_spinner_min_max_set().
19753 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19756 * Get the value displayed by the spinner.
19758 * @param obj The spinner object.
19759 * @return The value displayed.
19761 * @see elm_spinner_value_set() for details.
19765 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19768 * Set whether the spinner should wrap when it reaches its
19769 * minimum or maximum value.
19771 * @param obj The spinner object.
19772 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19775 * Disabled by default. If disabled, when the user tries to increment the
19777 * but displayed value plus step value is bigger than maximum value,
19779 * won't allow it. The same happens when the user tries to decrement it,
19780 * but the value less step is less than minimum value.
19782 * When wrap is enabled, in such situations it will allow these changes,
19783 * but will get the value that would be less than minimum and subtracts
19784 * from maximum. Or add the value that would be more than maximum to
19788 * @li min value = 10
19789 * @li max value = 50
19790 * @li step value = 20
19791 * @li displayed value = 20
19793 * When the user decrement value (using left or bottom arrow), it will
19794 * displays @c 40, because max - (min - (displayed - step)) is
19795 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19797 * @see elm_spinner_wrap_get().
19801 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19804 * Get whether the spinner should wrap when it reaches its
19805 * minimum or maximum value.
19807 * @param obj The spinner object
19808 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19809 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19811 * @see elm_spinner_wrap_set() for details.
19815 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19818 * Set whether the spinner can be directly edited by the user or not.
19820 * @param obj The spinner object.
19821 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19822 * don't allow users to edit it directly.
19824 * Spinner objects can have edition @b disabled, in which state they will
19825 * be changed only by arrows.
19826 * Useful for contexts
19827 * where you don't want your users to interact with it writting the value.
19829 * when using special values, the user can see real value instead
19830 * of special label on edition.
19832 * It's enabled by default.
19834 * @see elm_spinner_editable_get()
19838 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19841 * Get whether the spinner can be directly edited by the user or not.
19843 * @param obj The spinner object.
19844 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19845 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19847 * @see elm_spinner_editable_set() for details.
19851 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19854 * Set a special string to display in the place of the numerical value.
19856 * @param obj The spinner object.
19857 * @param value The value to be replaced.
19858 * @param label The label to be used.
19860 * It's useful for cases when a user should select an item that is
19861 * better indicated by a label than a value. For example, weekdays or months.
19865 * sp = elm_spinner_add(win);
19866 * elm_spinner_min_max_set(sp, 1, 3);
19867 * elm_spinner_special_value_add(sp, 1, "January");
19868 * elm_spinner_special_value_add(sp, 2, "February");
19869 * elm_spinner_special_value_add(sp, 3, "March");
19870 * evas_object_show(sp);
19875 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19878 * Set the interval on time updates for an user mouse button hold
19879 * on spinner widgets' arrows.
19881 * @param obj The spinner object.
19882 * @param interval The (first) interval value in seconds.
19884 * This interval value is @b decreased while the user holds the
19885 * mouse pointer either incrementing or decrementing spinner's value.
19887 * This helps the user to get to a given value distant from the
19888 * current one easier/faster, as it will start to change quicker and
19889 * quicker on mouse button holds.
19891 * The calculation for the next change interval value, starting from
19892 * the one set with this call, is the previous interval divided by
19893 * @c 1.05, so it decreases a little bit.
19895 * The default starting interval value for automatic changes is
19898 * @see elm_spinner_interval_get()
19902 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19905 * Get the interval on time updates for an user mouse button hold
19906 * on spinner widgets' arrows.
19908 * @param obj The spinner object.
19909 * @return The (first) interval value, in seconds, set on it.
19911 * @see elm_spinner_interval_set() for more details.
19915 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19922 * @defgroup Index Index
19924 * @image html img/widget/index/preview-00.png
19925 * @image latex img/widget/index/preview-00.eps
19927 * An index widget gives you an index for fast access to whichever
19928 * group of other UI items one might have. It's a list of text
19929 * items (usually letters, for alphabetically ordered access).
19931 * Index widgets are by default hidden and just appear when the
19932 * user clicks over it's reserved area in the canvas. In its
19933 * default theme, it's an area one @ref Fingers "finger" wide on
19934 * the right side of the index widget's container.
19936 * When items on the index are selected, smart callbacks get
19937 * called, so that its user can make other container objects to
19938 * show a given area or child object depending on the index item
19939 * selected. You'd probably be using an index together with @ref
19940 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19943 * Smart events one can add callbacks for are:
19944 * - @c "changed" - When the selected index item changes. @c
19945 * event_info is the selected item's data pointer.
19946 * - @c "delay,changed" - When the selected index item changes, but
19947 * after a small idling period. @c event_info is the selected
19948 * item's data pointer.
19949 * - @c "selected" - When the user releases a mouse button and
19950 * selects an item. @c event_info is the selected item's data
19952 * - @c "level,up" - when the user moves a finger from the first
19953 * level to the second level
19954 * - @c "level,down" - when the user moves a finger from the second
19955 * level to the first level
19957 * The @c "delay,changed" event is so that it'll wait a small time
19958 * before actually reporting those events and, moreover, just the
19959 * last event happening on those time frames will actually be
19962 * Here are some examples on its usage:
19963 * @li @ref index_example_01
19964 * @li @ref index_example_02
19968 * @addtogroup Index
19972 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
19975 * Add a new index widget to the given parent Elementary
19976 * (container) object
19978 * @param parent The parent object
19979 * @return a new index widget handle or @c NULL, on errors
19981 * This function inserts a new index widget on the canvas.
19985 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19988 * Set whether a given index widget is or not visible,
19991 * @param obj The index object
19992 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
19994 * Not to be confused with visible as in @c evas_object_show() --
19995 * visible with regard to the widget's auto hiding feature.
19997 * @see elm_index_active_get()
20001 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20004 * Get whether a given index widget is currently visible or not.
20006 * @param obj The index object
20007 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20009 * @see elm_index_active_set() for more details
20013 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20016 * Set the items level for a given index widget.
20018 * @param obj The index object.
20019 * @param level @c 0 or @c 1, the currently implemented levels.
20021 * @see elm_index_item_level_get()
20025 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20028 * Get the items level set for a given index widget.
20030 * @param obj The index object.
20031 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20033 * @see elm_index_item_level_set() for more information
20037 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * Returns the last selected item's data, for a given index widget.
20042 * @param obj The index object.
20043 * @return The item @b data associated to the last selected item on
20044 * @p obj (or @c NULL, on errors).
20046 * @warning The returned value is @b not an #Elm_Index_Item item
20047 * handle, but the data associated to it (see the @c item parameter
20048 * in elm_index_item_append(), as an example).
20052 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20055 * Append a new item on a given index widget.
20057 * @param obj The index object.
20058 * @param letter Letter under which the item should be indexed
20059 * @param item The item data to set for the index's item
20061 * Despite the most common usage of the @p letter argument is for
20062 * single char strings, one could use arbitrary strings as index
20065 * @c item will be the pointer returned back on @c "changed", @c
20066 * "delay,changed" and @c "selected" smart events.
20070 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20073 * Prepend a new item on a given index widget.
20075 * @param obj The index object.
20076 * @param letter Letter under which the item should be indexed
20077 * @param item The item data to set for the index's item
20079 * Despite the most common usage of the @p letter argument is for
20080 * single char strings, one could use arbitrary strings as index
20083 * @c item will be the pointer returned back on @c "changed", @c
20084 * "delay,changed" and @c "selected" smart events.
20088 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20091 * Append a new item, on a given index widget, <b>after the item
20092 * having @p relative as data</b>.
20094 * @param obj The index object.
20095 * @param letter Letter under which the item should be indexed
20096 * @param item The item data to set for the index's item
20097 * @param relative The item data of the index item to be the
20098 * predecessor of this new one
20100 * Despite the most common usage of the @p letter argument is for
20101 * single char strings, one could use arbitrary strings as index
20104 * @c item will be the pointer returned back on @c "changed", @c
20105 * "delay,changed" and @c "selected" smart events.
20107 * @note If @p relative is @c NULL or if it's not found to be data
20108 * set on any previous item on @p obj, this function will behave as
20109 * elm_index_item_append().
20113 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20116 * Prepend a new item, on a given index widget, <b>after the item
20117 * having @p relative as data</b>.
20119 * @param obj The index object.
20120 * @param letter Letter under which the item should be indexed
20121 * @param item The item data to set for the index's item
20122 * @param relative The item data of the index item to be the
20123 * successor of this new one
20125 * Despite the most common usage of the @p letter argument is for
20126 * single char strings, one could use arbitrary strings as index
20129 * @c item will be the pointer returned back on @c "changed", @c
20130 * "delay,changed" and @c "selected" smart events.
20132 * @note If @p relative is @c NULL or if it's not found to be data
20133 * set on any previous item on @p obj, this function will behave as
20134 * elm_index_item_prepend().
20138 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20141 * Insert a new item into the given index widget, using @p cmp_func
20142 * function to sort items (by item handles).
20144 * @param obj The index object.
20145 * @param letter Letter under which the item should be indexed
20146 * @param item The item data to set for the index's item
20147 * @param cmp_func The comparing function to be used to sort index
20148 * items <b>by #Elm_Index_Item item handles</b>
20149 * @param cmp_data_func A @b fallback function to be called for the
20150 * sorting of index items <b>by item data</b>). It will be used
20151 * when @p cmp_func returns @c 0 (equality), which means an index
20152 * item with provided item data already exists. To decide which
20153 * data item should be pointed to by the index item in question, @p
20154 * cmp_data_func will be used. If @p cmp_data_func returns a
20155 * non-negative value, the previous index item data will be
20156 * replaced by the given @p item pointer. If the previous data need
20157 * to be freed, it should be done by the @p cmp_data_func function,
20158 * because all references to it will be lost. If this function is
20159 * not provided (@c NULL is given), index items will be @b
20160 * duplicated, if @p cmp_func returns @c 0.
20162 * Despite the most common usage of the @p letter argument is for
20163 * single char strings, one could use arbitrary strings as index
20166 * @c item will be the pointer returned back on @c "changed", @c
20167 * "delay,changed" and @c "selected" smart events.
20171 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);
20174 * Remove an item from a given index widget, <b>to be referenced by
20175 * it's data value</b>.
20177 * @param obj The index object
20178 * @param item The item's data pointer for the item to be removed
20181 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20182 * that callback function will be called by this one.
20184 * @warning The item to be removed from @p obj will be found via
20185 * its item data pointer, and not by an #Elm_Index_Item handle.
20189 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20192 * Find a given index widget's item, <b>using item data</b>.
20194 * @param obj The index object
20195 * @param item The item data pointed to by the desired index item
20196 * @return The index item handle, if found, or @c NULL otherwise
20200 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20203 * Removes @b all items from a given index widget.
20205 * @param obj The index object.
20207 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20208 * that callback function will be called for each item in @p obj.
20212 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20215 * Go to a given items level on a index widget
20217 * @param obj The index object
20218 * @param level The index level (one of @c 0 or @c 1)
20222 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20225 * Return the data associated with a given index widget item
20227 * @param it The index widget item handle
20228 * @return The data associated with @p it
20230 * @see elm_index_item_data_set()
20234 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20237 * Set the data associated with a given index widget item
20239 * @param it The index widget item handle
20240 * @param data The new data pointer to set to @p it
20242 * This sets new item data on @p it.
20244 * @warning The old data pointer won't be touched by this function, so
20245 * the user had better to free that old data himself/herself.
20249 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20252 * Set the function to be called when a given index widget item is freed.
20254 * @param it The item to set the callback on
20255 * @param func The function to call on the item's deletion
20257 * When called, @p func will have both @c data and @c event_info
20258 * arguments with the @p it item's data value and, naturally, the
20259 * @c obj argument with a handle to the parent index widget.
20263 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20266 * Get the letter (string) set on a given index widget item.
20268 * @param it The index item handle
20269 * @return The letter string set on @p it
20273 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20280 * @defgroup Photocam Photocam
20282 * @image html img/widget/photocam/preview-00.png
20283 * @image latex img/widget/photocam/preview-00.eps
20285 * This is a widget specifically for displaying high-resolution digital
20286 * camera photos giving speedy feedback (fast load), low memory footprint
20287 * and zooming and panning as well as fitting logic. It is entirely focused
20288 * on jpeg images, and takes advantage of properties of the jpeg format (via
20289 * evas loader features in the jpeg loader).
20291 * Signals that you can add callbacks for are:
20292 * @li "clicked" - This is called when a user has clicked the photo without
20294 * @li "press" - This is called when a user has pressed down on the photo.
20295 * @li "longpressed" - This is called when a user has pressed down on the
20296 * photo for a long time without dragging around.
20297 * @li "clicked,double" - This is called when a user has double-clicked the
20299 * @li "load" - Photo load begins.
20300 * @li "loaded" - This is called when the image file load is complete for the
20301 * first view (low resolution blurry version).
20302 * @li "load,detail" - Photo detailed data load begins.
20303 * @li "loaded,detail" - This is called when the image file load is complete
20304 * for the detailed image data (full resolution needed).
20305 * @li "zoom,start" - Zoom animation started.
20306 * @li "zoom,stop" - Zoom animation stopped.
20307 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20308 * @li "scroll" - the content has been scrolled (moved)
20309 * @li "scroll,anim,start" - scrolling animation has started
20310 * @li "scroll,anim,stop" - scrolling animation has stopped
20311 * @li "scroll,drag,start" - dragging the contents around has started
20312 * @li "scroll,drag,stop" - dragging the contents around has stopped
20314 * @ref tutorial_photocam shows the API in action.
20318 * @brief Types of zoom available.
20320 typedef enum _Elm_Photocam_Zoom_Mode
20322 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20323 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20324 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20325 ELM_PHOTOCAM_ZOOM_MODE_LAST
20326 } Elm_Photocam_Zoom_Mode;
20328 * @brief Add a new Photocam object
20330 * @param parent The parent object
20331 * @return The new object or NULL if it cannot be created
20333 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20335 * @brief Set the photo file to be shown
20337 * @param obj The photocam object
20338 * @param file The photo file
20339 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20341 * This sets (and shows) the specified file (with a relative or absolute
20342 * path) and will return a load error (same error that
20343 * evas_object_image_load_error_get() will return). The image will change and
20344 * adjust its size at this point and begin a background load process for this
20345 * photo that at some time in the future will be displayed at the full
20348 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20350 * @brief Returns the path of the current image file
20352 * @param obj The photocam object
20353 * @return Returns the path
20355 * @see elm_photocam_file_set()
20357 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 * @brief Set the zoom level of the photo
20361 * @param obj The photocam object
20362 * @param zoom The zoom level to set
20364 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20365 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20366 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20367 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20370 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20372 * @brief Get the zoom level of the photo
20374 * @param obj The photocam object
20375 * @return The current zoom level
20377 * This returns the current zoom level of the photocam object. Note that if
20378 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20379 * (which is the default), the zoom level may be changed at any time by the
20380 * photocam object itself to account for photo size and photocam viewpoer
20383 * @see elm_photocam_zoom_set()
20384 * @see elm_photocam_zoom_mode_set()
20386 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20388 * @brief Set the zoom mode
20390 * @param obj The photocam object
20391 * @param mode The desired mode
20393 * This sets the zoom mode to manual or one of several automatic levels.
20394 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20395 * elm_photocam_zoom_set() and will stay at that level until changed by code
20396 * or until zoom mode is changed. This is the default mode. The Automatic
20397 * modes will allow the photocam object to automatically adjust zoom mode
20398 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20399 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20400 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20401 * pixels within the frame are left unfilled.
20403 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20405 * @brief Get the zoom mode
20407 * @param obj The photocam object
20408 * @return The current zoom mode
20410 * This gets the current zoom mode of the photocam object.
20412 * @see elm_photocam_zoom_mode_set()
20414 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20416 * @brief Get the current image pixel width and height
20418 * @param obj The photocam object
20419 * @param w A pointer to the width return
20420 * @param h A pointer to the height return
20422 * This gets the current photo pixel width and height (for the original).
20423 * The size will be returned in the integers @p w and @p h that are pointed
20426 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20428 * @brief Get the area of the image that is currently shown
20431 * @param x A pointer to the X-coordinate of region
20432 * @param y A pointer to the Y-coordinate of region
20433 * @param w A pointer to the width
20434 * @param h A pointer to the height
20436 * @see elm_photocam_image_region_show()
20437 * @see elm_photocam_image_region_bring_in()
20439 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20441 * @brief Set the viewed portion of the image
20443 * @param obj The photocam object
20444 * @param x X-coordinate of region in image original pixels
20445 * @param y Y-coordinate of region in image original pixels
20446 * @param w Width of region in image original pixels
20447 * @param h Height of region in image original pixels
20449 * This shows the region of the image without using animation.
20451 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20453 * @brief Bring in the viewed portion of the image
20455 * @param obj The photocam object
20456 * @param x X-coordinate of region in image original pixels
20457 * @param y Y-coordinate of region in image original pixels
20458 * @param w Width of region in image original pixels
20459 * @param h Height of region in image original pixels
20461 * This shows the region of the image using animation.
20463 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20465 * @brief Set the paused state for photocam
20467 * @param obj The photocam object
20468 * @param paused The pause state to set
20470 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20471 * photocam. The default is off. This will stop zooming using animation on
20472 * zoom levels changes and change instantly. This will stop any existing
20473 * animations that are running.
20475 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20477 * @brief Get the paused state for photocam
20479 * @param obj The photocam object
20480 * @return The current paused state
20482 * This gets the current paused state for the photocam object.
20484 * @see elm_photocam_paused_set()
20486 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20488 * @brief Get the internal low-res image used for photocam
20490 * @param obj The photocam object
20491 * @return The internal image object handle, or NULL if none exists
20493 * This gets the internal image object inside photocam. Do not modify it. It
20494 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20495 * deleted at any time as well.
20497 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20499 * @brief Set the photocam scrolling bouncing.
20501 * @param obj The photocam object
20502 * @param h_bounce bouncing for horizontal
20503 * @param v_bounce bouncing for vertical
20505 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20507 * @brief Get the photocam scrolling bouncing.
20509 * @param obj The photocam object
20510 * @param h_bounce bouncing for horizontal
20511 * @param v_bounce bouncing for vertical
20513 * @see elm_photocam_bounce_set()
20515 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20521 * @defgroup Map Map
20522 * @ingroup Elementary
20524 * @image html img/widget/map/preview-00.png
20525 * @image latex img/widget/map/preview-00.eps
20527 * This is a widget specifically for displaying a map. It uses basically
20528 * OpenStreetMap provider http://www.openstreetmap.org/,
20529 * but custom providers can be added.
20531 * It supports some basic but yet nice features:
20532 * @li zoom and scroll
20533 * @li markers with content to be displayed when user clicks over it
20534 * @li group of markers
20537 * Smart callbacks one can listen to:
20539 * - "clicked" - This is called when a user has clicked the map without
20541 * - "press" - This is called when a user has pressed down on the map.
20542 * - "longpressed" - This is called when a user has pressed down on the map
20543 * for a long time without dragging around.
20544 * - "clicked,double" - This is called when a user has double-clicked
20546 * - "load,detail" - Map detailed data load begins.
20547 * - "loaded,detail" - This is called when all currently visible parts of
20548 * the map are loaded.
20549 * - "zoom,start" - Zoom animation started.
20550 * - "zoom,stop" - Zoom animation stopped.
20551 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20552 * - "scroll" - the content has been scrolled (moved).
20553 * - "scroll,anim,start" - scrolling animation has started.
20554 * - "scroll,anim,stop" - scrolling animation has stopped.
20555 * - "scroll,drag,start" - dragging the contents around has started.
20556 * - "scroll,drag,stop" - dragging the contents around has stopped.
20557 * - "downloaded" - This is called when all currently required map images
20559 * - "route,load" - This is called when route request begins.
20560 * - "route,loaded" - This is called when route request ends.
20561 * - "name,load" - This is called when name request begins.
20562 * - "name,loaded- This is called when name request ends.
20564 * Available style for map widget:
20567 * Available style for markers:
20572 * Available style for marker bubble:
20575 * List of examples:
20576 * @li @ref map_example_01
20577 * @li @ref map_example_02
20578 * @li @ref map_example_03
20587 * @enum _Elm_Map_Zoom_Mode
20588 * @typedef Elm_Map_Zoom_Mode
20590 * Set map's zoom behavior. It can be set to manual or automatic.
20592 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20594 * Values <b> don't </b> work as bitmask, only one can be choosen.
20596 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20597 * than the scroller view.
20599 * @see elm_map_zoom_mode_set()
20600 * @see elm_map_zoom_mode_get()
20604 typedef enum _Elm_Map_Zoom_Mode
20606 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20607 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20608 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20609 ELM_MAP_ZOOM_MODE_LAST
20610 } Elm_Map_Zoom_Mode;
20613 * @enum _Elm_Map_Route_Sources
20614 * @typedef Elm_Map_Route_Sources
20616 * Set route service to be used. By default used source is
20617 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20619 * @see elm_map_route_source_set()
20620 * @see elm_map_route_source_get()
20624 typedef enum _Elm_Map_Route_Sources
20626 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20627 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. */
20628 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20629 ELM_MAP_ROUTE_SOURCE_LAST
20630 } Elm_Map_Route_Sources;
20632 typedef enum _Elm_Map_Name_Sources
20634 ELM_MAP_NAME_SOURCE_NOMINATIM,
20635 ELM_MAP_NAME_SOURCE_LAST
20636 } Elm_Map_Name_Sources;
20639 * @enum _Elm_Map_Route_Type
20640 * @typedef Elm_Map_Route_Type
20642 * Set type of transport used on route.
20644 * @see elm_map_route_add()
20648 typedef enum _Elm_Map_Route_Type
20650 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20651 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20652 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20653 ELM_MAP_ROUTE_TYPE_LAST
20654 } Elm_Map_Route_Type;
20657 * @enum _Elm_Map_Route_Method
20658 * @typedef Elm_Map_Route_Method
20660 * Set the routing method, what should be priorized, time or distance.
20662 * @see elm_map_route_add()
20666 typedef enum _Elm_Map_Route_Method
20668 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20669 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20670 ELM_MAP_ROUTE_METHOD_LAST
20671 } Elm_Map_Route_Method;
20673 typedef enum _Elm_Map_Name_Method
20675 ELM_MAP_NAME_METHOD_SEARCH,
20676 ELM_MAP_NAME_METHOD_REVERSE,
20677 ELM_MAP_NAME_METHOD_LAST
20678 } Elm_Map_Name_Method;
20680 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(). */
20681 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(). */
20682 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(). */
20683 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(). */
20684 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20685 typedef struct _Elm_Map_Track Elm_Map_Track;
20687 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. */
20688 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20689 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20690 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20692 typedef char *(*ElmMapModuleSourceFunc) (void);
20693 typedef int (*ElmMapModuleZoomMinFunc) (void);
20694 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20695 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20696 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20697 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20698 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20699 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20700 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20703 * Add a new map widget to the given parent Elementary (container) object.
20705 * @param parent The parent object.
20706 * @return a new map widget handle or @c NULL, on errors.
20708 * This function inserts a new map widget on the canvas.
20712 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20715 * Set the zoom level of the map.
20717 * @param obj The map object.
20718 * @param zoom The zoom level to set.
20720 * This sets the zoom level.
20722 * It will respect limits defined by elm_map_source_zoom_min_set() and
20723 * elm_map_source_zoom_max_set().
20725 * By default these values are 0 (world map) and 18 (maximum zoom).
20727 * This function should be used when zoom mode is set to
20728 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20729 * with elm_map_zoom_mode_set().
20731 * @see elm_map_zoom_mode_set().
20732 * @see elm_map_zoom_get().
20736 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20739 * Get the zoom level of the map.
20741 * @param obj The map object.
20742 * @return The current zoom level.
20744 * This returns the current zoom level of the map object.
20746 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20747 * (which is the default), the zoom level may be changed at any time by the
20748 * map object itself to account for map size and map viewport size.
20750 * @see elm_map_zoom_set() for details.
20754 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20757 * Set the zoom mode used by the map object.
20759 * @param obj The map object.
20760 * @param mode The zoom mode of the map, being it one of
20761 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20762 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20764 * This sets the zoom mode to manual or one of the automatic levels.
20765 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20766 * elm_map_zoom_set() and will stay at that level until changed by code
20767 * or until zoom mode is changed. This is the default mode.
20769 * The Automatic modes will allow the map object to automatically
20770 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20771 * adjust zoom so the map fits inside the scroll frame with no pixels
20772 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20773 * ensure no pixels within the frame are left unfilled. Do not forget that
20774 * the valid sizes are 2^zoom, consequently the map may be smaller than
20775 * the scroller view.
20777 * @see elm_map_zoom_set()
20781 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20784 * Get the zoom mode used by the map object.
20786 * @param obj The map object.
20787 * @return The zoom mode of the map, being it one of
20788 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20789 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20791 * This function returns the current zoom mode used by the map object.
20793 * @see elm_map_zoom_mode_set() for more details.
20797 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800 * Get the current coordinates of the map.
20802 * @param obj The map object.
20803 * @param lon Pointer where to store longitude.
20804 * @param lat Pointer where to store latitude.
20806 * This gets the current center coordinates of the map object. It can be
20807 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20809 * @see elm_map_geo_region_bring_in()
20810 * @see elm_map_geo_region_show()
20814 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20817 * Animatedly bring in given coordinates to the center of the map.
20819 * @param obj The map object.
20820 * @param lon Longitude to center at.
20821 * @param lat Latitude to center at.
20823 * This causes map to jump to the given @p lat and @p lon coordinates
20824 * and show it (by scrolling) in the center of the viewport, if it is not
20825 * already centered. This will use animation to do so and take a period
20826 * of time to complete.
20828 * @see elm_map_geo_region_show() for a function to avoid animation.
20829 * @see elm_map_geo_region_get()
20833 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20836 * Show the given coordinates at the center of the map, @b immediately.
20838 * @param obj The map object.
20839 * @param lon Longitude to center at.
20840 * @param lat Latitude to center at.
20842 * This causes map to @b redraw its viewport's contents to the
20843 * region contining the given @p lat and @p lon, that will be moved to the
20844 * center of the map.
20846 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20847 * @see elm_map_geo_region_get()
20851 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20854 * Pause or unpause the map.
20856 * @param obj The map object.
20857 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20860 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20863 * The default is off.
20865 * This will stop zooming using animation, changing zoom levels will
20866 * change instantly. This will stop any existing animations that are running.
20868 * @see elm_map_paused_get()
20872 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20875 * Get a value whether map is paused or not.
20877 * @param obj The map object.
20878 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20879 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20881 * This gets the current paused state for the map object.
20883 * @see elm_map_paused_set() for details.
20887 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20890 * Set to show markers during zoom level changes or not.
20892 * @param obj The map object.
20893 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20896 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20899 * The default is off.
20901 * This will stop zooming using animation, changing zoom levels will
20902 * change instantly. This will stop any existing animations that are running.
20904 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20907 * The default is off.
20909 * Enabling it will force the map to stop displaying the markers during
20910 * zoom level changes. Set to on if you have a large number of markers.
20912 * @see elm_map_paused_markers_get()
20916 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20919 * Get a value whether markers will be displayed on zoom level changes or not
20921 * @param obj The map object.
20922 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20923 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20925 * This gets the current markers paused state for the map object.
20927 * @see elm_map_paused_markers_set() for details.
20931 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20934 * Get the information of downloading status.
20936 * @param obj The map object.
20937 * @param try_num Pointer where to store number of tiles being downloaded.
20938 * @param finish_num Pointer where to store number of tiles successfully
20941 * This gets the current downloading status for the map object, the number
20942 * of tiles being downloaded and the number of tiles already downloaded.
20946 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20949 * Convert a pixel coordinate (x,y) into a geographic coordinate
20950 * (longitude, latitude).
20952 * @param obj The map object.
20953 * @param x the coordinate.
20954 * @param y the coordinate.
20955 * @param size the size in pixels of the map.
20956 * The map is a square and generally his size is : pow(2.0, zoom)*256.
20957 * @param lon Pointer where to store the longitude that correspond to x.
20958 * @param lat Pointer where to store the latitude that correspond to y.
20960 * @note Origin pixel point is the top left corner of the viewport.
20961 * Map zoom and size are taken on account.
20963 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
20967 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);
20970 * Convert a geographic coordinate (longitude, latitude) into a pixel
20971 * coordinate (x, y).
20973 * @param obj The map object.
20974 * @param lon the longitude.
20975 * @param lat the latitude.
20976 * @param size the size in pixels of the map. The map is a square
20977 * and generally his size is : pow(2.0, zoom)*256.
20978 * @param x Pointer where to store the horizontal pixel coordinate that
20979 * correspond to the longitude.
20980 * @param y Pointer where to store the vertical pixel coordinate that
20981 * correspond to the latitude.
20983 * @note Origin pixel point is the top left corner of the viewport.
20984 * Map zoom and size are taken on account.
20986 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
20990 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);
20993 * Convert a geographic coordinate (longitude, latitude) into a name
20996 * @param obj The map object.
20997 * @param lon the longitude.
20998 * @param lat the latitude.
20999 * @return name A #Elm_Map_Name handle for this coordinate.
21001 * To get the string for this address, elm_map_name_address_get()
21004 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21008 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21011 * Convert a name (address) into a geographic coordinate
21012 * (longitude, latitude).
21014 * @param obj The map object.
21015 * @param name The address.
21016 * @return name A #Elm_Map_Name handle for this address.
21018 * To get the longitude and latitude, elm_map_name_region_get()
21021 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21025 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21028 * Convert a pixel coordinate into a rotated pixel coordinate.
21030 * @param obj The map object.
21031 * @param x horizontal coordinate of the point to rotate.
21032 * @param y vertical coordinate of the point to rotate.
21033 * @param cx rotation's center horizontal position.
21034 * @param cy rotation's center vertical position.
21035 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21036 * @param xx Pointer where to store rotated x.
21037 * @param yy Pointer where to store rotated y.
21041 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);
21044 * Add a new marker to the map object.
21046 * @param obj The map object.
21047 * @param lon The longitude of the marker.
21048 * @param lat The latitude of the marker.
21049 * @param clas The class, to use when marker @b isn't grouped to others.
21050 * @param clas_group The class group, to use when marker is grouped to others
21051 * @param data The data passed to the callbacks.
21053 * @return The created marker or @c NULL upon failure.
21055 * A marker will be created and shown in a specific point of the map, defined
21056 * by @p lon and @p lat.
21058 * It will be displayed using style defined by @p class when this marker
21059 * is displayed alone (not grouped). A new class can be created with
21060 * elm_map_marker_class_new().
21062 * If the marker is grouped to other markers, it will be displayed with
21063 * style defined by @p class_group. Markers with the same group are grouped
21064 * if they are close. A new group class can be created with
21065 * elm_map_marker_group_class_new().
21067 * Markers created with this method can be deleted with
21068 * elm_map_marker_remove().
21070 * A marker can have associated content to be displayed by a bubble,
21071 * when a user click over it, as well as an icon. These objects will
21072 * be fetch using class' callback functions.
21074 * @see elm_map_marker_class_new()
21075 * @see elm_map_marker_group_class_new()
21076 * @see elm_map_marker_remove()
21080 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);
21083 * Set the maximum numbers of markers' content to be displayed in a group.
21085 * @param obj The map object.
21086 * @param max The maximum numbers of items displayed in a bubble.
21088 * A bubble will be displayed when the user clicks over the group,
21089 * and will place the content of markers that belong to this group
21092 * A group can have a long list of markers, consequently the creation
21093 * of the content of the bubble can be very slow.
21095 * In order to avoid this, a maximum number of items is displayed
21098 * By default this number is 30.
21100 * Marker with the same group class are grouped if they are close.
21102 * @see elm_map_marker_add()
21106 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21109 * Remove a marker from the map.
21111 * @param marker The marker to remove.
21113 * @see elm_map_marker_add()
21117 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21120 * Get the current coordinates of the marker.
21122 * @param marker marker.
21123 * @param lat Pointer where to store the marker's latitude.
21124 * @param lon Pointer where to store the marker's longitude.
21126 * These values are set when adding markers, with function
21127 * elm_map_marker_add().
21129 * @see elm_map_marker_add()
21133 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21136 * Animatedly bring in given marker to the center of the map.
21138 * @param marker The marker to center at.
21140 * This causes map to jump to the given @p marker's coordinates
21141 * and show it (by scrolling) in the center of the viewport, if it is not
21142 * already centered. This will use animation to do so and take a period
21143 * of time to complete.
21145 * @see elm_map_marker_show() for a function to avoid animation.
21146 * @see elm_map_marker_region_get()
21150 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21153 * Show the given marker at the center of the map, @b immediately.
21155 * @param marker The marker to center at.
21157 * This causes map to @b redraw its viewport's contents to the
21158 * region contining the given @p marker's coordinates, that will be
21159 * moved to the center of the map.
21161 * @see elm_map_marker_bring_in() for a function to move with animation.
21162 * @see elm_map_markers_list_show() if more than one marker need to be
21164 * @see elm_map_marker_region_get()
21168 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21171 * Move and zoom the map to display a list of markers.
21173 * @param markers A list of #Elm_Map_Marker handles.
21175 * The map will be centered on the center point of the markers in the list.
21176 * Then the map will be zoomed in order to fit the markers using the maximum
21177 * zoom which allows display of all the markers.
21179 * @warning All the markers should belong to the same map object.
21181 * @see elm_map_marker_show() to show a single marker.
21182 * @see elm_map_marker_bring_in()
21186 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21189 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21191 * @param marker The marker wich content should be returned.
21192 * @return Return the evas object if it exists, else @c NULL.
21194 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21195 * elm_map_marker_class_get_cb_set() should be used.
21197 * This content is what will be inside the bubble that will be displayed
21198 * when an user clicks over the marker.
21200 * This returns the actual Evas object used to be placed inside
21201 * the bubble. This may be @c NULL, as it may
21202 * not have been created or may have been deleted, at any time, by
21203 * the map. <b>Do not modify this object</b> (move, resize,
21204 * show, hide, etc.), as the map is controlling it. This
21205 * function is for querying, emitting custom signals or hooking
21206 * lower level callbacks for events on that object. Do not delete
21207 * this object under any circumstances.
21211 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21214 * Update the marker
21216 * @param marker The marker to be updated.
21218 * If a content is set to this marker, it will call function to delete it,
21219 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21220 * #ElmMapMarkerGetFunc.
21222 * These functions are set for the marker class with
21223 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21227 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21230 * Close all the bubbles opened by the user.
21232 * @param obj The map object.
21234 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21235 * when the user clicks on a marker.
21237 * This functions is set for the marker class with
21238 * elm_map_marker_class_get_cb_set().
21242 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21245 * Create a new group class.
21247 * @param obj The map object.
21248 * @return Returns the new group class.
21250 * Each marker must be associated to a group class. Markers in the same
21251 * group are grouped if they are close.
21253 * The group class defines the style of the marker when a marker is grouped
21254 * to others markers. When it is alone, another class will be used.
21256 * A group class will need to be provided when creating a marker with
21257 * elm_map_marker_add().
21259 * Some properties and functions can be set by class, as:
21260 * - style, with elm_map_group_class_style_set()
21261 * - data - to be associated to the group class. It can be set using
21262 * elm_map_group_class_data_set().
21263 * - min zoom to display markers, set with
21264 * elm_map_group_class_zoom_displayed_set().
21265 * - max zoom to group markers, set using
21266 * elm_map_group_class_zoom_grouped_set().
21267 * - visibility - set if markers will be visible or not, set with
21268 * elm_map_group_class_hide_set().
21269 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21270 * It can be set using elm_map_group_class_icon_cb_set().
21272 * @see elm_map_marker_add()
21273 * @see elm_map_group_class_style_set()
21274 * @see elm_map_group_class_data_set()
21275 * @see elm_map_group_class_zoom_displayed_set()
21276 * @see elm_map_group_class_zoom_grouped_set()
21277 * @see elm_map_group_class_hide_set()
21278 * @see elm_map_group_class_icon_cb_set()
21282 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21285 * Set the marker's style of a group class.
21287 * @param clas The group class.
21288 * @param style The style to be used by markers.
21290 * Each marker must be associated to a group class, and will use the style
21291 * defined by such class when grouped to other markers.
21293 * The following styles are provided by default theme:
21294 * @li @c radio - blue circle
21295 * @li @c radio2 - green circle
21298 * @see elm_map_group_class_new() for more details.
21299 * @see elm_map_marker_add()
21303 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21306 * Set the icon callback function of a group class.
21308 * @param clas The group class.
21309 * @param icon_get The callback function that will return the icon.
21311 * Each marker must be associated to a group class, and it can display a
21312 * custom icon. The function @p icon_get must return this icon.
21314 * @see elm_map_group_class_new() for more details.
21315 * @see elm_map_marker_add()
21319 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21322 * Set the data associated to the group class.
21324 * @param clas The group class.
21325 * @param data The new user data.
21327 * This data will be passed for callback functions, like icon get callback,
21328 * that can be set with elm_map_group_class_icon_cb_set().
21330 * If a data was previously set, the object will lose the pointer for it,
21331 * so if needs to be freed, you must do it yourself.
21333 * @see elm_map_group_class_new() for more details.
21334 * @see elm_map_group_class_icon_cb_set()
21335 * @see elm_map_marker_add()
21339 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21342 * Set the minimum zoom from where the markers are displayed.
21344 * @param clas The group class.
21345 * @param zoom The minimum zoom.
21347 * Markers only will be displayed when the map is displayed at @p zoom
21350 * @see elm_map_group_class_new() for more details.
21351 * @see elm_map_marker_add()
21355 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21358 * Set the zoom from where the markers are no more grouped.
21360 * @param clas The group class.
21361 * @param zoom The maximum zoom.
21363 * Markers only will be grouped when the map is displayed at
21364 * less than @p zoom.
21366 * @see elm_map_group_class_new() for more details.
21367 * @see elm_map_marker_add()
21371 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21374 * Set if the markers associated to the group class @clas are hidden or not.
21376 * @param clas The group class.
21377 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21380 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21385 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21388 * Create a new marker class.
21390 * @param obj The map object.
21391 * @return Returns the new group class.
21393 * Each marker must be associated to a class.
21395 * The marker class defines the style of the marker when a marker is
21396 * displayed alone, i.e., not grouped to to others markers. When grouped
21397 * it will use group class style.
21399 * A marker class will need to be provided when creating a marker with
21400 * elm_map_marker_add().
21402 * Some properties and functions can be set by class, as:
21403 * - style, with elm_map_marker_class_style_set()
21404 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21405 * It can be set using elm_map_marker_class_icon_cb_set().
21406 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21407 * Set using elm_map_marker_class_get_cb_set().
21408 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21409 * Set using elm_map_marker_class_del_cb_set().
21411 * @see elm_map_marker_add()
21412 * @see elm_map_marker_class_style_set()
21413 * @see elm_map_marker_class_icon_cb_set()
21414 * @see elm_map_marker_class_get_cb_set()
21415 * @see elm_map_marker_class_del_cb_set()
21419 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21422 * Set the marker's style of a marker class.
21424 * @param clas The marker class.
21425 * @param style The style to be used by markers.
21427 * Each marker must be associated to a marker class, and will use the style
21428 * defined by such class when alone, i.e., @b not grouped to other markers.
21430 * The following styles are provided by default theme:
21435 * @see elm_map_marker_class_new() for more details.
21436 * @see elm_map_marker_add()
21440 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21443 * Set the icon callback function of a marker class.
21445 * @param clas The marker class.
21446 * @param icon_get The callback function that will return the icon.
21448 * Each marker must be associated to a marker class, and it can display a
21449 * custom icon. The function @p icon_get must return this icon.
21451 * @see elm_map_marker_class_new() for more details.
21452 * @see elm_map_marker_add()
21456 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21459 * Set the bubble content callback function of a marker class.
21461 * @param clas The marker class.
21462 * @param get The callback function that will return the content.
21464 * Each marker must be associated to a marker class, and it can display a
21465 * a content on a bubble that opens when the user click over the marker.
21466 * The function @p get must return this content object.
21468 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21471 * @see elm_map_marker_class_new() for more details.
21472 * @see elm_map_marker_class_del_cb_set()
21473 * @see elm_map_marker_add()
21477 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21480 * Set the callback function used to delete bubble content of a marker class.
21482 * @param clas The marker class.
21483 * @param del The callback function that will delete the content.
21485 * Each marker must be associated to a marker class, and it can display a
21486 * a content on a bubble that opens when the user click over the marker.
21487 * The function to return such content can be set with
21488 * elm_map_marker_class_get_cb_set().
21490 * If this content must be freed, a callback function need to be
21491 * set for that task with this function.
21493 * If this callback is defined it will have to delete (or not) the
21494 * object inside, but if the callback is not defined the object will be
21495 * destroyed with evas_object_del().
21497 * @see elm_map_marker_class_new() for more details.
21498 * @see elm_map_marker_class_get_cb_set()
21499 * @see elm_map_marker_add()
21503 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21506 * Get the list of available sources.
21508 * @param obj The map object.
21509 * @return The source names list.
21511 * It will provide a list with all available sources, that can be set as
21512 * current source with elm_map_source_name_set(), or get with
21513 * elm_map_source_name_get().
21515 * Available sources:
21521 * @see elm_map_source_name_set() for more details.
21522 * @see elm_map_source_name_get()
21526 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21529 * Set the source of the map.
21531 * @param obj The map object.
21532 * @param source The source to be used.
21534 * Map widget retrieves images that composes the map from a web service.
21535 * This web service can be set with this method.
21537 * A different service can return a different maps with different
21538 * information and it can use different zoom values.
21540 * The @p source_name need to match one of the names provided by
21541 * elm_map_source_names_get().
21543 * The current source can be get using elm_map_source_name_get().
21545 * @see elm_map_source_names_get()
21546 * @see elm_map_source_name_get()
21551 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21554 * Get the name of currently used source.
21556 * @param obj The map object.
21557 * @return Returns the name of the source in use.
21559 * @see elm_map_source_name_set() for more details.
21563 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21566 * Set the source of the route service to be used by the map.
21568 * @param obj The map object.
21569 * @param source The route service to be used, being it one of
21570 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21571 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21573 * Each one has its own algorithm, so the route retrieved may
21574 * differ depending on the source route. Now, only the default is working.
21576 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21577 * http://www.yournavigation.org/.
21579 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21580 * assumptions. Its routing core is based on Contraction Hierarchies.
21582 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21584 * @see elm_map_route_source_get().
21588 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21591 * Get the current route source.
21593 * @param obj The map object.
21594 * @return The source of the route service used by the map.
21596 * @see elm_map_route_source_set() for details.
21600 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21603 * Set the minimum zoom of the source.
21605 * @param obj The map object.
21606 * @param zoom New minimum zoom value to be used.
21608 * By default, it's 0.
21612 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21615 * Get the minimum zoom of the source.
21617 * @param obj The map object.
21618 * @return Returns the minimum zoom of the source.
21620 * @see elm_map_source_zoom_min_set() for details.
21624 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21627 * Set the maximum zoom of the source.
21629 * @param obj The map object.
21630 * @param zoom New maximum zoom value to be used.
21632 * By default, it's 18.
21636 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21639 * Get the maximum zoom of the source.
21641 * @param obj The map object.
21642 * @return Returns the maximum zoom of the source.
21644 * @see elm_map_source_zoom_min_set() for details.
21648 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21651 * Set the user agent used by the map object to access routing services.
21653 * @param obj The map object.
21654 * @param user_agent The user agent to be used by the map.
21656 * User agent is a client application implementing a network protocol used
21657 * in communications within a client–server distributed computing system
21659 * The @p user_agent identification string will transmitted in a header
21660 * field @c User-Agent.
21662 * @see elm_map_user_agent_get()
21666 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21669 * Get the user agent used by the map object.
21671 * @param obj The map object.
21672 * @return The user agent identification string used by the map.
21674 * @see elm_map_user_agent_set() for details.
21678 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21681 * Add a new route to the map object.
21683 * @param obj The map object.
21684 * @param type The type of transport to be considered when tracing a route.
21685 * @param method The routing method, what should be priorized.
21686 * @param flon The start longitude.
21687 * @param flat The start latitude.
21688 * @param tlon The destination longitude.
21689 * @param tlat The destination latitude.
21691 * @return The created route or @c NULL upon failure.
21693 * A route will be traced by point on coordinates (@p flat, @p flon)
21694 * to point on coordinates (@p tlat, @p tlon), using the route service
21695 * set with elm_map_route_source_set().
21697 * It will take @p type on consideration to define the route,
21698 * depending if the user will be walking or driving, the route may vary.
21699 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21700 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21702 * Another parameter is what the route should priorize, the minor distance
21703 * or the less time to be spend on the route. So @p method should be one
21704 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21706 * Routes created with this method can be deleted with
21707 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21708 * and distance can be get with elm_map_route_distance_get().
21710 * @see elm_map_route_remove()
21711 * @see elm_map_route_color_set()
21712 * @see elm_map_route_distance_get()
21713 * @see elm_map_route_source_set()
21717 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);
21720 * Remove a route from the map.
21722 * @param route The route to remove.
21724 * @see elm_map_route_add()
21728 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21731 * Set the route color.
21733 * @param route The route object.
21734 * @param r Red channel value, from 0 to 255.
21735 * @param g Green channel value, from 0 to 255.
21736 * @param b Blue channel value, from 0 to 255.
21737 * @param a Alpha channel value, from 0 to 255.
21739 * It uses an additive color model, so each color channel represents
21740 * how much of each primary colors must to be used. 0 represents
21741 * ausence of this color, so if all of the three are set to 0,
21742 * the color will be black.
21744 * These component values should be integers in the range 0 to 255,
21745 * (single 8-bit byte).
21747 * This sets the color used for the route. By default, it is set to
21748 * solid red (r = 255, g = 0, b = 0, a = 255).
21750 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21752 * @see elm_map_route_color_get()
21756 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21759 * Get the route color.
21761 * @param route The route object.
21762 * @param r Pointer where to store the red channel value.
21763 * @param g Pointer where to store the green channel value.
21764 * @param b Pointer where to store the blue channel value.
21765 * @param a Pointer where to store the alpha channel value.
21767 * @see elm_map_route_color_set() for details.
21771 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21774 * Get the route distance in kilometers.
21776 * @param route The route object.
21777 * @return The distance of route (unit : km).
21781 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21784 * Get the information of route nodes.
21786 * @param route The route object.
21787 * @return Returns a string with the nodes of route.
21791 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21794 * Get the information of route waypoint.
21796 * @param route the route object.
21797 * @return Returns a string with information about waypoint of route.
21801 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21804 * Get the address of the name.
21806 * @param name The name handle.
21807 * @return Returns the address string of @p name.
21809 * This gets the coordinates of the @p name, created with one of the
21810 * conversion functions.
21812 * @see elm_map_utils_convert_name_into_coord()
21813 * @see elm_map_utils_convert_coord_into_name()
21817 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21820 * Get the current coordinates of the name.
21822 * @param name The name handle.
21823 * @param lat Pointer where to store the latitude.
21824 * @param lon Pointer where to store The longitude.
21826 * This gets the coordinates of the @p name, created with one of the
21827 * conversion functions.
21829 * @see elm_map_utils_convert_name_into_coord()
21830 * @see elm_map_utils_convert_coord_into_name()
21834 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21837 * Remove a name from the map.
21839 * @param name The name to remove.
21841 * Basically the struct handled by @p name will be freed, so convertions
21842 * between address and coordinates will be lost.
21844 * @see elm_map_utils_convert_name_into_coord()
21845 * @see elm_map_utils_convert_coord_into_name()
21849 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21854 * @param obj The map object.
21855 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21856 * @param cx Rotation's center horizontal position.
21857 * @param cy Rotation's center vertical position.
21859 * @see elm_map_rotate_get()
21863 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21866 * Get the rotate degree of the map
21868 * @param obj The map object
21869 * @param degree Pointer where to store degrees from 0.0 to 360.0
21870 * to rotate arount Z axis.
21871 * @param cx Pointer where to store rotation's center horizontal position.
21872 * @param cy Pointer where to store rotation's center vertical position.
21874 * @see elm_map_rotate_set() to set map rotation.
21878 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);
21881 * Enable or disable mouse wheel to be used to zoom in / out the map.
21883 * @param obj The map object.
21884 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21887 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21889 * It's disabled by default.
21891 * @see elm_map_wheel_disabled_get()
21895 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21898 * Get a value whether mouse wheel is enabled or not.
21900 * @param obj The map object.
21901 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21902 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21904 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21906 * @see elm_map_wheel_disabled_set() for details.
21910 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21914 * Add a track on the map
21916 * @param obj The map object.
21917 * @param emap The emap route object.
21918 * @return The route object. This is an elm object of type Route.
21920 * @see elm_route_add() for details.
21924 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21928 * Remove a track from the map
21930 * @param obj The map object.
21931 * @param route The track to remove.
21935 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21942 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21944 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21946 EAPI double elm_route_lon_min_get(Evas_Object *obj);
21947 EAPI double elm_route_lat_min_get(Evas_Object *obj);
21948 EAPI double elm_route_lon_max_get(Evas_Object *obj);
21949 EAPI double elm_route_lat_max_get(Evas_Object *obj);
21953 * @defgroup Panel Panel
21955 * @image html img/widget/panel/preview-00.png
21956 * @image latex img/widget/panel/preview-00.eps
21958 * @brief A panel is a type of animated container that contains subobjects.
21959 * It can be expanded or contracted by clicking the button on it's edge.
21961 * Orientations are as follows:
21962 * @li ELM_PANEL_ORIENT_TOP
21963 * @li ELM_PANEL_ORIENT_LEFT
21964 * @li ELM_PANEL_ORIENT_RIGHT
21966 * @ref tutorial_panel shows one way to use this widget.
21969 typedef enum _Elm_Panel_Orient
21971 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
21972 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
21973 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
21974 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
21975 } Elm_Panel_Orient;
21977 * @brief Adds a panel object
21979 * @param parent The parent object
21981 * @return The panel object, or NULL on failure
21983 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21985 * @brief Sets the orientation of the panel
21987 * @param parent The parent object
21988 * @param orient The panel orientation. Can be one of the following:
21989 * @li ELM_PANEL_ORIENT_TOP
21990 * @li ELM_PANEL_ORIENT_LEFT
21991 * @li ELM_PANEL_ORIENT_RIGHT
21993 * Sets from where the panel will (dis)appear.
21995 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
21997 * @brief Get the orientation of the panel.
21999 * @param obj The panel object
22000 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22002 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22004 * @brief Set the content of the panel.
22006 * @param obj The panel object
22007 * @param content The panel content
22009 * Once the content object is set, a previously set one will be deleted.
22010 * If you want to keep that old content object, use the
22011 * elm_panel_content_unset() function.
22013 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22015 * @brief Get the content of the panel.
22017 * @param obj The panel object
22018 * @return The content that is being used
22020 * Return the content object which is set for this widget.
22022 * @see elm_panel_content_set()
22024 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22026 * @brief Unset the content of the panel.
22028 * @param obj The panel object
22029 * @return The content that was being used
22031 * Unparent and return the content object which was set for this widget.
22033 * @see elm_panel_content_set()
22035 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22037 * @brief Set the state of the panel.
22039 * @param obj The panel object
22040 * @param hidden If true, the panel will run the animation to contract
22042 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22044 * @brief Get the state of the panel.
22046 * @param obj The panel object
22047 * @param hidden If true, the panel is in the "hide" state
22049 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22051 * @brief Toggle the hidden state of the panel from code
22053 * @param obj The panel object
22055 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22061 * @defgroup Panes Panes
22062 * @ingroup Elementary
22064 * @image html img/widget/panes/preview-00.png
22065 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22067 * @image html img/panes.png
22068 * @image latex img/panes.eps width=\textwidth
22070 * The panes adds a dragable bar between two contents. When dragged
22071 * this bar will resize contents size.
22073 * Panes can be displayed vertically or horizontally, and contents
22074 * size proportion can be customized (homogeneous by default).
22076 * Smart callbacks one can listen to:
22077 * - "press" - The panes has been pressed (button wasn't released yet).
22078 * - "unpressed" - The panes was released after being pressed.
22079 * - "clicked" - The panes has been clicked>
22080 * - "clicked,double" - The panes has been double clicked
22082 * Available styles for it:
22085 * Here is an example on its usage:
22086 * @li @ref panes_example
22090 * @addtogroup Panes
22095 * Add a new panes widget to the given parent Elementary
22096 * (container) object.
22098 * @param parent The parent object.
22099 * @return a new panes widget handle or @c NULL, on errors.
22101 * This function inserts a new panes widget on the canvas.
22105 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22108 * Set the left content of the panes widget.
22110 * @param obj The panes object.
22111 * @param content The new left content object.
22113 * Once the content object is set, a previously set one will be deleted.
22114 * If you want to keep that old content object, use the
22115 * elm_panes_content_left_unset() function.
22117 * If panes is displayed vertically, left content will be displayed at
22120 * @see elm_panes_content_left_get()
22121 * @see elm_panes_content_right_set() to set content on the other side.
22125 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22128 * Set the right content of the panes widget.
22130 * @param obj The panes object.
22131 * @param content The new right content object.
22133 * Once the content object is set, a previously set one will be deleted.
22134 * If you want to keep that old content object, use the
22135 * elm_panes_content_right_unset() function.
22137 * If panes is displayed vertically, left content will be displayed at
22140 * @see elm_panes_content_right_get()
22141 * @see elm_panes_content_left_set() to set content on the other side.
22145 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22148 * Get the left content of the panes.
22150 * @param obj The panes object.
22151 * @return The left content object that is being used.
22153 * Return the left content object which is set for this widget.
22155 * @see elm_panes_content_left_set() for details.
22159 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22162 * Get the right content of the panes.
22164 * @param obj The panes object
22165 * @return The right content object that is being used
22167 * Return the right content object which is set for this widget.
22169 * @see elm_panes_content_right_set() for details.
22173 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22176 * Unset the left content used for the panes.
22178 * @param obj The panes object.
22179 * @return The left content object that was being used.
22181 * Unparent and return the left content object which was set for this widget.
22183 * @see elm_panes_content_left_set() for details.
22184 * @see elm_panes_content_left_get().
22188 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22191 * Unset the right content used for the panes.
22193 * @param obj The panes object.
22194 * @return The right content object that was being used.
22196 * Unparent and return the right content object which was set for this
22199 * @see elm_panes_content_right_set() for details.
22200 * @see elm_panes_content_right_get().
22204 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22207 * Get the size proportion of panes widget's left side.
22209 * @param obj The panes object.
22210 * @return float value between 0.0 and 1.0 representing size proportion
22213 * @see elm_panes_content_left_size_set() for more details.
22217 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22220 * Set the size proportion of panes widget's left side.
22222 * @param obj The panes object.
22223 * @param size Value between 0.0 and 1.0 representing size proportion
22226 * By default it's homogeneous, i.e., both sides have the same size.
22228 * If something different is required, it can be set with this function.
22229 * For example, if the left content should be displayed over
22230 * 75% of the panes size, @p size should be passed as @c 0.75.
22231 * This way, right content will be resized to 25% of panes size.
22233 * If displayed vertically, left content is displayed at top, and
22234 * right content at bottom.
22236 * @note This proportion will change when user drags the panes bar.
22238 * @see elm_panes_content_left_size_get()
22242 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22245 * Set the orientation of a given panes widget.
22247 * @param obj The panes object.
22248 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22249 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22251 * Use this function to change how your panes is to be
22252 * disposed: vertically or horizontally.
22254 * By default it's displayed horizontally.
22256 * @see elm_panes_horizontal_get()
22260 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22263 * Retrieve the orientation of a given panes widget.
22265 * @param obj The panes object.
22266 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22267 * @c EINA_FALSE if it's @b vertical (and on errors).
22269 * @see elm_panes_horizontal_set() for more details.
22273 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22280 * @defgroup Flip Flip
22282 * @image html img/widget/flip/preview-00.png
22283 * @image latex img/widget/flip/preview-00.eps
22285 * This widget holds 2 content objects(Evas_Object): one on the front and one
22286 * on the back. It allows you to flip from front to back and vice-versa using
22287 * various animations.
22289 * If either the front or back contents are not set the flip will treat that
22290 * as transparent. So if you wore to set the front content but not the back,
22291 * and then call elm_flip_go() you would see whatever is below the flip.
22293 * For a list of supported animations see elm_flip_go().
22295 * Signals that you can add callbacks for are:
22296 * "animate,begin" - when a flip animation was started
22297 * "animate,done" - when a flip animation is finished
22299 * @ref tutorial_flip show how to use most of the API.
22303 typedef enum _Elm_Flip_Mode
22305 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22306 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22307 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22308 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22309 ELM_FLIP_CUBE_LEFT,
22310 ELM_FLIP_CUBE_RIGHT,
22312 ELM_FLIP_CUBE_DOWN,
22313 ELM_FLIP_PAGE_LEFT,
22314 ELM_FLIP_PAGE_RIGHT,
22318 typedef enum _Elm_Flip_Interaction
22320 ELM_FLIP_INTERACTION_NONE,
22321 ELM_FLIP_INTERACTION_ROTATE,
22322 ELM_FLIP_INTERACTION_CUBE,
22323 ELM_FLIP_INTERACTION_PAGE
22324 } Elm_Flip_Interaction;
22325 typedef enum _Elm_Flip_Direction
22327 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22328 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22329 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22330 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22331 } Elm_Flip_Direction;
22333 * @brief Add a new flip to the parent
22335 * @param parent The parent object
22336 * @return The new object or NULL if it cannot be created
22338 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22340 * @brief Set the front content of the flip widget.
22342 * @param obj The flip object
22343 * @param content The new front content object
22345 * Once the content object is set, a previously set one will be deleted.
22346 * If you want to keep that old content object, use the
22347 * elm_flip_content_front_unset() function.
22349 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22351 * @brief Set the back content of the flip widget.
22353 * @param obj The flip object
22354 * @param content The new back content object
22356 * Once the content object is set, a previously set one will be deleted.
22357 * If you want to keep that old content object, use the
22358 * elm_flip_content_back_unset() function.
22360 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22362 * @brief Get the front content used for the flip
22364 * @param obj The flip object
22365 * @return The front content object that is being used
22367 * Return the front content object which is set for this widget.
22369 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22371 * @brief Get the back content used for the flip
22373 * @param obj The flip object
22374 * @return The back content object that is being used
22376 * Return the back content object which is set for this widget.
22378 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22380 * @brief Unset the front content used for the flip
22382 * @param obj The flip object
22383 * @return The front content object that was being used
22385 * Unparent and return the front content object which was set for this widget.
22387 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22389 * @brief Unset the back content used for the flip
22391 * @param obj The flip object
22392 * @return The back content object that was being used
22394 * Unparent and return the back content object which was set for this widget.
22396 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22398 * @brief Get flip front visibility state
22400 * @param obj The flip objct
22401 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22404 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22406 * @brief Set flip perspective
22408 * @param obj The flip object
22409 * @param foc The coordinate to set the focus on
22410 * @param x The X coordinate
22411 * @param y The Y coordinate
22413 * @warning This function currently does nothing.
22415 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22417 * @brief Runs the flip animation
22419 * @param obj The flip object
22420 * @param mode The mode type
22422 * Flips the front and back contents using the @p mode animation. This
22423 * efectively hides the currently visible content and shows the hidden one.
22425 * There a number of possible animations to use for the flipping:
22426 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22427 * around a horizontal axis in the middle of its height, the other content
22428 * is shown as the other side of the flip.
22429 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22430 * around a vertical axis in the middle of its width, the other content is
22431 * shown as the other side of the flip.
22432 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22433 * around a diagonal axis in the middle of its width, the other content is
22434 * shown as the other side of the flip.
22435 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22436 * around a diagonal axis in the middle of its height, the other content is
22437 * shown as the other side of the flip.
22438 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22439 * as if the flip was a cube, the other content is show as the right face of
22441 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22442 * right as if the flip was a cube, the other content is show as the left
22443 * face of the cube.
22444 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22445 * flip was a cube, the other content is show as the bottom face of the cube.
22446 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22447 * the flip was a cube, the other content is show as the upper face of the
22449 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22450 * if the flip was a book, the other content is shown as the page below that.
22451 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22452 * as if the flip was a book, the other content is shown as the page below
22454 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22455 * flip was a book, the other content is shown as the page below that.
22456 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22457 * flip was a book, the other content is shown as the page below that.
22459 * @image html elm_flip.png
22460 * @image latex elm_flip.eps width=\textwidth
22462 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22464 * @brief Set the interactive flip mode
22466 * @param obj The flip object
22467 * @param mode The interactive flip mode to use
22469 * This sets if the flip should be interactive (allow user to click and
22470 * drag a side of the flip to reveal the back page and cause it to flip).
22471 * By default a flip is not interactive. You may also need to set which
22472 * sides of the flip are "active" for flipping and how much space they use
22473 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22474 * and elm_flip_interacton_direction_hitsize_set()
22476 * The four avilable mode of interaction are:
22477 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22478 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22479 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22480 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22482 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22483 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22484 * happen, those can only be acheived with elm_flip_go();
22486 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22488 * @brief Get the interactive flip mode
22490 * @param obj The flip object
22491 * @return The interactive flip mode
22493 * Returns the interactive flip mode set by elm_flip_interaction_set()
22495 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22497 * @brief Set which directions of the flip respond to interactive flip
22499 * @param obj The flip object
22500 * @param dir The direction to change
22501 * @param enabled If that direction is enabled or not
22503 * By default all directions are disabled, so you may want to enable the
22504 * desired directions for flipping if you need interactive flipping. You must
22505 * call this function once for each direction that should be enabled.
22507 * @see elm_flip_interaction_set()
22509 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22511 * @brief Get the enabled state of that flip direction
22513 * @param obj The flip object
22514 * @param dir The direction to check
22515 * @return If that direction is enabled or not
22517 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22519 * @see elm_flip_interaction_set()
22521 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22523 * @brief Set the amount of the flip that is sensitive to interactive flip
22525 * @param obj The flip object
22526 * @param dir The direction to modify
22527 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22529 * Set the amount of the flip that is sensitive to interactive flip, with 0
22530 * representing no area in the flip and 1 representing the entire flip. There
22531 * is however a consideration to be made in that the area will never be
22532 * smaller than the finger size set(as set in your Elementary configuration).
22534 * @see elm_flip_interaction_set()
22536 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22538 * @brief Get the amount of the flip that is sensitive to interactive flip
22540 * @param obj The flip object
22541 * @param dir The direction to check
22542 * @return The size set for that direction
22544 * Returns the amount os sensitive area set by
22545 * elm_flip_interacton_direction_hitsize_set().
22547 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22552 /* scrolledentry */
22553 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22554 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22555 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22556 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22557 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22558 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22559 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22560 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22561 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22562 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22563 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22564 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22565 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22566 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22567 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22568 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22569 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22570 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22571 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22572 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22573 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22574 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22575 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22576 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22577 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22578 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22579 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22580 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22581 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22582 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22583 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22584 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22585 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22586 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22587 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22588 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);
22589 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22590 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22591 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);
22592 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22593 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);
22594 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22595 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22596 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22597 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22598 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22599 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22600 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22601 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22602 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);
22603 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);
22604 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);
22605 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);
22606 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);
22607 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);
22608 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22609 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22610 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22611 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22612 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22613 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22614 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22617 * @defgroup Conformant Conformant
22618 * @ingroup Elementary
22620 * @image html img/widget/conformant/preview-00.png
22621 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22623 * @image html img/conformant.png
22624 * @image latex img/conformant.eps width=\textwidth
22626 * The aim is to provide a widget that can be used in elementary apps to
22627 * account for space taken up by the indicator, virtual keypad & softkey
22628 * windows when running the illume2 module of E17.
22630 * So conformant content will be sized and positioned considering the
22631 * space required for such stuff, and when they popup, as a keyboard
22632 * shows when an entry is selected, conformant content won't change.
22634 * Available styles for it:
22637 * See how to use this widget in this example:
22638 * @ref conformant_example
22642 * @addtogroup Conformant
22647 * Add a new conformant widget to the given parent Elementary
22648 * (container) object.
22650 * @param parent The parent object.
22651 * @return A new conformant widget handle or @c NULL, on errors.
22653 * This function inserts a new conformant widget on the canvas.
22655 * @ingroup Conformant
22657 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22660 * Set the content of the conformant widget.
22662 * @param obj The conformant object.
22663 * @param content The content to be displayed by the conformant.
22665 * Content will be sized and positioned considering the space required
22666 * to display a virtual keyboard. So it won't fill all the conformant
22667 * size. This way is possible to be sure that content won't resize
22668 * or be re-positioned after the keyboard is displayed.
22670 * Once the content object is set, a previously set one will be deleted.
22671 * If you want to keep that old content object, use the
22672 * elm_conformat_content_unset() function.
22674 * @see elm_conformant_content_unset()
22675 * @see elm_conformant_content_get()
22677 * @ingroup Conformant
22679 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22682 * Get the content of the conformant widget.
22684 * @param obj The conformant object.
22685 * @return The content that is being used.
22687 * Return the content object which is set for this widget.
22688 * It won't be unparent from conformant. For that, use
22689 * elm_conformant_content_unset().
22691 * @see elm_conformant_content_set() for more details.
22692 * @see elm_conformant_content_unset()
22694 * @ingroup Conformant
22696 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22699 * Unset the content of the conformant widget.
22701 * @param obj The conformant object.
22702 * @return The content that was being used.
22704 * Unparent and return the content object which was set for this widget.
22706 * @see elm_conformant_content_set() for more details.
22708 * @ingroup Conformant
22710 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22713 * Returns the Evas_Object that represents the content area.
22715 * @param obj The conformant object.
22716 * @return The content area of the widget.
22718 * @ingroup Conformant
22720 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22727 * @defgroup Mapbuf Mapbuf
22728 * @ingroup Elementary
22730 * @image html img/widget/mapbuf/preview-00.png
22731 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22733 * This holds one content object and uses an Evas Map of transformation
22734 * points to be later used with this content. So the content will be
22735 * moved, resized, etc as a single image. So it will improve performance
22736 * when you have a complex interafce, with a lot of elements, and will
22737 * need to resize or move it frequently (the content object and its
22740 * See how to use this widget in this example:
22741 * @ref mapbuf_example
22745 * @addtogroup Mapbuf
22750 * Add a new mapbuf widget to the given parent Elementary
22751 * (container) object.
22753 * @param parent The parent object.
22754 * @return A new mapbuf widget handle or @c NULL, on errors.
22756 * This function inserts a new mapbuf widget on the canvas.
22760 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22763 * Set the content of the mapbuf.
22765 * @param obj The mapbuf object.
22766 * @param content The content that will be filled in this mapbuf object.
22768 * Once the content object is set, a previously set one will be deleted.
22769 * If you want to keep that old content object, use the
22770 * elm_mapbuf_content_unset() function.
22772 * To enable map, elm_mapbuf_enabled_set() should be used.
22776 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22779 * Get the content of the mapbuf.
22781 * @param obj The mapbuf object.
22782 * @return The content that is being used.
22784 * Return the content object which is set for this widget.
22786 * @see elm_mapbuf_content_set() for details.
22790 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22793 * Unset the content of the mapbuf.
22795 * @param obj The mapbuf object.
22796 * @return The content that was being used.
22798 * Unparent and return the content object which was set for this widget.
22800 * @see elm_mapbuf_content_set() for details.
22804 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22807 * Enable or disable the map.
22809 * @param obj The mapbuf object.
22810 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22812 * This enables the map that is set or disables it. On enable, the object
22813 * geometry will be saved, and the new geometry will change (position and
22814 * size) to reflect the map geometry set.
22816 * Also, when enabled, alpha and smooth states will be used, so if the
22817 * content isn't solid, alpha should be enabled, for example, otherwise
22818 * a black retangle will fill the content.
22820 * When disabled, the stored map will be freed and geometry prior to
22821 * enabling the map will be restored.
22823 * It's disabled by default.
22825 * @see elm_mapbuf_alpha_set()
22826 * @see elm_mapbuf_smooth_set()
22830 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22833 * Get a value whether map is enabled or not.
22835 * @param obj The mapbuf object.
22836 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22837 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22839 * @see elm_mapbuf_enabled_set() for details.
22843 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22846 * Enable or disable smooth map rendering.
22848 * @param obj The mapbuf object.
22849 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22852 * This sets smoothing for map rendering. If the object is a type that has
22853 * its own smoothing settings, then both the smooth settings for this object
22854 * and the map must be turned off.
22856 * By default smooth maps are enabled.
22860 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22863 * Get a value whether smooth map rendering is enabled or not.
22865 * @param obj The mapbuf object.
22866 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22867 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22869 * @see elm_mapbuf_smooth_set() for details.
22873 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22876 * Set or unset alpha flag for map rendering.
22878 * @param obj The mapbuf object.
22879 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22882 * This sets alpha flag for map rendering. If the object is a type that has
22883 * its own alpha settings, then this will take precedence. Only image objects
22884 * have this currently. It stops alpha blending of the map area, and is
22885 * useful if you know the object and/or all sub-objects is 100% solid.
22887 * Alpha is enabled by default.
22891 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22894 * Get a value whether alpha blending is enabled or not.
22896 * @param obj The mapbuf object.
22897 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22898 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22900 * @see elm_mapbuf_alpha_set() for details.
22904 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22911 * @defgroup Flipselector Flip Selector
22913 * @image html img/widget/flipselector/preview-00.png
22914 * @image latex img/widget/flipselector/preview-00.eps
22916 * A flip selector is a widget to show a set of @b text items, one
22917 * at a time, with the same sheet switching style as the @ref Clock
22918 * "clock" widget, when one changes the current displaying sheet
22919 * (thus, the "flip" in the name).
22921 * User clicks to flip sheets which are @b held for some time will
22922 * make the flip selector to flip continuosly and automatically for
22923 * the user. The interval between flips will keep growing in time,
22924 * so that it helps the user to reach an item which is distant from
22925 * the current selection.
22927 * Smart callbacks one can register to:
22928 * - @c "selected" - when the widget's selected text item is changed
22929 * - @c "overflowed" - when the widget's current selection is changed
22930 * from the first item in its list to the last
22931 * - @c "underflowed" - when the widget's current selection is changed
22932 * from the last item in its list to the first
22934 * Available styles for it:
22937 * Here is an example on its usage:
22938 * @li @ref flipselector_example
22942 * @addtogroup Flipselector
22946 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22949 * Add a new flip selector widget to the given parent Elementary
22950 * (container) widget
22952 * @param parent The parent object
22953 * @return a new flip selector widget handle or @c NULL, on errors
22955 * This function inserts a new flip selector widget on the canvas.
22957 * @ingroup Flipselector
22959 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22962 * Programmatically select the next item of a flip selector widget
22964 * @param obj The flipselector object
22966 * @note The selection will be animated. Also, if it reaches the
22967 * end of its list of member items, it will continue with the first
22970 * @ingroup Flipselector
22972 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22975 * Programmatically select the previous item of a flip selector
22978 * @param obj The flipselector object
22980 * @note The selection will be animated. Also, if it reaches the
22981 * beginning of its list of member items, it will continue with the
22982 * last one backwards.
22984 * @ingroup Flipselector
22986 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22989 * Append a (text) item to a flip selector widget
22991 * @param obj The flipselector object
22992 * @param label The (text) label of the new item
22993 * @param func Convenience callback function to take place when
22995 * @param data Data passed to @p func, above
22996 * @return A handle to the item added or @c NULL, on errors
22998 * The widget's list of labels to show will be appended with the
22999 * given value. If the user wishes so, a callback function pointer
23000 * can be passed, which will get called when this same item is
23003 * @note The current selection @b won't be modified by appending an
23004 * element to the list.
23006 * @note The maximum length of the text label is going to be
23007 * determined <b>by the widget's theme</b>. Strings larger than
23008 * that value are going to be @b truncated.
23010 * @ingroup Flipselector
23012 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23015 * Prepend a (text) item to a flip selector widget
23017 * @param obj The flipselector object
23018 * @param label The (text) label of the new item
23019 * @param func Convenience callback function to take place when
23021 * @param data Data passed to @p func, above
23022 * @return A handle to the item added or @c NULL, on errors
23024 * The widget's list of labels to show will be prepended with the
23025 * given value. If the user wishes so, a callback function pointer
23026 * can be passed, which will get called when this same item is
23029 * @note The current selection @b won't be modified by prepending
23030 * an element to the list.
23032 * @note The maximum length of the text label is going to be
23033 * determined <b>by the widget's theme</b>. Strings larger than
23034 * that value are going to be @b truncated.
23036 * @ingroup Flipselector
23038 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23041 * Get the internal list of items in a given flip selector widget.
23043 * @param obj The flipselector object
23044 * @return The list of items (#Elm_Flipselector_Item as data) or
23045 * @c NULL on errors.
23047 * This list is @b not to be modified in any way and must not be
23048 * freed. Use the list members with functions like
23049 * elm_flipselector_item_label_set(),
23050 * elm_flipselector_item_label_get(),
23051 * elm_flipselector_item_del(),
23052 * elm_flipselector_item_selected_get(),
23053 * elm_flipselector_item_selected_set().
23055 * @warning This list is only valid until @p obj object's internal
23056 * items list is changed. It should be fetched again with another
23057 * call to this function when changes happen.
23059 * @ingroup Flipselector
23061 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23064 * Get the first item in the given flip selector widget's list of
23067 * @param obj The flipselector object
23068 * @return The first item or @c NULL, if it has no items (and on
23071 * @see elm_flipselector_item_append()
23072 * @see elm_flipselector_last_item_get()
23074 * @ingroup Flipselector
23076 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23079 * Get the last item in the given flip selector widget's list of
23082 * @param obj The flipselector object
23083 * @return The last item or @c NULL, if it has no items (and on
23086 * @see elm_flipselector_item_prepend()
23087 * @see elm_flipselector_first_item_get()
23089 * @ingroup Flipselector
23091 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23094 * Get the currently selected item in a flip selector widget.
23096 * @param obj The flipselector object
23097 * @return The selected item or @c NULL, if the widget has no items
23100 * @ingroup Flipselector
23102 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23105 * Set whether a given flip selector widget's item should be the
23106 * currently selected one.
23108 * @param item The flip selector item
23109 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23111 * This sets whether @p item is or not the selected (thus, under
23112 * display) one. If @p item is different than one under display,
23113 * the latter will be unselected. If the @p item is set to be
23114 * unselected, on the other hand, the @b first item in the widget's
23115 * internal members list will be the new selected one.
23117 * @see elm_flipselector_item_selected_get()
23119 * @ingroup Flipselector
23121 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23124 * Get whether a given flip selector widget's item is the currently
23127 * @param item The flip selector item
23128 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23131 * @see elm_flipselector_item_selected_set()
23133 * @ingroup Flipselector
23135 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23138 * Delete a given item from a flip selector widget.
23140 * @param item The item to delete
23142 * @ingroup Flipselector
23144 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23147 * Get the label of a given flip selector widget's item.
23149 * @param item The item to get label from
23150 * @return The text label of @p item or @c NULL, on errors
23152 * @see elm_flipselector_item_label_set()
23154 * @ingroup Flipselector
23156 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23159 * Set the label of a given flip selector widget's item.
23161 * @param item The item to set label on
23162 * @param label The text label string, in UTF-8 encoding
23164 * @see elm_flipselector_item_label_get()
23166 * @ingroup Flipselector
23168 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23171 * Gets the item before @p item in a flip selector widget's
23172 * internal list of items.
23174 * @param item The item to fetch previous from
23175 * @return The item before the @p item, in its parent's list. If
23176 * there is no previous item for @p item or there's an
23177 * error, @c NULL is returned.
23179 * @see elm_flipselector_item_next_get()
23181 * @ingroup Flipselector
23183 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23186 * Gets the item after @p item in a flip selector widget's
23187 * internal list of items.
23189 * @param item The item to fetch next from
23190 * @return The item after the @p item, in its parent's list. If
23191 * there is no next item for @p item or there's an
23192 * error, @c NULL is returned.
23194 * @see elm_flipselector_item_next_get()
23196 * @ingroup Flipselector
23198 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23201 * Set the interval on time updates for an user mouse button hold
23202 * on a flip selector widget.
23204 * @param obj The flip selector object
23205 * @param interval The (first) interval value in seconds
23207 * This interval value is @b decreased while the user holds the
23208 * mouse pointer either flipping up or flipping doww a given flip
23211 * This helps the user to get to a given item distant from the
23212 * current one easier/faster, as it will start to flip quicker and
23213 * quicker on mouse button holds.
23215 * The calculation for the next flip interval value, starting from
23216 * the one set with this call, is the previous interval divided by
23217 * 1.05, so it decreases a little bit.
23219 * The default starting interval value for automatic flips is
23222 * @see elm_flipselector_interval_get()
23224 * @ingroup Flipselector
23226 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23229 * Get the interval on time updates for an user mouse button hold
23230 * on a flip selector widget.
23232 * @param obj The flip selector object
23233 * @return The (first) interval value, in seconds, set on it
23235 * @see elm_flipselector_interval_set() for more details
23237 * @ingroup Flipselector
23239 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23245 * @addtogroup Calendar
23250 * @enum _Elm_Calendar_Mark_Repeat
23251 * @typedef Elm_Calendar_Mark_Repeat
23253 * Event periodicity, used to define if a mark should be repeated
23254 * @b beyond event's day. It's set when a mark is added.
23256 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23257 * there will be marks every week after this date. Marks will be displayed
23258 * at 13th, 20th, 27th, 3rd June ...
23260 * Values don't work as bitmask, only one can be choosen.
23262 * @see elm_calendar_mark_add()
23264 * @ingroup Calendar
23266 typedef enum _Elm_Calendar_Mark_Repeat
23268 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23269 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23270 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23271 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*/
23272 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. */
23273 } Elm_Calendar_Mark_Repeat;
23275 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(). */
23278 * Add a new calendar widget to the given parent Elementary
23279 * (container) object.
23281 * @param parent The parent object.
23282 * @return a new calendar widget handle or @c NULL, on errors.
23284 * This function inserts a new calendar widget on the canvas.
23286 * @ref calendar_example_01
23288 * @ingroup Calendar
23290 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23293 * Get weekdays names displayed by the calendar.
23295 * @param obj The calendar object.
23296 * @return Array of seven strings to be used as weekday names.
23298 * By default, weekdays abbreviations get from system are displayed:
23299 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23300 * The first string is related to Sunday, the second to Monday...
23302 * @see elm_calendar_weekdays_name_set()
23304 * @ref calendar_example_05
23306 * @ingroup Calendar
23308 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23311 * Set weekdays names to be displayed by the calendar.
23313 * @param obj The calendar object.
23314 * @param weekdays Array of seven strings to be used as weekday names.
23315 * @warning It must have 7 elements, or it will access invalid memory.
23316 * @warning The strings must be NULL terminated ('@\0').
23318 * By default, weekdays abbreviations get from system are displayed:
23319 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23321 * The first string should be related to Sunday, the second to Monday...
23323 * The usage should be like this:
23325 * const char *weekdays[] =
23327 * "Sunday", "Monday", "Tuesday", "Wednesday",
23328 * "Thursday", "Friday", "Saturday"
23330 * elm_calendar_weekdays_names_set(calendar, weekdays);
23333 * @see elm_calendar_weekdays_name_get()
23335 * @ref calendar_example_02
23337 * @ingroup Calendar
23339 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23342 * Set the minimum and maximum values for the year
23344 * @param obj The calendar object
23345 * @param min The minimum year, greater than 1901;
23346 * @param max The maximum year;
23348 * Maximum must be greater than minimum, except if you don't wan't to set
23350 * Default values are 1902 and -1.
23352 * If the maximum year is a negative value, it will be limited depending
23353 * on the platform architecture (year 2037 for 32 bits);
23355 * @see elm_calendar_min_max_year_get()
23357 * @ref calendar_example_03
23359 * @ingroup Calendar
23361 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23364 * Get the minimum and maximum values for the year
23366 * @param obj The calendar object.
23367 * @param min The minimum year.
23368 * @param max The maximum year.
23370 * Default values are 1902 and -1.
23372 * @see elm_calendar_min_max_year_get() for more details.
23374 * @ref calendar_example_05
23376 * @ingroup Calendar
23378 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23381 * Enable or disable day selection
23383 * @param obj The calendar object.
23384 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23387 * Enabled by default. If disabled, the user still can select months,
23388 * but not days. Selected days are highlighted on calendar.
23389 * It should be used if you won't need such selection for the widget usage.
23391 * When a day is selected, or month is changed, smart callbacks for
23392 * signal "changed" will be called.
23394 * @see elm_calendar_day_selection_enable_get()
23396 * @ref calendar_example_04
23398 * @ingroup Calendar
23400 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23403 * Get a value whether day selection is enabled or not.
23405 * @see elm_calendar_day_selection_enable_set() for details.
23407 * @param obj The calendar object.
23408 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23409 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23411 * @ref calendar_example_05
23413 * @ingroup Calendar
23415 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23419 * Set selected date to be highlighted on calendar.
23421 * @param obj The calendar object.
23422 * @param selected_time A @b tm struct to represent the selected date.
23424 * Set the selected date, changing the displayed month if needed.
23425 * Selected date changes when the user goes to next/previous month or
23426 * select a day pressing over it on calendar.
23428 * @see elm_calendar_selected_time_get()
23430 * @ref calendar_example_04
23432 * @ingroup Calendar
23434 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23437 * Get selected date.
23439 * @param obj The calendar object
23440 * @param selected_time A @b tm struct to point to selected date
23441 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23444 * Get date selected by the user or set by function
23445 * elm_calendar_selected_time_set().
23446 * Selected date changes when the user goes to next/previous month or
23447 * select a day pressing over it on calendar.
23449 * @see elm_calendar_selected_time_get()
23451 * @ref calendar_example_05
23453 * @ingroup Calendar
23455 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23458 * Set a function to format the string that will be used to display
23461 * @param obj The calendar object
23462 * @param format_function Function to set the month-year string given
23463 * the selected date
23465 * By default it uses strftime with "%B %Y" format string.
23466 * It should allocate the memory that will be used by the string,
23467 * that will be freed by the widget after usage.
23468 * A pointer to the string and a pointer to the time struct will be provided.
23473 * _format_month_year(struct tm *selected_time)
23476 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23477 * return strdup(buf);
23480 * elm_calendar_format_function_set(calendar, _format_month_year);
23483 * @ref calendar_example_02
23485 * @ingroup Calendar
23487 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23490 * Add a new mark to the calendar
23492 * @param obj The calendar object
23493 * @param mark_type A string used to define the type of mark. It will be
23494 * emitted to the theme, that should display a related modification on these
23495 * days representation.
23496 * @param mark_time A time struct to represent the date of inclusion of the
23497 * mark. For marks that repeats it will just be displayed after the inclusion
23498 * date in the calendar.
23499 * @param repeat Repeat the event following this periodicity. Can be a unique
23500 * mark (that don't repeat), daily, weekly, monthly or annually.
23501 * @return The created mark or @p NULL upon failure.
23503 * Add a mark that will be drawn in the calendar respecting the insertion
23504 * time and periodicity. It will emit the type as signal to the widget theme.
23505 * Default theme supports "holiday" and "checked", but it can be extended.
23507 * It won't immediately update the calendar, drawing the marks.
23508 * For this, call elm_calendar_marks_draw(). However, when user selects
23509 * next or previous month calendar forces marks drawn.
23511 * Marks created with this method can be deleted with
23512 * elm_calendar_mark_del().
23516 * struct tm selected_time;
23517 * time_t current_time;
23519 * current_time = time(NULL) + 5 * 84600;
23520 * localtime_r(¤t_time, &selected_time);
23521 * elm_calendar_mark_add(cal, "holiday", selected_time,
23522 * ELM_CALENDAR_ANNUALLY);
23524 * current_time = time(NULL) + 1 * 84600;
23525 * localtime_r(¤t_time, &selected_time);
23526 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23528 * elm_calendar_marks_draw(cal);
23531 * @see elm_calendar_marks_draw()
23532 * @see elm_calendar_mark_del()
23534 * @ref calendar_example_06
23536 * @ingroup Calendar
23538 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);
23541 * Delete mark from the calendar.
23543 * @param mark The mark to be deleted.
23545 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23546 * should be used instead of getting marks list and deleting each one.
23548 * @see elm_calendar_mark_add()
23550 * @ref calendar_example_06
23552 * @ingroup Calendar
23554 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23557 * Remove all calendar's marks
23559 * @param obj The calendar object.
23561 * @see elm_calendar_mark_add()
23562 * @see elm_calendar_mark_del()
23564 * @ingroup Calendar
23566 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23570 * Get a list of all the calendar marks.
23572 * @param obj The calendar object.
23573 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23575 * @see elm_calendar_mark_add()
23576 * @see elm_calendar_mark_del()
23577 * @see elm_calendar_marks_clear()
23579 * @ingroup Calendar
23581 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23584 * Draw calendar marks.
23586 * @param obj The calendar object.
23588 * Should be used after adding, removing or clearing marks.
23589 * It will go through the entire marks list updating the calendar.
23590 * If lots of marks will be added, add all the marks and then call
23593 * When the month is changed, i.e. user selects next or previous month,
23594 * marks will be drawed.
23596 * @see elm_calendar_mark_add()
23597 * @see elm_calendar_mark_del()
23598 * @see elm_calendar_marks_clear()
23600 * @ref calendar_example_06
23602 * @ingroup Calendar
23604 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23607 * Set a day text color to the same that represents Saturdays.
23609 * @param obj The calendar object.
23610 * @param pos The text position. Position is the cell counter, from left
23611 * to right, up to down. It starts on 0 and ends on 41.
23613 * @deprecated use elm_calendar_mark_add() instead like:
23616 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23617 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23620 * @see elm_calendar_mark_add()
23622 * @ingroup Calendar
23624 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23627 * Set a day text color to the same that represents Sundays.
23629 * @param obj The calendar object.
23630 * @param pos The text position. Position is the cell counter, from left
23631 * to right, up to down. It starts on 0 and ends on 41.
23633 * @deprecated use elm_calendar_mark_add() instead like:
23636 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23637 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23640 * @see elm_calendar_mark_add()
23642 * @ingroup Calendar
23644 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23647 * Set a day text color to the same that represents Weekdays.
23649 * @param obj The calendar object
23650 * @param pos The text position. Position is the cell counter, from left
23651 * to right, up to down. It starts on 0 and ends on 41.
23653 * @deprecated use elm_calendar_mark_add() instead like:
23656 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23658 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23659 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23660 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23661 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23662 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23663 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23664 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23665 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23666 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23669 * @see elm_calendar_mark_add()
23671 * @ingroup Calendar
23673 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23676 * Set the interval on time updates for an user mouse button hold
23677 * on calendar widgets' month selection.
23679 * @param obj The calendar object
23680 * @param interval The (first) interval value in seconds
23682 * This interval value is @b decreased while the user holds the
23683 * mouse pointer either selecting next or previous month.
23685 * This helps the user to get to a given month distant from the
23686 * current one easier/faster, as it will start to change quicker and
23687 * quicker on mouse button holds.
23689 * The calculation for the next change interval value, starting from
23690 * the one set with this call, is the previous interval divided by
23691 * 1.05, so it decreases a little bit.
23693 * The default starting interval value for automatic changes is
23696 * @see elm_calendar_interval_get()
23698 * @ingroup Calendar
23700 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23703 * Get the interval on time updates for an user mouse button hold
23704 * on calendar widgets' month selection.
23706 * @param obj The calendar object
23707 * @return The (first) interval value, in seconds, set on it
23709 * @see elm_calendar_interval_set() for more details
23711 * @ingroup Calendar
23713 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23720 * @defgroup Diskselector Diskselector
23721 * @ingroup Elementary
23723 * @image html img/widget/diskselector/preview-00.png
23724 * @image latex img/widget/diskselector/preview-00.eps
23726 * A diskselector is a kind of list widget. It scrolls horizontally,
23727 * and can contain label and icon objects. Three items are displayed
23728 * with the selected one in the middle.
23730 * It can act like a circular list with round mode and labels can be
23731 * reduced for a defined length for side items.
23733 * Smart callbacks one can listen to:
23734 * - "selected" - when item is selected, i.e. scroller stops.
23736 * Available styles for it:
23739 * List of examples:
23740 * @li @ref diskselector_example_01
23741 * @li @ref diskselector_example_02
23745 * @addtogroup Diskselector
23749 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(). */
23752 * Add a new diskselector widget to the given parent Elementary
23753 * (container) object.
23755 * @param parent The parent object.
23756 * @return a new diskselector widget handle or @c NULL, on errors.
23758 * This function inserts a new diskselector widget on the canvas.
23760 * @ingroup Diskselector
23762 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23765 * Enable or disable round mode.
23767 * @param obj The diskselector object.
23768 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23771 * Disabled by default. If round mode is enabled the items list will
23772 * work like a circle list, so when the user reaches the last item,
23773 * the first one will popup.
23775 * @see elm_diskselector_round_get()
23777 * @ingroup Diskselector
23779 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23782 * Get a value whether round mode is enabled or not.
23784 * @see elm_diskselector_round_set() for details.
23786 * @param obj The diskselector object.
23787 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23788 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23790 * @ingroup Diskselector
23792 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23795 * Get the side labels max length.
23797 * @deprecated use elm_diskselector_side_label_length_get() instead:
23799 * @param obj The diskselector object.
23800 * @return The max length defined for side labels, or 0 if not a valid
23803 * @ingroup Diskselector
23805 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23808 * Set the side labels max length.
23810 * @deprecated use elm_diskselector_side_label_length_set() instead:
23812 * @param obj The diskselector object.
23813 * @param len The max length defined for side labels.
23815 * @ingroup Diskselector
23817 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23820 * Get the side labels max length.
23822 * @see elm_diskselector_side_label_length_set() for details.
23824 * @param obj The diskselector object.
23825 * @return The max length defined for side labels, or 0 if not a valid
23828 * @ingroup Diskselector
23830 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23833 * Set the side labels max length.
23835 * @param obj The diskselector object.
23836 * @param len The max length defined for side labels.
23838 * Length is the number of characters of items' label that will be
23839 * visible when it's set on side positions. It will just crop
23840 * the string after defined size. E.g.:
23842 * An item with label "January" would be displayed on side position as
23843 * "Jan" if max length is set to 3, or "Janu", if this property
23846 * When it's selected, the entire label will be displayed, except for
23847 * width restrictions. In this case label will be cropped and "..."
23848 * will be concatenated.
23850 * Default side label max length is 3.
23852 * This property will be applyed over all items, included before or
23853 * later this function call.
23855 * @ingroup Diskselector
23857 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23860 * Set the number of items to be displayed.
23862 * @param obj The diskselector object.
23863 * @param num The number of items the diskselector will display.
23865 * Default value is 3, and also it's the minimun. If @p num is less
23866 * than 3, it will be set to 3.
23868 * Also, it can be set on theme, using data item @c display_item_num
23869 * on group "elm/diskselector/item/X", where X is style set.
23872 * group { name: "elm/diskselector/item/X";
23874 * item: "display_item_num" "5";
23877 * @ingroup Diskselector
23879 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23882 * Set bouncing behaviour when the scrolled content reaches an edge.
23884 * Tell the internal scroller object whether it should bounce or not
23885 * when it reaches the respective edges for each axis.
23887 * @param obj The diskselector object.
23888 * @param h_bounce Whether to bounce or not in the horizontal axis.
23889 * @param v_bounce Whether to bounce or not in the vertical axis.
23891 * @see elm_scroller_bounce_set()
23893 * @ingroup Diskselector
23895 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23898 * Get the bouncing behaviour of the internal scroller.
23900 * Get whether the internal scroller should bounce when the edge of each
23901 * axis is reached scrolling.
23903 * @param obj The diskselector object.
23904 * @param h_bounce Pointer where to store the bounce state of the horizontal
23906 * @param v_bounce Pointer where to store the bounce state of the vertical
23909 * @see elm_scroller_bounce_get()
23910 * @see elm_diskselector_bounce_set()
23912 * @ingroup Diskselector
23914 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23917 * Get the scrollbar policy.
23919 * @see elm_diskselector_scroller_policy_get() for details.
23921 * @param obj The diskselector object.
23922 * @param policy_h Pointer where to store horizontal scrollbar policy.
23923 * @param policy_v Pointer where to store vertical scrollbar policy.
23925 * @ingroup Diskselector
23927 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);
23930 * Set the scrollbar policy.
23932 * @param obj The diskselector object.
23933 * @param policy_h Horizontal scrollbar policy.
23934 * @param policy_v Vertical scrollbar policy.
23936 * This sets the scrollbar visibility policy for the given scroller.
23937 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23938 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23939 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23940 * This applies respectively for the horizontal and vertical scrollbars.
23942 * The both are disabled by default, i.e., are set to
23943 * #ELM_SCROLLER_POLICY_OFF.
23945 * @ingroup Diskselector
23947 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23950 * Remove all diskselector's items.
23952 * @param obj The diskselector object.
23954 * @see elm_diskselector_item_del()
23955 * @see elm_diskselector_item_append()
23957 * @ingroup Diskselector
23959 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23962 * Get a list of all the diskselector items.
23964 * @param obj The diskselector object.
23965 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
23966 * or @c NULL on failure.
23968 * @see elm_diskselector_item_append()
23969 * @see elm_diskselector_item_del()
23970 * @see elm_diskselector_clear()
23972 * @ingroup Diskselector
23974 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23977 * Appends a new item to the diskselector object.
23979 * @param obj The diskselector object.
23980 * @param label The label of the diskselector item.
23981 * @param icon The icon object to use at left side of the item. An
23982 * icon can be any Evas object, but usually it is an icon created
23983 * with elm_icon_add().
23984 * @param func The function to call when the item is selected.
23985 * @param data The data to associate with the item for related callbacks.
23987 * @return The created item or @c NULL upon failure.
23989 * A new item will be created and appended to the diskselector, i.e., will
23990 * be set as last item. Also, if there is no selected item, it will
23991 * be selected. This will always happens for the first appended item.
23993 * If no icon is set, label will be centered on item position, otherwise
23994 * the icon will be placed at left of the label, that will be shifted
23997 * Items created with this method can be deleted with
23998 * elm_diskselector_item_del().
24000 * Associated @p data can be properly freed when item is deleted if a
24001 * callback function is set with elm_diskselector_item_del_cb_set().
24003 * If a function is passed as argument, it will be called everytime this item
24004 * is selected, i.e., the user stops the diskselector with this
24005 * item on center position. If such function isn't needed, just passing
24006 * @c NULL as @p func is enough. The same should be done for @p data.
24008 * Simple example (with no function callback or data associated):
24010 * disk = elm_diskselector_add(win);
24011 * ic = elm_icon_add(win);
24012 * elm_icon_file_set(ic, "path/to/image", NULL);
24013 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24014 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24017 * @see elm_diskselector_item_del()
24018 * @see elm_diskselector_item_del_cb_set()
24019 * @see elm_diskselector_clear()
24020 * @see elm_icon_add()
24022 * @ingroup Diskselector
24024 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);
24028 * Delete them item from the diskselector.
24030 * @param it The item of diskselector to be deleted.
24032 * If deleting all diskselector items is required, elm_diskselector_clear()
24033 * should be used instead of getting items list and deleting each one.
24035 * @see elm_diskselector_clear()
24036 * @see elm_diskselector_item_append()
24037 * @see elm_diskselector_item_del_cb_set()
24039 * @ingroup Diskselector
24041 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24044 * Set the function called when a diskselector item is freed.
24046 * @param it The item to set the callback on
24047 * @param func The function called
24049 * If there is a @p func, then it will be called prior item's memory release.
24050 * That will be called with the following arguments:
24052 * @li item's Evas object;
24055 * This way, a data associated to a diskselector item could be properly
24058 * @ingroup Diskselector
24060 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24063 * Get the data associated to the item.
24065 * @param it The diskselector item
24066 * @return The data associated to @p it
24068 * The return value is a pointer to data associated to @p item when it was
24069 * created, with function elm_diskselector_item_append(). If no data
24070 * was passed as argument, it will return @c NULL.
24072 * @see elm_diskselector_item_append()
24074 * @ingroup Diskselector
24076 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24079 * Set the icon associated to the item.
24081 * @param it The diskselector item
24082 * @param icon The icon object to associate with @p it
24084 * The icon object to use at left side of the item. An
24085 * icon can be any Evas object, but usually it is an icon created
24086 * with elm_icon_add().
24088 * Once the icon object is set, a previously set one will be deleted.
24089 * @warning Setting the same icon for two items will cause the icon to
24090 * dissapear from the first item.
24092 * If an icon was passed as argument on item creation, with function
24093 * elm_diskselector_item_append(), it will be already
24094 * associated to the item.
24096 * @see elm_diskselector_item_append()
24097 * @see elm_diskselector_item_icon_get()
24099 * @ingroup Diskselector
24101 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24104 * Get the icon associated to the item.
24106 * @param it The diskselector item
24107 * @return The icon associated to @p it
24109 * The return value is a pointer to the icon associated to @p item when it was
24110 * created, with function elm_diskselector_item_append(), or later
24111 * with function elm_diskselector_item_icon_set. If no icon
24112 * was passed as argument, it will return @c NULL.
24114 * @see elm_diskselector_item_append()
24115 * @see elm_diskselector_item_icon_set()
24117 * @ingroup Diskselector
24119 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24122 * Set the label of item.
24124 * @param it The item of diskselector.
24125 * @param label The label of item.
24127 * The label to be displayed by the item.
24129 * If no icon is set, label will be centered on item position, otherwise
24130 * the icon will be placed at left of the label, that will be shifted
24133 * An item with label "January" would be displayed on side position as
24134 * "Jan" if max length is set to 3 with function
24135 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24138 * When this @p item is selected, the entire label will be displayed,
24139 * except for width restrictions.
24140 * In this case label will be cropped and "..." will be concatenated,
24141 * but only for display purposes. It will keep the entire string, so
24142 * if diskselector is resized the remaining characters will be displayed.
24144 * If a label was passed as argument on item creation, with function
24145 * elm_diskselector_item_append(), it will be already
24146 * displayed by the item.
24148 * @see elm_diskselector_side_label_lenght_set()
24149 * @see elm_diskselector_item_label_get()
24150 * @see elm_diskselector_item_append()
24152 * @ingroup Diskselector
24154 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24157 * Get the label of item.
24159 * @param it The item of diskselector.
24160 * @return The label of item.
24162 * The return value is a pointer to the label associated to @p item when it was
24163 * created, with function elm_diskselector_item_append(), or later
24164 * with function elm_diskselector_item_label_set. If no label
24165 * was passed as argument, it will return @c NULL.
24167 * @see elm_diskselector_item_label_set() for more details.
24168 * @see elm_diskselector_item_append()
24170 * @ingroup Diskselector
24172 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24175 * Get the selected item.
24177 * @param obj The diskselector object.
24178 * @return The selected diskselector item.
24180 * The selected item can be unselected with function
24181 * elm_diskselector_item_selected_set(), and the first item of
24182 * diskselector will be selected.
24184 * The selected item always will be centered on diskselector, with
24185 * full label displayed, i.e., max lenght set to side labels won't
24186 * apply on the selected item. More details on
24187 * elm_diskselector_side_label_length_set().
24189 * @ingroup Diskselector
24191 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24194 * Set the selected state of an item.
24196 * @param it The diskselector item
24197 * @param selected The selected state
24199 * This sets the selected state of the given item @p it.
24200 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24202 * If a new item is selected the previosly selected will be unselected.
24203 * Previoulsy selected item can be get with function
24204 * elm_diskselector_selected_item_get().
24206 * If the item @p it is unselected, the first item of diskselector will
24209 * Selected items will be visible on center position of diskselector.
24210 * So if it was on another position before selected, or was invisible,
24211 * diskselector will animate items until the selected item reaches center
24214 * @see elm_diskselector_item_selected_get()
24215 * @see elm_diskselector_selected_item_get()
24217 * @ingroup Diskselector
24219 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24222 * Get whether the @p item is selected or not.
24224 * @param it The diskselector item.
24225 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24226 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24228 * @see elm_diskselector_selected_item_set() for details.
24229 * @see elm_diskselector_item_selected_get()
24231 * @ingroup Diskselector
24233 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24236 * Get the first item of the diskselector.
24238 * @param obj The diskselector object.
24239 * @return The first item, or @c NULL if none.
24241 * The list of items follows append order. So it will return the first
24242 * item appended to the widget that wasn't deleted.
24244 * @see elm_diskselector_item_append()
24245 * @see elm_diskselector_items_get()
24247 * @ingroup Diskselector
24249 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24252 * Get the last item of the diskselector.
24254 * @param obj The diskselector object.
24255 * @return The last item, or @c NULL if none.
24257 * The list of items follows append order. So it will return last first
24258 * item appended to the widget that wasn't deleted.
24260 * @see elm_diskselector_item_append()
24261 * @see elm_diskselector_items_get()
24263 * @ingroup Diskselector
24265 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24268 * Get the item before @p item in diskselector.
24270 * @param it The diskselector item.
24271 * @return The item before @p item, or @c NULL if none or on failure.
24273 * The list of items follows append order. So it will return item appended
24274 * just before @p item and that wasn't deleted.
24276 * If it is the first item, @c NULL will be returned.
24277 * First item can be get by elm_diskselector_first_item_get().
24279 * @see elm_diskselector_item_append()
24280 * @see elm_diskselector_items_get()
24282 * @ingroup Diskselector
24284 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24287 * Get the item after @p item in diskselector.
24289 * @param it The diskselector item.
24290 * @return The item after @p item, or @c NULL if none or on failure.
24292 * The list of items follows append order. So it will return item appended
24293 * just after @p item and that wasn't deleted.
24295 * If it is the last item, @c NULL will be returned.
24296 * Last item can be get by elm_diskselector_last_item_get().
24298 * @see elm_diskselector_item_append()
24299 * @see elm_diskselector_items_get()
24301 * @ingroup Diskselector
24303 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24306 * Set the text to be shown in the diskselector item.
24308 * @param item Target item
24309 * @param text The text to set in the content
24311 * Setup the text as tooltip to object. The item can have only one tooltip,
24312 * so any previous tooltip data is removed.
24314 * @see elm_object_tooltip_text_set() for more details.
24316 * @ingroup Diskselector
24318 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24321 * Set the content to be shown in the tooltip item.
24323 * Setup the tooltip to item. The item can have only one tooltip,
24324 * so any previous tooltip data is removed. @p func(with @p data) will
24325 * be called every time that need show the tooltip and it should
24326 * return a valid Evas_Object. This object is then managed fully by
24327 * tooltip system and is deleted when the tooltip is gone.
24329 * @param item the diskselector item being attached a tooltip.
24330 * @param func the function used to create the tooltip contents.
24331 * @param data what to provide to @a func as callback data/context.
24332 * @param del_cb called when data is not needed anymore, either when
24333 * another callback replaces @p func, the tooltip is unset with
24334 * elm_diskselector_item_tooltip_unset() or the owner @a item
24335 * dies. This callback receives as the first parameter the
24336 * given @a data, and @c event_info is the item.
24338 * @see elm_object_tooltip_content_cb_set() for more details.
24340 * @ingroup Diskselector
24342 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);
24345 * Unset tooltip from item.
24347 * @param item diskselector item to remove previously set tooltip.
24349 * Remove tooltip from item. The callback provided as del_cb to
24350 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24351 * it is not used anymore.
24353 * @see elm_object_tooltip_unset() for more details.
24354 * @see elm_diskselector_item_tooltip_content_cb_set()
24356 * @ingroup Diskselector
24358 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24362 * Sets a different style for this item tooltip.
24364 * @note before you set a style you should define a tooltip with
24365 * elm_diskselector_item_tooltip_content_cb_set() or
24366 * elm_diskselector_item_tooltip_text_set()
24368 * @param item diskselector item with tooltip already set.
24369 * @param style the theme style to use (default, transparent, ...)
24371 * @see elm_object_tooltip_style_set() for more details.
24373 * @ingroup Diskselector
24375 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24378 * Get the style for this item tooltip.
24380 * @param item diskselector item with tooltip already set.
24381 * @return style the theme style in use, defaults to "default". If the
24382 * object does not have a tooltip set, then NULL is returned.
24384 * @see elm_object_tooltip_style_get() for more details.
24385 * @see elm_diskselector_item_tooltip_style_set()
24387 * @ingroup Diskselector
24389 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24392 * Set the cursor to be shown when mouse is over the diskselector item
24394 * @param item Target item
24395 * @param cursor the cursor name to be used.
24397 * @see elm_object_cursor_set() for more details.
24399 * @ingroup Diskselector
24401 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24404 * Get the cursor to be shown when mouse is over the diskselector item
24406 * @param item diskselector item with cursor already set.
24407 * @return the cursor name.
24409 * @see elm_object_cursor_get() for more details.
24410 * @see elm_diskselector_cursor_set()
24412 * @ingroup Diskselector
24414 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24418 * Unset the cursor to be shown when mouse is over the diskselector item
24420 * @param item Target item
24422 * @see elm_object_cursor_unset() for more details.
24423 * @see elm_diskselector_cursor_set()
24425 * @ingroup Diskselector
24427 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24430 * Sets a different style for this item cursor.
24432 * @note before you set a style you should define a cursor with
24433 * elm_diskselector_item_cursor_set()
24435 * @param item diskselector item with cursor already set.
24436 * @param style the theme style to use (default, transparent, ...)
24438 * @see elm_object_cursor_style_set() for more details.
24440 * @ingroup Diskselector
24442 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24446 * Get the style for this item cursor.
24448 * @param item diskselector item with cursor already set.
24449 * @return style the theme style in use, defaults to "default". If the
24450 * object does not have a cursor set, then @c NULL is returned.
24452 * @see elm_object_cursor_style_get() for more details.
24453 * @see elm_diskselector_item_cursor_style_set()
24455 * @ingroup Diskselector
24457 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24461 * Set if the cursor set should be searched on the theme or should use
24462 * the provided by the engine, only.
24464 * @note before you set if should look on theme you should define a cursor
24465 * with elm_diskselector_item_cursor_set().
24466 * By default it will only look for cursors provided by the engine.
24468 * @param item widget item with cursor already set.
24469 * @param engine_only boolean to define if cursors set with
24470 * elm_diskselector_item_cursor_set() should be searched only
24471 * between cursors provided by the engine or searched on widget's
24474 * @see elm_object_cursor_engine_only_set() for more details.
24476 * @ingroup Diskselector
24478 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24481 * Get the cursor engine only usage for this item cursor.
24483 * @param item widget item with cursor already set.
24484 * @return engine_only boolean to define it cursors should be looked only
24485 * between the provided by the engine or searched on widget's theme as well.
24486 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24488 * @see elm_object_cursor_engine_only_get() for more details.
24489 * @see elm_diskselector_item_cursor_engine_only_set()
24491 * @ingroup Diskselector
24493 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24500 * @defgroup Colorselector Colorselector
24504 * @image html img/widget/colorselector/preview-00.png
24505 * @image latex img/widget/colorselector/preview-00.eps
24507 * @brief Widget for user to select a color.
24509 * Signals that you can add callbacks for are:
24510 * "changed" - When the color value changes(event_info is NULL).
24512 * See @ref tutorial_colorselector.
24515 * @brief Add a new colorselector to the parent
24517 * @param parent The parent object
24518 * @return The new object or NULL if it cannot be created
24520 * @ingroup Colorselector
24522 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24524 * Set a color for the colorselector
24526 * @param obj Colorselector object
24527 * @param r r-value of color
24528 * @param g g-value of color
24529 * @param b b-value of color
24530 * @param a a-value of color
24532 * @ingroup Colorselector
24534 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24536 * Get a color from the colorselector
24538 * @param obj Colorselector object
24539 * @param r integer pointer for r-value of color
24540 * @param g integer pointer for g-value of color
24541 * @param b integer pointer for b-value of color
24542 * @param a integer pointer for a-value of color
24544 * @ingroup Colorselector
24546 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24552 * @defgroup Ctxpopup Ctxpopup
24554 * @image html img/widget/ctxpopup/preview-00.png
24555 * @image latex img/widget/ctxpopup/preview-00.eps
24557 * @brief Context popup widet.
24559 * A ctxpopup is a widget that, when shown, pops up a list of items.
24560 * It automatically chooses an area inside its parent object's view
24561 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24562 * optimally fit into it. In the default theme, it will also point an
24563 * arrow to it's top left position at the time one shows it. Ctxpopup
24564 * items have a label and/or an icon. It is intended for a small
24565 * number of items (hence the use of list, not genlist).
24567 * @note Ctxpopup is a especialization of @ref Hover.
24569 * Signals that you can add callbacks for are:
24570 * "dismissed" - the ctxpopup was dismissed
24572 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24575 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
24577 typedef enum _Elm_Ctxpopup_Direction
24579 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24581 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24582 the clicked area */
24583 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24584 the clicked area */
24585 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24587 } Elm_Ctxpopup_Direction;
24590 * @brief Add a new Ctxpopup object to the parent.
24592 * @param parent Parent object
24593 * @return New object or @c NULL, if it cannot be created
24595 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24597 * @brief Set the Ctxpopup's parent
24599 * @param obj The ctxpopup object
24600 * @param area The parent to use
24602 * Set the parent object.
24604 * @note elm_ctxpopup_add() will automatically call this function
24605 * with its @c parent argument.
24607 * @see elm_ctxpopup_add()
24608 * @see elm_hover_parent_set()
24610 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24612 * @brief Get the Ctxpopup's parent
24614 * @param obj The ctxpopup object
24616 * @see elm_ctxpopup_hover_parent_set() for more information
24618 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24620 * @brief Clear all items in the given ctxpopup object.
24622 * @param obj Ctxpopup object
24624 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24626 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24628 * @param obj Ctxpopup object
24629 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24631 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24633 * @brief Get the value of current ctxpopup object's orientation.
24635 * @param obj Ctxpopup object
24636 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24638 * @see elm_ctxpopup_horizontal_set()
24640 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24642 * @brief Add a new item to a ctxpopup object.
24644 * @param obj Ctxpopup object
24645 * @param icon Icon to be set on new item
24646 * @param label The Label of the new item
24647 * @param func Convenience function called when item selected
24648 * @param data Data passed to @p func
24649 * @return A handle to the item added or @c NULL, on errors
24651 * @warning Ctxpopup can't hold both an item list and a content at the same
24652 * time. When an item is added, any previous content will be removed.
24654 * @see elm_ctxpopup_content_set()
24656 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);
24658 * @brief Delete the given item in a ctxpopup object.
24660 * @param item Ctxpopup item to be deleted
24662 * @see elm_ctxpopup_item_append()
24664 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
24666 * @brief Set the ctxpopup item's state as disabled or enabled.
24668 * @param item Ctxpopup item to be enabled/disabled
24669 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24671 * When disabled the item is greyed out to indicate it's state.
24673 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24675 * @brief Get the ctxpopup item's disabled/enabled state.
24677 * @param item Ctxpopup item to be enabled/disabled
24678 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24680 * @see elm_ctxpopup_item_disabled_set()
24682 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24684 * @brief Get the icon object for the given ctxpopup item.
24686 * @param item Ctxpopup item
24687 * @return icon object or @c NULL, if the item does not have icon or an error
24690 * @see elm_ctxpopup_item_append()
24691 * @see elm_ctxpopup_item_icon_set()
24693 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24695 * @brief Sets the side icon associated with the ctxpopup item
24697 * @param item Ctxpopup item
24698 * @param icon Icon object to be set
24700 * Once the icon object is set, a previously set one will be deleted.
24701 * @warning Setting the same icon for two items will cause the icon to
24702 * dissapear from the first item.
24704 * @see elm_ctxpopup_item_append()
24706 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24708 * @brief Get the label for the given ctxpopup item.
24710 * @param item Ctxpopup item
24711 * @return label string or @c NULL, if the item does not have label or an
24714 * @see elm_ctxpopup_item_append()
24715 * @see elm_ctxpopup_item_label_set()
24717 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24719 * @brief (Re)set the label on the given ctxpopup item.
24721 * @param item Ctxpopup item
24722 * @param label String to set as label
24724 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
24726 * @brief Set an elm widget as the content of the ctxpopup.
24728 * @param obj Ctxpopup object
24729 * @param content Content to be swallowed
24731 * If the content object is already set, a previous one will bedeleted. If
24732 * you want to keep that old content object, use the
24733 * elm_ctxpopup_content_unset() function.
24735 * @deprecated use elm_object_content_set()
24737 * @warning Ctxpopup can't hold both a item list and a content at the same
24738 * time. When a content is set, any previous items will be removed.
24740 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24742 * @brief Unset the ctxpopup content
24744 * @param obj Ctxpopup object
24745 * @return The content that was being used
24747 * Unparent and return the content object which was set for this widget.
24749 * @deprecated use elm_object_content_unset()
24751 * @see elm_ctxpopup_content_set()
24753 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24755 * @brief Set the direction priority of a ctxpopup.
24757 * @param obj Ctxpopup object
24758 * @param first 1st priority of direction
24759 * @param second 2nd priority of direction
24760 * @param third 3th priority of direction
24761 * @param fourth 4th priority of direction
24763 * This functions gives a chance to user to set the priority of ctxpopup
24764 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24765 * requested direction.
24767 * @see Elm_Ctxpopup_Direction
24769 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);
24771 * @brief Get the direction priority of a ctxpopup.
24773 * @param obj Ctxpopup object
24774 * @param first 1st priority of direction to be returned
24775 * @param second 2nd priority of direction to be returned
24776 * @param third 3th priority of direction to be returned
24777 * @param fourth 4th priority of direction to be returned
24779 * @see elm_ctxpopup_direction_priority_set() for more information.
24781 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);
24789 * @defgroup Transit Transit
24790 * @ingroup Elementary
24792 * Transit is designed to apply various animated transition effects to @c
24793 * Evas_Object, such like translation, rotation, etc. For using these
24794 * effects, create an @ref Elm_Transit and add the desired transition effects.
24796 * Once the effects are added into transit, they will be automatically
24797 * managed (their callback will be called until the duration is ended, and
24798 * they will be deleted on completion).
24802 * Elm_Transit *trans = elm_transit_add();
24803 * elm_transit_object_add(trans, obj);
24804 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24805 * elm_transit_duration_set(transit, 1);
24806 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24807 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24808 * elm_transit_repeat_times_set(transit, 3);
24811 * Some transition effects are used to change the properties of objects. They
24813 * @li @ref elm_transit_effect_translation_add
24814 * @li @ref elm_transit_effect_color_add
24815 * @li @ref elm_transit_effect_rotation_add
24816 * @li @ref elm_transit_effect_wipe_add
24817 * @li @ref elm_transit_effect_zoom_add
24818 * @li @ref elm_transit_effect_resizing_add
24820 * Other transition effects are used to make one object disappear and another
24821 * object appear on its old place. These effects are:
24823 * @li @ref elm_transit_effect_flip_add
24824 * @li @ref elm_transit_effect_resizable_flip_add
24825 * @li @ref elm_transit_effect_fade_add
24826 * @li @ref elm_transit_effect_blend_add
24828 * It's also possible to make a transition chain with @ref
24829 * elm_transit_chain_transit_add.
24831 * @warning We strongly recommend to use elm_transit just when edje can not do
24832 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24833 * animations can be manipulated inside the theme.
24835 * List of examples:
24836 * @li @ref transit_example_01_explained
24837 * @li @ref transit_example_02_explained
24838 * @li @ref transit_example_03_c
24839 * @li @ref transit_example_04_c
24845 * @enum Elm_Transit_Tween_Mode
24847 * The type of acceleration used in the transition.
24851 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24852 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24853 over time, then decrease again
24855 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24857 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24859 } Elm_Transit_Tween_Mode;
24862 * @enum Elm_Transit_Effect_Flip_Axis
24864 * The axis where flip effect should be applied.
24868 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24869 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24870 } Elm_Transit_Effect_Flip_Axis;
24872 * @enum Elm_Transit_Effect_Wipe_Dir
24874 * The direction where the wipe effect should occur.
24878 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24879 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24880 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24881 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24882 } Elm_Transit_Effect_Wipe_Dir;
24883 /** @enum Elm_Transit_Effect_Wipe_Type
24885 * Whether the wipe effect should show or hide the object.
24889 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24891 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24893 } Elm_Transit_Effect_Wipe_Type;
24896 * @typedef Elm_Transit
24898 * The Transit created with elm_transit_add(). This type has the information
24899 * about the objects which the transition will be applied, and the
24900 * transition effects that will be used. It also contains info about
24901 * duration, number of repetitions, auto-reverse, etc.
24903 typedef struct _Elm_Transit Elm_Transit;
24904 typedef void Elm_Transit_Effect;
24906 * @typedef Elm_Transit_Effect_Transition_Cb
24908 * Transition callback called for this effect on each transition iteration.
24910 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24912 * Elm_Transit_Effect_End_Cb
24914 * Transition callback called for this effect when the transition is over.
24916 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24919 * Elm_Transit_Del_Cb
24921 * A callback called when the transit is deleted.
24923 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24928 * @note Is not necessary to delete the transit object, it will be deleted at
24929 * the end of its operation.
24930 * @note The transit will start playing when the program enter in the main loop, is not
24931 * necessary to give a start to the transit.
24933 * @return The transit object.
24937 EAPI Elm_Transit *elm_transit_add(void);
24940 * Stops the animation and delete the @p transit object.
24942 * Call this function if you wants to stop the animation before the duration
24943 * time. Make sure the @p transit object is still alive with
24944 * elm_transit_del_cb_set() function.
24945 * All added effects will be deleted, calling its repective data_free_cb
24946 * functions. The function setted by elm_transit_del_cb_set() will be called.
24948 * @see elm_transit_del_cb_set()
24950 * @param transit The transit object to be deleted.
24953 * @warning Just call this function if you are sure the transit is alive.
24955 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24958 * Add a new effect to the transit.
24960 * @note The cb function and the data are the key to the effect. If you try to
24961 * add an already added effect, nothing is done.
24962 * @note After the first addition of an effect in @p transit, if its
24963 * effect list become empty again, the @p transit will be killed by
24964 * elm_transit_del(transit) function.
24968 * Elm_Transit *transit = elm_transit_add();
24969 * elm_transit_effect_add(transit,
24970 * elm_transit_effect_blend_op,
24971 * elm_transit_effect_blend_context_new(),
24972 * elm_transit_effect_blend_context_free);
24975 * @param transit The transit object.
24976 * @param transition_cb The operation function. It is called when the
24977 * animation begins, it is the function that actually performs the animation.
24978 * It is called with the @p data, @p transit and the time progression of the
24979 * animation (a double value between 0.0 and 1.0).
24980 * @param effect The context data of the effect.
24981 * @param end_cb The function to free the context data, it will be called
24982 * at the end of the effect, it must finalize the animation and free the
24986 * @warning The transit free the context data at the and of the transition with
24987 * the data_free_cb function, do not use the context data in another transit.
24989 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);
24992 * Delete an added effect.
24994 * This function will remove the effect from the @p transit, calling the
24995 * data_free_cb to free the @p data.
24997 * @see elm_transit_effect_add()
24999 * @note If the effect is not found, nothing is done.
25000 * @note If the effect list become empty, this function will call
25001 * elm_transit_del(transit), that is, it will kill the @p transit.
25003 * @param transit The transit object.
25004 * @param transition_cb The operation function.
25005 * @param effect The context data of the effect.
25009 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);
25012 * Add new object to apply the effects.
25014 * @note After the first addition of an object in @p transit, if its
25015 * object list become empty again, the @p transit will be killed by
25016 * elm_transit_del(transit) function.
25017 * @note If the @p obj belongs to another transit, the @p obj will be
25018 * removed from it and it will only belong to the @p transit. If the old
25019 * transit stays without objects, it will die.
25020 * @note When you add an object into the @p transit, its state from
25021 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25022 * transit ends, if you change this state whith evas_object_pass_events_set()
25023 * after add the object, this state will change again when @p transit stops to
25026 * @param transit The transit object.
25027 * @param obj Object to be animated.
25030 * @warning It is not allowed to add a new object after transit begins to go.
25032 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25035 * Removes an added object from the transit.
25037 * @note If the @p obj is not in the @p transit, nothing is done.
25038 * @note If the list become empty, this function will call
25039 * elm_transit_del(transit), that is, it will kill the @p transit.
25041 * @param transit The transit object.
25042 * @param obj Object to be removed from @p transit.
25045 * @warning It is not allowed to remove objects after transit begins to go.
25047 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25050 * Get the objects of the transit.
25052 * @param transit The transit object.
25053 * @return a Eina_List with the objects from the transit.
25057 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25060 * Enable/disable keeping up the objects states.
25061 * If it is not kept, the objects states will be reset when transition ends.
25063 * @note @p transit can not be NULL.
25064 * @note One state includes geometry, color, map data.
25066 * @param transit The transit object.
25067 * @param state_keep Keeping or Non Keeping.
25071 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25074 * Get a value whether the objects states will be reset or not.
25076 * @note @p transit can not be NULL
25078 * @see elm_transit_objects_final_state_keep_set()
25080 * @param transit The transit object.
25081 * @return EINA_TRUE means the states of the objects will be reset.
25082 * If @p transit is NULL, EINA_FALSE is returned
25086 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25089 * Set the event enabled when transit is operating.
25091 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25092 * events from mouse and keyboard during the animation.
25093 * @note When you add an object with elm_transit_object_add(), its state from
25094 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25095 * transit ends, if you change this state with evas_object_pass_events_set()
25096 * after adding the object, this state will change again when @p transit stops
25099 * @param transit The transit object.
25100 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25101 * ignored otherwise.
25105 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25108 * Get the value of event enabled status.
25110 * @see elm_transit_event_enabled_set()
25112 * @param transit The Transit object
25113 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25114 * EINA_FALSE is returned
25118 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25121 * Set the user-callback function when the transit is deleted.
25123 * @note Using this function twice will overwrite the first function setted.
25124 * @note the @p transit object will be deleted after call @p cb function.
25126 * @param transit The transit object.
25127 * @param cb Callback function pointer. This function will be called before
25128 * the deletion of the transit.
25129 * @param data Callback funtion user data. It is the @p op parameter.
25133 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25136 * Set reverse effect automatically.
25138 * If auto reverse is setted, after running the effects with the progress
25139 * parameter from 0 to 1, it will call the effecs again with the progress
25140 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25141 * where the duration was setted with the function elm_transit_add and
25142 * the repeat with the function elm_transit_repeat_times_set().
25144 * @param transit The transit object.
25145 * @param reverse EINA_TRUE means the auto_reverse is on.
25149 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25152 * Get if the auto reverse is on.
25154 * @see elm_transit_auto_reverse_set()
25156 * @param transit The transit object.
25157 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25158 * EINA_FALSE is returned
25162 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25165 * Set the transit repeat count. Effect will be repeated by repeat count.
25167 * This function sets the number of repetition the transit will run after
25168 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25169 * If the @p repeat is a negative number, it will repeat infinite times.
25171 * @note If this function is called during the transit execution, the transit
25172 * will run @p repeat times, ignoring the times it already performed.
25174 * @param transit The transit object
25175 * @param repeat Repeat count
25179 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25182 * Get the transit repeat count.
25184 * @see elm_transit_repeat_times_set()
25186 * @param transit The Transit object.
25187 * @return The repeat count. If @p transit is NULL
25192 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25195 * Set the transit animation acceleration type.
25197 * This function sets the tween mode of the transit that can be:
25198 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25199 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25200 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25201 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25203 * @param transit The transit object.
25204 * @param tween_mode The tween type.
25208 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25211 * Get the transit animation acceleration type.
25213 * @note @p transit can not be NULL
25215 * @param transit The transit object.
25216 * @return The tween type. If @p transit is NULL
25217 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25221 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25224 * Set the transit animation time
25226 * @note @p transit can not be NULL
25228 * @param transit The transit object.
25229 * @param duration The animation time.
25233 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25236 * Get the transit animation time
25238 * @note @p transit can not be NULL
25240 * @param transit The transit object.
25242 * @return The transit animation time.
25246 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25249 * Starts the transition.
25250 * Once this API is called, the transit begins to measure the time.
25252 * @note @p transit can not be NULL
25254 * @param transit The transit object.
25258 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25261 * Pause/Resume the transition.
25263 * If you call elm_transit_go again, the transit will be started from the
25264 * beginning, and will be unpaused.
25266 * @note @p transit can not be NULL
25268 * @param transit The transit object.
25269 * @param paused Whether the transition should be paused or not.
25273 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25276 * Get the value of paused status.
25278 * @see elm_transit_paused_set()
25280 * @note @p transit can not be NULL
25282 * @param transit The transit object.
25283 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25284 * EINA_FALSE is returned
25288 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25291 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25293 * The value returned is a fraction (current time / total time). It
25294 * represents the progression position relative to the total.
25296 * @note @p transit can not be NULL
25298 * @param transit The transit object.
25300 * @return The time progression value. If @p transit is NULL
25305 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25308 * Makes the chain relationship between two transits.
25310 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25311 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25313 * @param transit The transit object.
25314 * @param chain_transit The chain transit object. This transit will be operated
25315 * after transit is done.
25317 * This function adds @p chain_transit transition to a chain after the @p
25318 * transit, and will be started as soon as @p transit ends. See @ref
25319 * transit_example_02_explained for a full example.
25323 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25326 * Cut off the chain relationship between two transits.
25328 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25329 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25331 * @param transit The transit object.
25332 * @param chain_transit The chain transit object.
25334 * This function remove the @p chain_transit transition from the @p transit.
25338 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25341 * Get the current chain transit list.
25343 * @note @p transit can not be NULL.
25345 * @param transit The transit object.
25346 * @return chain transit list.
25350 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25353 * Add the Resizing Effect to Elm_Transit.
25355 * @note This API is one of the facades. It creates resizing effect context
25356 * and add it's required APIs to elm_transit_effect_add.
25358 * @see elm_transit_effect_add()
25360 * @param transit Transit object.
25361 * @param from_w Object width size when effect begins.
25362 * @param from_h Object height size when effect begins.
25363 * @param to_w Object width size when effect ends.
25364 * @param to_h Object height size when effect ends.
25365 * @return Resizing effect context data.
25369 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);
25372 * Add the Translation Effect to Elm_Transit.
25374 * @note This API is one of the facades. It creates translation effect context
25375 * and add it's required APIs to elm_transit_effect_add.
25377 * @see elm_transit_effect_add()
25379 * @param transit Transit object.
25380 * @param from_dx X Position variation when effect begins.
25381 * @param from_dy Y Position variation when effect begins.
25382 * @param to_dx X Position variation when effect ends.
25383 * @param to_dy Y Position variation when effect ends.
25384 * @return Translation effect context data.
25387 * @warning It is highly recommended just create a transit with this effect when
25388 * the window that the objects of the transit belongs has already been created.
25389 * This is because this effect needs the geometry information about the objects,
25390 * and if the window was not created yet, it can get a wrong information.
25392 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);
25395 * Add the Zoom Effect to Elm_Transit.
25397 * @note This API is one of the facades. It creates zoom effect context
25398 * and add it's required APIs to elm_transit_effect_add.
25400 * @see elm_transit_effect_add()
25402 * @param transit Transit object.
25403 * @param from_rate Scale rate when effect begins (1 is current rate).
25404 * @param to_rate Scale rate when effect ends.
25405 * @return Zoom effect context data.
25408 * @warning It is highly recommended just create a transit with this effect when
25409 * the window that the objects of the transit belongs has already been created.
25410 * This is because this effect needs the geometry information about the objects,
25411 * and if the window was not created yet, it can get a wrong information.
25413 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25416 * Add the Flip Effect to Elm_Transit.
25418 * @note This API is one of the facades. It creates flip effect context
25419 * and add it's required APIs to elm_transit_effect_add.
25420 * @note This effect is applied to each pair of objects in the order they are listed
25421 * in the transit list of objects. The first object in the pair will be the
25422 * "front" object and the second will be the "back" object.
25424 * @see elm_transit_effect_add()
25426 * @param transit Transit object.
25427 * @param axis Flipping Axis(X or Y).
25428 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25429 * @return Flip effect context data.
25432 * @warning It is highly recommended just create a transit with this effect when
25433 * the window that the objects of the transit belongs has already been created.
25434 * This is because this effect needs the geometry information about the objects,
25435 * and if the window was not created yet, it can get a wrong information.
25437 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25440 * Add the Resizable Flip Effect to Elm_Transit.
25442 * @note This API is one of the facades. It creates resizable flip effect context
25443 * and add it's required APIs to elm_transit_effect_add.
25444 * @note This effect is applied to each pair of objects in the order they are listed
25445 * in the transit list of objects. The first object in the pair will be the
25446 * "front" object and the second will be the "back" object.
25448 * @see elm_transit_effect_add()
25450 * @param transit Transit object.
25451 * @param axis Flipping Axis(X or Y).
25452 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25453 * @return Resizable flip effect context data.
25456 * @warning It is highly recommended just create a transit with this effect when
25457 * the window that the objects of the transit belongs has already been created.
25458 * This is because this effect needs the geometry information about the objects,
25459 * and if the window was not created yet, it can get a wrong information.
25461 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25464 * Add the Wipe Effect to Elm_Transit.
25466 * @note This API is one of the facades. It creates wipe effect context
25467 * and add it's required APIs to elm_transit_effect_add.
25469 * @see elm_transit_effect_add()
25471 * @param transit Transit object.
25472 * @param type Wipe type. Hide or show.
25473 * @param dir Wipe Direction.
25474 * @return Wipe effect context data.
25477 * @warning It is highly recommended just create a transit with this effect when
25478 * the window that the objects of the transit belongs has already been created.
25479 * This is because this effect needs the geometry information about the objects,
25480 * and if the window was not created yet, it can get a wrong information.
25482 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25485 * Add the Color Effect to Elm_Transit.
25487 * @note This API is one of the facades. It creates color effect context
25488 * and add it's required APIs to elm_transit_effect_add.
25490 * @see elm_transit_effect_add()
25492 * @param transit Transit object.
25493 * @param from_r RGB R when effect begins.
25494 * @param from_g RGB G when effect begins.
25495 * @param from_b RGB B when effect begins.
25496 * @param from_a RGB A when effect begins.
25497 * @param to_r RGB R when effect ends.
25498 * @param to_g RGB G when effect ends.
25499 * @param to_b RGB B when effect ends.
25500 * @param to_a RGB A when effect ends.
25501 * @return Color effect context data.
25505 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);
25508 * Add the Fade Effect to Elm_Transit.
25510 * @note This API is one of the facades. It creates fade effect context
25511 * and add it's required APIs to elm_transit_effect_add.
25512 * @note This effect is applied to each pair of objects in the order they are listed
25513 * in the transit list of objects. The first object in the pair will be the
25514 * "before" object and the second will be the "after" object.
25516 * @see elm_transit_effect_add()
25518 * @param transit Transit object.
25519 * @return Fade effect context data.
25522 * @warning It is highly recommended just create a transit with this effect when
25523 * the window that the objects of the transit belongs has already been created.
25524 * This is because this effect needs the color information about the objects,
25525 * and if the window was not created yet, it can get a wrong information.
25527 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25530 * Add the Blend Effect to Elm_Transit.
25532 * @note This API is one of the facades. It creates blend effect context
25533 * and add it's required APIs to elm_transit_effect_add.
25534 * @note This effect is applied to each pair of objects in the order they are listed
25535 * in the transit list of objects. The first object in the pair will be the
25536 * "before" object and the second will be the "after" object.
25538 * @see elm_transit_effect_add()
25540 * @param transit Transit object.
25541 * @return Blend effect context data.
25544 * @warning It is highly recommended just create a transit with this effect when
25545 * the window that the objects of the transit belongs has already been created.
25546 * This is because this effect needs the color information about the objects,
25547 * and if the window was not created yet, it can get a wrong information.
25549 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25552 * Add the Rotation Effect to Elm_Transit.
25554 * @note This API is one of the facades. It creates rotation effect context
25555 * and add it's required APIs to elm_transit_effect_add.
25557 * @see elm_transit_effect_add()
25559 * @param transit Transit object.
25560 * @param from_degree Degree when effect begins.
25561 * @param to_degree Degree when effect is ends.
25562 * @return Rotation effect context data.
25565 * @warning It is highly recommended just create a transit with this effect when
25566 * the window that the objects of the transit belongs has already been created.
25567 * This is because this effect needs the geometry information about the objects,
25568 * and if the window was not created yet, it can get a wrong information.
25570 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25573 * Add the ImageAnimation Effect to Elm_Transit.
25575 * @note This API is one of the facades. It creates image animation effect context
25576 * and add it's required APIs to elm_transit_effect_add.
25577 * The @p images parameter is a list images paths. This list and
25578 * its contents will be deleted at the end of the effect by
25579 * elm_transit_effect_image_animation_context_free() function.
25583 * char buf[PATH_MAX];
25584 * Eina_List *images = NULL;
25585 * Elm_Transit *transi = elm_transit_add();
25587 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25588 * images = eina_list_append(images, eina_stringshare_add(buf));
25590 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25591 * images = eina_list_append(images, eina_stringshare_add(buf));
25592 * elm_transit_effect_image_animation_add(transi, images);
25596 * @see elm_transit_effect_add()
25598 * @param transit Transit object.
25599 * @param images Eina_List of images file paths. This list and
25600 * its contents will be deleted at the end of the effect by
25601 * elm_transit_effect_image_animation_context_free() function.
25602 * @return Image Animation effect context data.
25606 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25611 typedef struct _Elm_Store Elm_Store;
25612 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25613 typedef struct _Elm_Store_Item Elm_Store_Item;
25614 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25615 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25616 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25617 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25618 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25619 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25620 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25621 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25623 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25624 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25625 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25626 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25630 ELM_STORE_ITEM_MAPPING_NONE = 0,
25631 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25632 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25633 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25634 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25635 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25636 // can add more here as needed by common apps
25637 ELM_STORE_ITEM_MAPPING_LAST
25638 } Elm_Store_Item_Mapping_Type;
25640 struct _Elm_Store_Item_Mapping_Icon
25642 // FIXME: allow edje file icons
25644 Elm_Icon_Lookup_Order lookup_order;
25645 Eina_Bool standard_name : 1;
25646 Eina_Bool no_scale : 1;
25647 Eina_Bool smooth : 1;
25648 Eina_Bool scale_up : 1;
25649 Eina_Bool scale_down : 1;
25652 struct _Elm_Store_Item_Mapping_Empty
25657 struct _Elm_Store_Item_Mapping_Photo
25662 struct _Elm_Store_Item_Mapping_Custom
25664 Elm_Store_Item_Mapping_Cb func;
25667 struct _Elm_Store_Item_Mapping
25669 Elm_Store_Item_Mapping_Type type;
25674 Elm_Store_Item_Mapping_Empty empty;
25675 Elm_Store_Item_Mapping_Icon icon;
25676 Elm_Store_Item_Mapping_Photo photo;
25677 Elm_Store_Item_Mapping_Custom custom;
25678 // add more types here
25682 struct _Elm_Store_Item_Info
25684 Elm_Genlist_Item_Class *item_class;
25685 const Elm_Store_Item_Mapping *mapping;
25690 struct _Elm_Store_Item_Info_Filesystem
25692 Elm_Store_Item_Info base;
25696 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25697 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25699 EAPI void elm_store_free(Elm_Store *st);
25701 EAPI Elm_Store *elm_store_filesystem_new(void);
25702 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25703 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25704 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25706 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25708 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25709 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25710 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25711 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25712 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25713 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25715 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25716 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25717 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25718 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25719 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25720 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25721 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25724 * @defgroup SegmentControl SegmentControl
25725 * @ingroup Elementary
25727 * @image html img/widget/segment_control/preview-00.png
25728 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25730 * @image html img/segment_control.png
25731 * @image latex img/segment_control.eps width=\textwidth
25733 * Segment control widget is a horizontal control made of multiple segment
25734 * items, each segment item functioning similar to discrete two state button.
25735 * A segment control groups the items together and provides compact
25736 * single button with multiple equal size segments.
25738 * Segment item size is determined by base widget
25739 * size and the number of items added.
25740 * Only one segment item can be at selected state. A segment item can display
25741 * combination of Text and any Evas_Object like Images or other widget.
25743 * Smart callbacks one can listen to:
25744 * - "changed" - When the user clicks on a segment item which is not
25745 * previously selected and get selected. The event_info parameter is the
25746 * segment item index.
25748 * Available styles for it:
25751 * Here is an example on its usage:
25752 * @li @ref segment_control_example
25756 * @addtogroup SegmentControl
25760 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25763 * Add a new segment control widget to the given parent Elementary
25764 * (container) object.
25766 * @param parent The parent object.
25767 * @return a new segment control widget handle or @c NULL, on errors.
25769 * This function inserts a new segment control widget on the canvas.
25771 * @ingroup SegmentControl
25773 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25776 * Append a new item to the segment control object.
25778 * @param obj The segment control object.
25779 * @param icon The icon object to use for the left side of the item. An
25780 * icon can be any Evas object, but usually it is an icon created
25781 * with elm_icon_add().
25782 * @param label The label of the item.
25783 * Note that, NULL is different from empty string "".
25784 * @return The created item or @c NULL upon failure.
25786 * A new item will be created and appended to the segment control, i.e., will
25787 * be set as @b last item.
25789 * If it should be inserted at another position,
25790 * elm_segment_control_item_insert_at() should be used instead.
25792 * Items created with this function can be deleted with function
25793 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25795 * @note @p label set to @c NULL is different from empty string "".
25797 * only has icon, it will be displayed bigger and centered. If it has
25798 * icon and label, even that an empty string, icon will be smaller and
25799 * positioned at left.
25803 * sc = elm_segment_control_add(win);
25804 * ic = elm_icon_add(win);
25805 * elm_icon_file_set(ic, "path/to/image", NULL);
25806 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25807 * elm_segment_control_item_add(sc, ic, "label");
25808 * evas_object_show(sc);
25811 * @see elm_segment_control_item_insert_at()
25812 * @see elm_segment_control_item_del()
25814 * @ingroup SegmentControl
25816 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25819 * Insert a new item to the segment control object at specified position.
25821 * @param obj The segment control object.
25822 * @param icon The icon object to use for the left side of the item. An
25823 * icon can be any Evas object, but usually it is an icon created
25824 * with elm_icon_add().
25825 * @param label The label of the item.
25826 * @param index Item position. Value should be between 0 and items count.
25827 * @return The created item or @c NULL upon failure.
25829 * Index values must be between @c 0, when item will be prepended to
25830 * segment control, and items count, that can be get with
25831 * elm_segment_control_item_count_get(), case when item will be appended
25832 * to segment control, just like elm_segment_control_item_add().
25834 * Items created with this function can be deleted with function
25835 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25837 * @note @p label set to @c NULL is different from empty string "".
25839 * only has icon, it will be displayed bigger and centered. If it has
25840 * icon and label, even that an empty string, icon will be smaller and
25841 * positioned at left.
25843 * @see elm_segment_control_item_add()
25844 * @see elm_segment_control_count_get()
25845 * @see elm_segment_control_item_del()
25847 * @ingroup SegmentControl
25849 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);
25852 * Remove a segment control item from its parent, deleting it.
25854 * @param it The item to be removed.
25856 * Items can be added with elm_segment_control_item_add() or
25857 * elm_segment_control_item_insert_at().
25859 * @ingroup SegmentControl
25861 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25864 * Remove a segment control item at given index from its parent,
25867 * @param obj The segment control object.
25868 * @param index The position of the segment control item to be deleted.
25870 * Items can be added with elm_segment_control_item_add() or
25871 * elm_segment_control_item_insert_at().
25873 * @ingroup SegmentControl
25875 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25878 * Get the Segment items count from segment control.
25880 * @param obj The segment control object.
25881 * @return Segment items count.
25883 * It will just return the number of items added to segment control @p obj.
25885 * @ingroup SegmentControl
25887 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25890 * Get the item placed at specified index.
25892 * @param obj The segment control object.
25893 * @param index The index of the segment item.
25894 * @return The segment control item or @c NULL on failure.
25896 * Index is the position of an item in segment control widget. Its
25897 * range is from @c 0 to <tt> count - 1 </tt>.
25898 * Count is the number of items, that can be get with
25899 * elm_segment_control_item_count_get().
25901 * @ingroup SegmentControl
25903 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25906 * Get the label of item.
25908 * @param obj The segment control object.
25909 * @param index The index of the segment item.
25910 * @return The label of the item at @p index.
25912 * The return value is a pointer to the label associated to the item when
25913 * it was created, with function elm_segment_control_item_add(), or later
25914 * with function elm_segment_control_item_label_set. If no label
25915 * was passed as argument, it will return @c NULL.
25917 * @see elm_segment_control_item_label_set() for more details.
25918 * @see elm_segment_control_item_add()
25920 * @ingroup SegmentControl
25922 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25925 * Set the label of item.
25927 * @param it The item of segment control.
25928 * @param text The label of item.
25930 * The label to be displayed by the item.
25931 * Label will be at right of the icon (if set).
25933 * If a label was passed as argument on item creation, with function
25934 * elm_control_segment_item_add(), it will be already
25935 * displayed by the item.
25937 * @see elm_segment_control_item_label_get()
25938 * @see elm_segment_control_item_add()
25940 * @ingroup SegmentControl
25942 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25945 * Get the icon associated to the item.
25947 * @param obj The segment control object.
25948 * @param index The index of the segment item.
25949 * @return The left side icon associated to the item at @p index.
25951 * The return value is a pointer to the icon associated to the item when
25952 * it was created, with function elm_segment_control_item_add(), or later
25953 * with function elm_segment_control_item_icon_set(). If no icon
25954 * was passed as argument, it will return @c NULL.
25956 * @see elm_segment_control_item_add()
25957 * @see elm_segment_control_item_icon_set()
25959 * @ingroup SegmentControl
25961 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25964 * Set the icon associated to the item.
25966 * @param it The segment control item.
25967 * @param icon The icon object to associate with @p it.
25969 * The icon object to use at left side of the item. An
25970 * icon can be any Evas object, but usually it is an icon created
25971 * with elm_icon_add().
25973 * Once the icon object is set, a previously set one will be deleted.
25974 * @warning Setting the same icon for two items will cause the icon to
25975 * dissapear from the first item.
25977 * If an icon was passed as argument on item creation, with function
25978 * elm_segment_control_item_add(), it will be already
25979 * associated to the item.
25981 * @see elm_segment_control_item_add()
25982 * @see elm_segment_control_item_icon_get()
25984 * @ingroup SegmentControl
25986 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25989 * Get the index of an item.
25991 * @param it The segment control item.
25992 * @return The position of item in segment control widget.
25994 * Index is the position of an item in segment control widget. Its
25995 * range is from @c 0 to <tt> count - 1 </tt>.
25996 * Count is the number of items, that can be get with
25997 * elm_segment_control_item_count_get().
25999 * @ingroup SegmentControl
26001 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26004 * Get the base object of the item.
26006 * @param it The segment control item.
26007 * @return The base object associated with @p it.
26009 * Base object is the @c Evas_Object that represents that item.
26011 * @ingroup SegmentControl
26013 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26016 * Get the selected item.
26018 * @param obj The segment control object.
26019 * @return The selected item or @c NULL if none of segment items is
26022 * The selected item can be unselected with function
26023 * elm_segment_control_item_selected_set().
26025 * The selected item always will be highlighted on segment control.
26027 * @ingroup SegmentControl
26029 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26032 * Set the selected state of an item.
26034 * @param it The segment control item
26035 * @param select The selected state
26037 * This sets the selected state of the given item @p it.
26038 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26040 * If a new item is selected the previosly selected will be unselected.
26041 * Previoulsy selected item can be get with function
26042 * elm_segment_control_item_selected_get().
26044 * The selected item always will be highlighted on segment control.
26046 * @see elm_segment_control_item_selected_get()
26048 * @ingroup SegmentControl
26050 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26057 * @defgroup Grid Grid
26059 * The grid is a grid layout widget that lays out a series of children as a
26060 * fixed "grid" of widgets using a given percentage of the grid width and
26061 * height each using the child object.
26063 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26064 * widgets size itself. The default is 100 x 100, so that means the
26065 * position and sizes of children will effectively be percentages (0 to 100)
26066 * of the width or height of the grid widget
26072 * Add a new grid to the parent
26074 * @param parent The parent object
26075 * @return The new object or NULL if it cannot be created
26079 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26082 * Set the virtual size of the grid
26084 * @param obj The grid object
26085 * @param w The virtual width of the grid
26086 * @param h The virtual height of the grid
26090 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26093 * Get the virtual size of the grid
26095 * @param obj The grid object
26096 * @param w Pointer to integer to store the virtual width of the grid
26097 * @param h Pointer to integer to store the virtual height of the grid
26101 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26104 * Pack child at given position and size
26106 * @param obj The grid object
26107 * @param subobj The child to pack
26108 * @param x The virtual x coord at which to pack it
26109 * @param y The virtual y coord at which to pack it
26110 * @param w The virtual width at which to pack it
26111 * @param h The virtual height at which to pack it
26115 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26118 * Unpack a child from a grid object
26120 * @param obj The grid object
26121 * @param subobj The child to unpack
26125 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26128 * Faster way to remove all child objects from a grid object.
26130 * @param obj The grid object
26131 * @param clear If true, it will delete just removed children
26135 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26138 * Set packing of an existing child at to position and size
26140 * @param subobj The child to set packing of
26141 * @param x The virtual x coord at which to pack it
26142 * @param y The virtual y coord at which to pack it
26143 * @param w The virtual width at which to pack it
26144 * @param h The virtual height at which to pack it
26148 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26151 * get packing of a child
26153 * @param subobj The child to query
26154 * @param x Pointer to integer to store the virtual x coord
26155 * @param y Pointer to integer to store the virtual y coord
26156 * @param w Pointer to integer to store the virtual width
26157 * @param h Pointer to integer to store the virtual height
26161 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26167 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26168 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26169 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26172 * @defgroup Video Video
26174 * This object display an player that let you control an Elm_Video
26175 * object. It take care of updating it's content according to what is
26176 * going on inside the Emotion object. It does activate the remember
26177 * function on the linked Elm_Video object.
26179 * Signals that you cann add callback for are :
26181 * "forward,clicked" - the user clicked the forward button.
26182 * "info,clicked" - the user clicked the info button.
26183 * "next,clicked" - the user clicked the next button.
26184 * "pause,clicked" - the user clicked the pause button.
26185 * "play,clicked" - the user clicked the play button.
26186 * "prev,clicked" - the user clicked the prev button.
26187 * "rewind,clicked" - the user clicked the rewind button.
26188 * "stop,clicked" - the user clicked the stop button.
26190 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26191 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26192 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26193 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26194 EAPI void elm_video_play(Evas_Object *video);
26195 EAPI void elm_video_pause(Evas_Object *video);
26196 EAPI void elm_video_stop(Evas_Object *video);
26197 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26198 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26199 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26200 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26201 EAPI double elm_video_audio_level_get(Evas_Object *video);
26202 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26203 EAPI double elm_video_play_position_get(Evas_Object *video);
26204 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26205 EAPI double elm_video_play_length_get(Evas_Object *video);
26206 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26207 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26208 EAPI const char *elm_video_title_get(Evas_Object *video);
26210 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26211 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26214 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26215 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);
26216 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26217 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26218 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26219 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26220 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26221 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26222 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26223 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26224 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26225 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26226 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26227 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26228 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);