3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to buiuld it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
306 * @brief Elementary's API
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
322 /* Standard headers for standard system calls etc. */
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
343 # ifdef ELM_LIBINTL_H
344 # include <libintl.h>
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
358 # define alloca _alloca
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
386 # include <Ethumb_Client.h>
398 # ifdef ELEMENTARY_BUILD
400 # define EAPI __declspec(dllexport)
403 # endif /* ! DLL_EXPORT */
405 # define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
410 # define EAPI __attribute__ ((visibility("default")))
417 #endif /* ! _WIN32 */
420 /* allow usage from c++ */
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
428 typedef struct _Elm_Version
436 EAPI extern Elm_Version *elm_version;
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
443 * @defgroup General General
445 * @brief General Elementary API. Functions that don't relate to
446 * Elementary objects specifically.
448 * Here are documented functions which init/shutdown the library,
449 * that apply to generic Elementary objects, that deal with
450 * configuration, et cetera.
452 * @ref general_functions_example_page "This" example contemplates
453 * some of these functions.
457 * @addtogroup General
462 * Defines couple of standard Evas_Object layers to be used
463 * with evas_object_layer_set().
465 * @note whenever extending with new values, try to keep some padding
466 * to siblings so there is room for further extensions.
468 typedef enum _Elm_Object_Layer
470 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
478 /**************************************************************************/
479 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
482 * Emitted when any Elementary's policy value is changed.
484 EAPI extern int ELM_EVENT_POLICY_CHANGED;
487 * @typedef Elm_Event_Policy_Changed
489 * Data on the event when an Elementary policy has changed
491 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
494 * @struct _Elm_Event_Policy_Changed
496 * Data on the event when an Elementary policy has changed
498 struct _Elm_Event_Policy_Changed
500 unsigned int policy; /**< the policy identifier */
501 int new_value; /**< value the policy had before the change */
502 int old_value; /**< new value the policy got */
506 * Policy identifiers.
508 typedef enum _Elm_Policy
510 ELM_POLICY_QUIT, /**< under which circunstances the application
511 * should quit automatically. @see
515 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
518 typedef enum _Elm_Policy_Quit
520 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
522 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
524 * window is closed */
525 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
527 typedef enum _Elm_Focus_Direction
531 } Elm_Focus_Direction;
533 typedef enum _Elm_Text_Format
535 ELM_TEXT_FORMAT_PLAIN_UTF8,
536 ELM_TEXT_FORMAT_MARKUP_UTF8
540 * Line wrapping types.
542 typedef enum _Elm_Wrap_Type
544 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552 * @typedef Elm_Object_Item
553 * An Elementary Object item handle.
556 typedef struct _Elm_Object_Item Elm_Object_Item;
560 * Called back when a widget's tooltip is activated and needs content.
561 * @param data user-data given to elm_object_tooltip_content_cb_set()
562 * @param obj owner widget.
563 * @param tooltip The tooltip object (affix content to this!)
565 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
568 * Called back when a widget's item tooltip is activated and needs content.
569 * @param data user-data given to elm_object_tooltip_content_cb_set()
570 * @param obj owner widget.
571 * @param tooltip The tooltip object (affix content to this!)
572 * @param item context dependent item. As an example, if tooltip was
573 * set on Elm_List_Item, then it is of this type.
575 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
577 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
585 /**************************************************************************/
589 * Initialize Elementary
591 * @param[in] argc System's argument count value
592 * @param[in] argv System's pointer to array of argument strings
593 * @return The init counter value.
595 * This function initializes Elementary and increments a counter of
596 * the number of calls to it. It returs the new counter's value.
598 * @warning This call is exported only for use by the @c ELM_MAIN()
599 * macro. There is no need to use this if you use this macro (which
600 * is highly advisable). An elm_main() should contain the entry
601 * point code for your application, having the same prototype as
602 * elm_init(), and @b not being static (putting the @c EAPI symbol
603 * in front of its type declaration is advisable). The @c
604 * ELM_MAIN() call should be placed just after it.
607 * @dontinclude bg_example_01.c
611 * See the full @ref bg_example_01_c "example".
613 * @see elm_shutdown().
616 EAPI int elm_init(int argc, char **argv);
619 * Shut down Elementary
621 * @return The init counter value.
623 * This should be called at the end of your application, just
624 * before it ceases to do any more processing. This will clean up
625 * any permanent resources your application may have allocated via
626 * Elementary that would otherwise persist.
628 * @see elm_init() for an example
632 EAPI int elm_shutdown(void);
635 * Run Elementary's main loop
637 * This call should be issued just after all initialization is
638 * completed. This function will not return until elm_exit() is
639 * called. It will keep looping, running the main
640 * (event/processing) loop for Elementary.
642 * @see elm_init() for an example
646 EAPI void elm_run(void);
649 * Exit Elementary's main loop
651 * If this call is issued, it will flag the main loop to cease
652 * processing and return back to its parent function (usually your
653 * elm_main() function).
655 * @see elm_init() for an example. There, just after a request to
656 * close the window comes, the main loop will be left.
658 * @note By using the #ELM_POLICY_QUIT on your Elementary
659 * applications, you'll this function called automatically for you.
663 EAPI void elm_exit(void);
666 * Provide information in order to make Elementary determine the @b
667 * run time location of the software in question, so other data files
668 * such as images, sound files, executable utilities, libraries,
669 * modules and locale files can be found.
671 * @param mainfunc This is your application's main function name,
672 * whose binary's location is to be found. Providing @c NULL
673 * will make Elementary not to use it
674 * @param dom This will be used as the application's "domain", in the
675 * form of a prefix to any environment variables that may
676 * override prefix detection and the directory name, inside the
677 * standard share or data directories, where the software's
678 * data files will be looked for.
679 * @param checkfile This is an (optional) magic file's path to check
680 * for existence (and it must be located in the data directory,
681 * under the share directory provided above). Its presence will
682 * help determine the prefix found was correct. Pass @c NULL if
683 * the check is not to be done.
685 * This function allows one to re-locate the application somewhere
686 * else after compilation, if the developer wishes for easier
687 * distribution of pre-compiled binaries.
689 * The prefix system is designed to locate where the given software is
690 * installed (under a common path prefix) at run time and then report
691 * specific locations of this prefix and common directories inside
692 * this prefix like the binary, library, data and locale directories,
693 * through the @c elm_app_*_get() family of functions.
695 * Call elm_app_info_set() early on before you change working
696 * directory or anything about @c argv[0], so it gets accurate
699 * It will then try and trace back which file @p mainfunc comes from,
700 * if provided, to determine the application's prefix directory.
702 * The @p dom parameter provides a string prefix to prepend before
703 * environment variables, allowing a fallback to @b specific
704 * environment variables to locate the software. You would most
705 * probably provide a lowercase string there, because it will also
706 * serve as directory domain, explained next. For environment
707 * variables purposes, this string is made uppercase. For example if
708 * @c "myapp" is provided as the prefix, then the program would expect
709 * @c "MYAPP_PREFIX" as a master environment variable to specify the
710 * exact install prefix for the software, or more specific environment
711 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713 * the user or scripts before launching. If not provided (@c NULL),
714 * environment variables will not be used to override compiled-in
715 * defaults or auto detections.
717 * The @p dom string also provides a subdirectory inside the system
718 * shared data directory for data files. For example, if the system
719 * directory is @c /usr/local/share, then this directory name is
720 * appended, creating @c /usr/local/share/myapp, if it @p was @c
721 * "myapp". It is expected the application installs data files in
724 * The @p checkfile is a file name or path of something inside the
725 * share or data directory to be used to test that the prefix
726 * detection worked. For example, your app will install a wallpaper
727 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
731 * @see elm_app_compile_bin_dir_set()
732 * @see elm_app_compile_lib_dir_set()
733 * @see elm_app_compile_data_dir_set()
734 * @see elm_app_compile_locale_set()
735 * @see elm_app_prefix_dir_get()
736 * @see elm_app_bin_dir_get()
737 * @see elm_app_lib_dir_get()
738 * @see elm_app_data_dir_get()
739 * @see elm_app_locale_dir_get()
741 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
744 * Provide information on the @b fallback application's binaries
745 * directory, on scenarios where they get overriden by
746 * elm_app_info_set().
748 * @param dir The path to the default binaries directory (compile time
751 * @note Elementary will as well use this path to determine actual
752 * names of binaries' directory paths, maybe changing it to be @c
753 * something/local/bin instead of @c something/bin, only, for
756 * @warning You should call this function @b before
757 * elm_app_info_set().
759 EAPI void elm_app_compile_bin_dir_set(const char *dir);
762 * Provide information on the @b fallback application's libraries
763 * directory, on scenarios where they get overriden by
764 * elm_app_info_set().
766 * @param dir The path to the default libraries directory (compile
769 * @note Elementary will as well use this path to determine actual
770 * names of libraries' directory paths, maybe changing it to be @c
771 * something/lib32 or @c something/lib64 instead of @c something/lib,
774 * @warning You should call this function @b before
775 * elm_app_info_set().
777 EAPI void elm_app_compile_lib_dir_set(const char *dir);
780 * Provide information on the @b fallback application's data
781 * directory, on scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default data directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of data directory paths, maybe changing it to be @c
789 * something/local/share instead of @c something/share, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_data_dir_set(const char *dir);
798 * Provide information on the @b fallback application's locale
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default locale directory (compile time
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_locale_set(const char *dir);
811 * Retrieve the application's run time prefix directory, as set by
812 * elm_app_info_set() and the way (environment) the application was
815 * @return The directory prefix the application is actually using
817 EAPI const char *elm_app_prefix_dir_get(void);
820 * Retrieve the application's run time binaries prefix directory, as
821 * set by elm_app_info_set() and the way (environment) the application
824 * @return The binaries directory prefix the application is actually
827 EAPI const char *elm_app_bin_dir_get(void);
830 * Retrieve the application's run time libraries prefix directory, as
831 * set by elm_app_info_set() and the way (environment) the application
834 * @return The libraries directory prefix the application is actually
837 EAPI const char *elm_app_lib_dir_get(void);
840 * Retrieve the application's run time data prefix directory, as
841 * set by elm_app_info_set() and the way (environment) the application
844 * @return The data directory prefix the application is actually
847 EAPI const char *elm_app_data_dir_get(void);
850 * Retrieve the application's run time locale prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The locale directory prefix the application is actually
857 EAPI const char *elm_app_locale_dir_get(void);
859 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
860 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
861 EAPI int elm_quicklaunch_init(int argc, char **argv);
862 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
863 EAPI int elm_quicklaunch_sub_shutdown(void);
864 EAPI int elm_quicklaunch_shutdown(void);
865 EAPI void elm_quicklaunch_seed(void);
866 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
867 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868 EAPI void elm_quicklaunch_cleanup(void);
869 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
870 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
872 EAPI Eina_Bool elm_need_efreet(void);
873 EAPI Eina_Bool elm_need_e_dbus(void);
874 EAPI Eina_Bool elm_need_ethumb(void);
877 * Set a new policy's value (for a given policy group/identifier).
879 * @param policy policy identifier, as in @ref Elm_Policy.
880 * @param value policy value, which depends on the identifier
882 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
884 * Elementary policies define applications' behavior,
885 * somehow. These behaviors are divided in policy groups (see
886 * #Elm_Policy enumeration). This call will emit the Ecore event
887 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
888 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
891 * @note Currently, we have only one policy identifier/group
892 * (#ELM_POLICY_QUIT), which has two possible values.
896 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
899 * Gets the policy value set for given policy identifier.
901 * @param policy policy identifier, as in #Elm_Policy.
902 * @return The currently set policy value, for that
903 * identifier. Will be @c 0 if @p policy passed is invalid.
907 EAPI int elm_policy_get(unsigned int policy);
910 * Set a label of an object
912 * @param obj The Elementary object
913 * @param part The text part name to set (NULL for the default label)
914 * @param label The new text of the label
916 * @note Elementary objects may have many labels (e.g. Action Slider)
920 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
922 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
925 * Get a label of an object
927 * @param obj The Elementary object
928 * @param part The text part name to get (NULL for the default label)
929 * @return text of the label or NULL for any error
931 * @note Elementary objects may have many labels (e.g. Action Slider)
935 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
937 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
940 * Set a content of an object
942 * @param obj The Elementary object
943 * @param part The content part name to set (NULL for the default content)
944 * @param content The new content of the object
946 * @note Elementary objects may have many contents
950 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
952 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
955 * Get a content of an object
957 * @param obj The Elementary object
958 * @param item The content part name to get (NULL for the default content)
959 * @return content of the object or NULL for any error
961 * @note Elementary objects may have many contents
965 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
967 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
970 * Unset a content of an object
972 * @param obj The Elementary object
973 * @param item The content part name to unset (NULL for the default content)
975 * @note Elementary objects may have many contents
979 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
981 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
984 * Set a content of an object item
986 * @param it The Elementary object item
987 * @param part The content part name to unset (NULL for the default content)
988 * @param content The new content of the object item
990 * @note Elementary object items may have many contents
994 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
996 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
999 * Get a content of an object item
1001 * @param it The Elementary object item
1002 * @param part The content part name to unset (NULL for the default content)
1003 * @return content of the object item or NULL for any error
1005 * @note Elementary object items may have many contents
1009 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1011 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1014 * Unset a content of an object item
1016 * @param it The Elementary object item
1017 * @param part The content part name to unset (NULL for the default content)
1019 * @note Elementary object items may have many contents
1023 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1025 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1028 * Set a label of an objec itemt
1030 * @param it The Elementary object item
1031 * @param part The text part name to set (NULL for the default label)
1032 * @param label The new text of the label
1034 * @note Elementary object items may have many labels
1038 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1040 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1043 * Get a label of an object
1045 * @param it The Elementary object item
1046 * @param part The text part name to get (NULL for the default label)
1047 * @return text of the label or NULL for any error
1049 * @note Elementary object items may have many labels
1053 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1055 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1061 EAPI void elm_all_flush(void);
1062 EAPI int elm_cache_flush_interval_get(void);
1063 EAPI void elm_cache_flush_interval_set(int size);
1064 EAPI void elm_cache_flush_interval_all_set(int size);
1065 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1066 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1067 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1068 EAPI int elm_font_cache_get(void);
1069 EAPI void elm_font_cache_set(int size);
1070 EAPI void elm_font_cache_all_set(int size);
1071 EAPI int elm_image_cache_get(void);
1072 EAPI void elm_image_cache_set(int size);
1073 EAPI void elm_image_cache_all_set(int size);
1074 EAPI int elm_edje_file_cache_get(void);
1075 EAPI void elm_edje_file_cache_set(int size);
1076 EAPI void elm_edje_file_cache_all_set(int size);
1077 EAPI int elm_edje_collection_cache_get(void);
1078 EAPI void elm_edje_collection_cache_set(int size);
1079 EAPI void elm_edje_collection_cache_all_set(int size);
1082 * @defgroup Scaling Widget Scaling
1084 * Different widgets can be scaled independently. These functions
1085 * allow you to manipulate this scaling on a per-widget basis. The
1086 * object and all its children get their scaling factors multiplied
1087 * by the scale factor set. This is multiplicative, in that if a
1088 * child also has a scale size set it is in turn multiplied by its
1089 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1090 * double size, @c 0.5 is half, etc.
1092 * @ref general_functions_example_page "This" example contemplates
1093 * some of these functions.
1097 * Set the scaling factor for a given Elementary object
1099 * @param obj The Elementary to operate on
1100 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1105 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1108 * Get the scaling factor for a given Elementary object
1110 * @param obj The object
1111 * @return The scaling factor set by elm_object_scale_set()
1115 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1116 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1117 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1118 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1119 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1121 * Set the style to use by a widget
1123 * Sets the style name that will define the appearance of a widget. Styles
1124 * vary from widget to widget and may also be defined by other themes
1125 * by means of extensions and overlays.
1127 * @param obj The Elementary widget to style
1128 * @param style The style name to use
1130 * @see elm_theme_extension_add()
1131 * @see elm_theme_extension_del()
1132 * @see elm_theme_overlay_add()
1133 * @see elm_theme_overlay_del()
1137 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1139 * Get the style used by the widget
1141 * This gets the style being used for that widget. Note that the string
1142 * pointer is only valid as longas the object is valid and the style doesn't
1145 * @param obj The Elementary widget to query for its style
1146 * @return The style name used
1148 * @see elm_object_style_set()
1152 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1155 * @defgroup Styles Styles
1157 * Widgets can have different styles of look. These generic API's
1158 * set styles of widgets, if they support them (and if the theme(s)
1161 * @ref general_functions_example_page "This" example contemplates
1162 * some of these functions.
1166 * Set the disabled state of an Elementary object.
1168 * @param obj The Elementary object to operate on
1169 * @param disabled The state to put in in: @c EINA_TRUE for
1170 * disabled, @c EINA_FALSE for enabled
1172 * Elementary objects can be @b disabled, in which state they won't
1173 * receive input and, in general, will be themed differently from
1174 * their normal state, usually greyed out. Useful for contexts
1175 * where you don't want your users to interact with some of the
1176 * parts of you interface.
1178 * This sets the state for the widget, either disabling it or
1183 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1186 * Get the disabled state of an Elementary object.
1188 * @param obj The Elementary object to operate on
1189 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1190 * if it's enabled (or on errors)
1192 * This gets the state of the widget, which might be enabled or disabled.
1196 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1199 * @defgroup WidgetNavigation Widget Tree Navigation.
1201 * How to check if an Evas Object is an Elementary widget? How to
1202 * get the first elementary widget that is parent of the given
1203 * object? These are all covered in widget tree navigation.
1205 * @ref general_functions_example_page "This" example contemplates
1206 * some of these functions.
1209 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1212 * Get the first parent of the given object that is an Elementary
1215 * @param obj the Elementary object to query parent from.
1216 * @return the parent object that is an Elementary widget, or @c
1217 * NULL, if it was not found.
1219 * Use this to query for an object's parent widget.
1221 * @note Most of Elementary users wouldn't be mixing non-Elementary
1222 * smart objects in the objects tree of an application, as this is
1223 * an advanced usage of Elementary with Evas. So, except for the
1224 * application's window, which is the root of that tree, all other
1225 * objects would have valid Elementary widget parents.
1227 * @ingroup WidgetNavigation
1229 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1230 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1231 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1233 EAPI double elm_scale_get(void);
1234 EAPI void elm_scale_set(double scale);
1235 EAPI void elm_scale_all_set(double scale);
1237 EAPI Eina_Bool elm_mirrored_get(void);
1238 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1240 EAPI Eina_Bool elm_config_save(void);
1241 EAPI void elm_config_reload(void);
1243 EAPI const char *elm_profile_current_get(void);
1244 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1245 EAPI void elm_profile_dir_free(const char *p_dir);
1246 EAPI Eina_List *elm_profile_list_get(void);
1247 EAPI void elm_profile_list_free(Eina_List *l);
1248 EAPI void elm_profile_set(const char *profile);
1249 EAPI void elm_profile_all_set(const char *profile);
1251 EAPI const char *elm_engine_current_get(void);
1252 EAPI void elm_engine_set(const char *engine);
1254 typedef struct _Elm_Text_Class
1260 typedef struct _Elm_Font_Overlay
1262 const char *text_class;
1264 Evas_Font_Size size;
1267 typedef struct _Elm_Font_Properties
1271 } Elm_Font_Properties;
1273 EAPI const Eina_List *elm_text_classes_list_get(void);
1274 EAPI void elm_text_classes_list_free(const Eina_List *list);
1276 EAPI const Eina_List *elm_font_overlay_list_get(void);
1277 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1278 EAPI void elm_font_overlay_unset(const char *text_class);
1279 EAPI void elm_font_overlay_apply(void);
1280 EAPI void elm_font_overlay_all_apply(void);
1282 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1283 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1284 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1285 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1286 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1287 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1290 * @defgroup Fingers Fingers
1292 * Elementary is designed to be finger-friendly for touchscreens,
1293 * and so in addition to scaling for display resolution, it can
1294 * also scale based on finger "resolution" (or size). You can then
1295 * customize the granularity of the areas meant to receive clicks
1298 * Different profiles may have pre-set values for finger sizes.
1300 * @ref general_functions_example_page "This" example contemplates
1301 * some of these functions.
1305 * Get the configured "finger size"
1307 * @return The finger size
1309 * This gets the globally configured finger size, <b>in pixels</b>
1313 EAPI Evas_Coord elm_finger_size_get(void);
1314 EAPI void elm_finger_size_set(Evas_Coord size);
1315 EAPI void elm_finger_size_all_set(Evas_Coord size);
1318 * @defgroup Focus Focus
1320 * An Elementary application has, at all times, one (and only one)
1321 * @b focused object. This is what determines where the input
1322 * events go to within the application's window. Also, focused
1323 * objects can be decorated differently, in order to signal to the
1324 * user where the input is, at a given moment.
1326 * Elementary applications also have the concept of <b>focus
1327 * chain</b>: one can cycle through all the windows' focusable
1328 * objects by input (tab key) or programmatically. The default
1329 * focus chain for an application is the one define by the order in
1330 * which the widgets where added in code. One will cycle through
1331 * top level widgets, and, for each one containg sub-objects, cycle
1332 * through them all, before returning to the level
1333 * above. Elementary also allows one to set @b custom focus chains
1334 * for their applications.
1336 * Besides the focused decoration a widget may exhibit, when it
1337 * gets focus, Elementary has a @b global focus highlight object
1338 * that can be enabled for a window. If one chooses to do so, this
1339 * extra highlight effect will surround the current focused object,
1342 * @note Some Elementary widgets are @b unfocusable, after
1343 * creation, by their very nature: they are not meant to be
1344 * interacted with input events, but are there just for visual
1347 * @ref general_functions_example_page "This" example contemplates
1348 * some of these functions.
1351 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1352 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1353 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1354 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1357 * Get the whether an Elementary object has the focus or not.
1359 * @param obj The Elementary object to get the information from
1360 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1361 * not (and on errors).
1363 * @see elm_object_focus_set()
1367 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1370 * Set/unset focus to a given Elementary object.
1372 * @param obj The Elementary object to operate on.
1373 * @param enable @c EINA_TRUE Set focus to a given object,
1374 * @c EINA_FALSE Unset focus to a given object.
1376 * @note When you set focus to this object, if it can handle focus, will
1377 * take the focus away from the one who had it previously and will, for
1378 * now on, be the one receiving input events. Unsetting focus will remove
1379 * the focus from @p obj, passing it back to the previous element in the
1382 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1386 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1389 * Make a given Elementary object the focused one.
1391 * @param obj The Elementary object to make focused.
1393 * @note This object, if it can handle focus, will take the focus
1394 * away from the one who had it previously and will, for now on, be
1395 * the one receiving input events.
1397 * @see elm_object_focus_get()
1398 * @deprecated use elm_object_focus_set() instead.
1402 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1405 * Remove the focus from an Elementary object
1407 * @param obj The Elementary to take focus from
1409 * This removes the focus from @p obj, passing it back to the
1410 * previous element in the focus chain list.
1412 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1413 * @deprecated use elm_object_focus_set() instead.
1417 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1420 * Set the ability for an Element object to be focused
1422 * @param obj The Elementary object to operate on
1423 * @param enable @c EINA_TRUE if the object can be focused, @c
1424 * EINA_FALSE if not (and on errors)
1426 * This sets whether the object @p obj is able to take focus or
1427 * not. Unfocusable objects do nothing when programmatically
1428 * focused, being the nearest focusable parent object the one
1429 * really getting focus. Also, when they receive mouse input, they
1430 * will get the event, but not take away the focus from where it
1435 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1438 * Get whether an Elementary object is focusable or not
1440 * @param obj The Elementary object to operate on
1441 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1442 * EINA_FALSE if not (and on errors)
1444 * @note Objects which are meant to be interacted with by input
1445 * events are created able to be focused, by default. All the
1450 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1452 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1453 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1454 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1455 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1456 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1457 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1458 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1461 * Make the elementary object and its children to be unfocusable (or focusable).
1463 * @param obj The Elementary object to operate on
1464 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1465 * @c EINA_FALSE for focusable.
1467 * This sets whether the object @p obj and its children objects
1468 * are able to take focus or not. If the tree is set as unfocusable,
1469 * newest focused object which is not in this tree will get focus.
1470 * This API can be helpful for an object to be deleted.
1471 * When an object will be deleted soon, it and its children may not
1472 * want to get focus (by focus reverting or by other focus controls).
1473 * Then, just use this API before deleting.
1475 * @see elm_object_tree_unfocusable_get()
1479 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1482 * Get whether an Elementary object and its children are unfocusable or not.
1484 * @param obj The Elementary object to get the information from
1485 * @return @c EINA_TRUE, if the tree is unfocussable,
1486 * @c EINA_FALSE if not (and on errors).
1488 * @see elm_object_tree_unfocusable_set()
1492 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1494 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1495 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1496 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1497 EAPI double elm_scroll_bounce_friction_get(void);
1498 EAPI void elm_scroll_bounce_friction_set(double friction);
1499 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1500 EAPI double elm_scroll_page_scroll_friction_get(void);
1501 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1502 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1503 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1504 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1505 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1506 EAPI double elm_scroll_zoom_friction_get(void);
1507 EAPI void elm_scroll_zoom_friction_set(double friction);
1508 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1509 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1510 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1511 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1512 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1513 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1514 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1515 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1516 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1517 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1518 EAPI double elm_scroll_thumbscroll_friction_get(void);
1519 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1520 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1521 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1522 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1523 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1525 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1526 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1527 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1528 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1529 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1530 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1531 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1532 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1534 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1535 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);
1536 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);
1538 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1539 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1542 * Adjust size of an element for finger usage.
1544 * @param times_w How many fingers should fit horizontally
1545 * @param w Pointer to the width size to adjust
1546 * @param times_h How many fingers should fit vertically
1547 * @param h Pointer to the height size to adjust
1549 * This takes width and height sizes (in pixels) as input and a
1550 * size multiple (which is how many fingers you want to place
1551 * within the area, being "finger" the size set by
1552 * elm_finger_size_set()), and adjusts the size to be large enough
1553 * to accommodate the resulting size -- if it doesn't already
1554 * accommodate it. On return the @p w and @p h sizes pointed to by
1555 * these parameters will be modified, on those conditions.
1557 * @note This is kind of a low level Elementary call, most useful
1558 * on size evaluation times for widgets. An external user wouldn't
1559 * be calling, most of the time.
1563 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1565 EAPI double elm_longpress_timeout_get(void);
1566 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1569 * don't use it unless you are sure
1571 EAPI void elm_object_tree_dump(const Evas_Object *top);
1572 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1577 * @defgroup Theme Theme
1579 * Elementary uses Edje to theme its widgets, naturally. But for the most
1580 * part this is hidden behind a simpler interface that lets the user set
1581 * extensions and choose the style of widgets in a much easier way.
1583 * Instead of thinking in terms of paths to Edje files and their groups
1584 * each time you want to change the appearance of a widget, Elementary
1585 * works so you can add any theme file with extensions or replace the
1586 * main theme at one point in the application, and then just set the style
1587 * of widgets with elm_object_style_set() and related functions. Elementary
1588 * will then look in its list of themes for a matching group and apply it,
1589 * and when the theme changes midway through the application, all widgets
1590 * will be updated accordingly.
1592 * There are three concepts you need to know to understand how Elementary
1593 * theming works: default theme, extensions and overlays.
1595 * Default theme, obviously enough, is the one that provides the default
1596 * look of all widgets. End users can change the theme used by Elementary
1597 * by setting the @c ELM_THEME environment variable before running an
1598 * application, or globally for all programs using the @c elementary_config
1599 * utility. Applications can change the default theme using elm_theme_set(),
1600 * but this can go against the user wishes, so it's not an adviced practice.
1602 * Ideally, applications should find everything they need in the already
1603 * provided theme, but there may be occasions when that's not enough and
1604 * custom styles are required to correctly express the idea. For this
1605 * cases, Elementary has extensions.
1607 * Extensions allow the application developer to write styles of its own
1608 * to apply to some widgets. This requires knowledge of how each widget
1609 * is themed, as extensions will always replace the entire group used by
1610 * the widget, so important signals and parts need to be there for the
1611 * object to behave properly (see documentation of Edje for details).
1612 * Once the theme for the extension is done, the application needs to add
1613 * it to the list of themes Elementary will look into, using
1614 * elm_theme_extension_add(), and set the style of the desired widgets as
1615 * he would normally with elm_object_style_set().
1617 * Overlays, on the other hand, can replace the look of all widgets by
1618 * overriding the default style. Like extensions, it's up to the application
1619 * developer to write the theme for the widgets it wants, the difference
1620 * being that when looking for the theme, Elementary will check first the
1621 * list of overlays, then the set theme and lastly the list of extensions,
1622 * so with overlays it's possible to replace the default view and every
1623 * widget will be affected. This is very much alike to setting the whole
1624 * theme for the application and will probably clash with the end user
1625 * options, not to mention the risk of ending up with not matching styles
1626 * across the program. Unless there's a very special reason to use them,
1627 * overlays should be avoided for the resons exposed before.
1629 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1630 * keeps one default internally and every function that receives one of
1631 * these can be called with NULL to refer to this default (except for
1632 * elm_theme_free()). It's possible to create a new instance of a
1633 * ::Elm_Theme to set other theme for a specific widget (and all of its
1634 * children), but this is as discouraged, if not even more so, than using
1635 * overlays. Don't use this unless you really know what you are doing.
1637 * But to be less negative about things, you can look at the following
1639 * @li @ref theme_example_01 "Using extensions"
1640 * @li @ref theme_example_02 "Using overlays"
1645 * @typedef Elm_Theme
1647 * Opaque handler for the list of themes Elementary looks for when
1648 * rendering widgets.
1650 * Stay out of this unless you really know what you are doing. For most
1651 * cases, sticking to the default is all a developer needs.
1653 typedef struct _Elm_Theme Elm_Theme;
1656 * Create a new specific theme
1658 * This creates an empty specific theme that only uses the default theme. A
1659 * specific theme has its own private set of extensions and overlays too
1660 * (which are empty by default). Specific themes do not fall back to themes
1661 * of parent objects. They are not intended for this use. Use styles, overlays
1662 * and extensions when needed, but avoid specific themes unless there is no
1663 * other way (example: you want to have a preview of a new theme you are
1664 * selecting in a "theme selector" window. The preview is inside a scroller
1665 * and should display what the theme you selected will look like, but not
1666 * actually apply it yet. The child of the scroller will have a specific
1667 * theme set to show this preview before the user decides to apply it to all
1670 EAPI Elm_Theme *elm_theme_new(void);
1672 * Free a specific theme
1674 * @param th The theme to free
1676 * This frees a theme created with elm_theme_new().
1678 EAPI void elm_theme_free(Elm_Theme *th);
1680 * Copy the theme fom the source to the destination theme
1682 * @param th The source theme to copy from
1683 * @param thdst The destination theme to copy data to
1685 * This makes a one-time static copy of all the theme config, extensions
1686 * and overlays from @p th to @p thdst. If @p th references a theme, then
1687 * @p thdst is also set to reference it, with all the theme settings,
1688 * overlays and extensions that @p th had.
1690 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1692 * Tell the source theme to reference the ref theme
1694 * @param th The theme that will do the referencing
1695 * @param thref The theme that is the reference source
1697 * This clears @p th to be empty and then sets it to refer to @p thref
1698 * so @p th acts as an override to @p thref, but where its overrides
1699 * don't apply, it will fall through to @p thref for configuration.
1701 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1703 * Return the theme referred to
1705 * @param th The theme to get the reference from
1706 * @return The referenced theme handle
1708 * This gets the theme set as the reference theme by elm_theme_ref_set().
1709 * If no theme is set as a reference, NULL is returned.
1711 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1713 * Return the default theme
1715 * @return The default theme handle
1717 * This returns the internal default theme setup handle that all widgets
1718 * use implicitly unless a specific theme is set. This is also often use
1719 * as a shorthand of NULL.
1721 EAPI Elm_Theme *elm_theme_default_get(void);
1723 * Prepends a theme overlay to the list of overlays
1725 * @param th The theme to add to, or if NULL, the default theme
1726 * @param item The Edje file path to be used
1728 * Use this if your application needs to provide some custom overlay theme
1729 * (An Edje file that replaces some default styles of widgets) where adding
1730 * new styles, or changing system theme configuration is not possible. Do
1731 * NOT use this instead of a proper system theme configuration. Use proper
1732 * configuration files, profiles, environment variables etc. to set a theme
1733 * so that the theme can be altered by simple confiugration by a user. Using
1734 * this call to achieve that effect is abusing the API and will create lots
1737 * @see elm_theme_extension_add()
1739 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1741 * Delete a theme overlay from the list of overlays
1743 * @param th The theme to delete from, or if NULL, the default theme
1744 * @param item The name of the theme overlay
1746 * @see elm_theme_overlay_add()
1748 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1750 * Appends a theme extension to the list of extensions.
1752 * @param th The theme to add to, or if NULL, the default theme
1753 * @param item The Edje file path to be used
1755 * This is intended when an application needs more styles of widgets or new
1756 * widget themes that the default does not provide (or may not provide). The
1757 * application has "extended" usage by coming up with new custom style names
1758 * for widgets for specific uses, but as these are not "standard", they are
1759 * not guaranteed to be provided by a default theme. This means the
1760 * application is required to provide these extra elements itself in specific
1761 * Edje files. This call adds one of those Edje files to the theme search
1762 * path to be search after the default theme. The use of this call is
1763 * encouraged when default styles do not meet the needs of the application.
1764 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1766 * @see elm_object_style_set()
1768 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1770 * Deletes a theme extension from the list of extensions.
1772 * @param th The theme to delete from, or if NULL, the default theme
1773 * @param item The name of the theme extension
1775 * @see elm_theme_extension_add()
1777 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1779 * Set the theme search order for the given theme
1781 * @param th The theme to set the search order, or if NULL, the default theme
1782 * @param theme Theme search string
1784 * This sets the search string for the theme in path-notation from first
1785 * theme to search, to last, delimited by the : character. Example:
1787 * "shiny:/path/to/file.edj:default"
1789 * See the ELM_THEME environment variable for more information.
1791 * @see elm_theme_get()
1792 * @see elm_theme_list_get()
1794 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1796 * Return the theme search order
1798 * @param th The theme to get the search order, or if NULL, the default theme
1799 * @return The internal search order path
1801 * This function returns a colon separated string of theme elements as
1802 * returned by elm_theme_list_get().
1804 * @see elm_theme_set()
1805 * @see elm_theme_list_get()
1807 EAPI const char *elm_theme_get(Elm_Theme *th);
1809 * Return a list of theme elements to be used in a theme.
1811 * @param th Theme to get the list of theme elements from.
1812 * @return The internal list of theme elements
1814 * This returns the internal list of theme elements (will only be valid as
1815 * long as the theme is not modified by elm_theme_set() or theme is not
1816 * freed by elm_theme_free(). This is a list of strings which must not be
1817 * altered as they are also internal. If @p th is NULL, then the default
1818 * theme element list is returned.
1820 * A theme element can consist of a full or relative path to a .edj file,
1821 * or a name, without extension, for a theme to be searched in the known
1822 * theme paths for Elemementary.
1824 * @see elm_theme_set()
1825 * @see elm_theme_get()
1827 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1829 * Return the full patrh for a theme element
1831 * @param f The theme element name
1832 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1833 * @return The full path to the file found.
1835 * This returns a string you should free with free() on success, NULL on
1836 * failure. This will search for the given theme element, and if it is a
1837 * full or relative path element or a simple searchable name. The returned
1838 * path is the full path to the file, if searched, and the file exists, or it
1839 * is simply the full path given in the element or a resolved path if
1840 * relative to home. The @p in_search_path boolean pointed to is set to
1841 * EINA_TRUE if the file was a searchable file andis in the search path,
1842 * and EINA_FALSE otherwise.
1844 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1846 * Flush the current theme.
1848 * @param th Theme to flush
1850 * This flushes caches that let elementary know where to find theme elements
1851 * in the given theme. If @p th is NULL, then the default theme is flushed.
1852 * Call this function if source theme data has changed in such a way as to
1853 * make any caches Elementary kept invalid.
1855 EAPI void elm_theme_flush(Elm_Theme *th);
1857 * This flushes all themes (default and specific ones).
1859 * This will flush all themes in the current application context, by calling
1860 * elm_theme_flush() on each of them.
1862 EAPI void elm_theme_full_flush(void);
1864 * Set the theme for all elementary using applications on the current display
1866 * @param theme The name of the theme to use. Format same as the ELM_THEME
1867 * environment variable.
1869 EAPI void elm_theme_all_set(const char *theme);
1871 * Return a list of theme elements in the theme search path
1873 * @return A list of strings that are the theme element names.
1875 * This lists all available theme files in the standard Elementary search path
1876 * for theme elements, and returns them in alphabetical order as theme
1877 * element names in a list of strings. Free this with
1878 * elm_theme_name_available_list_free() when you are done with the list.
1880 EAPI Eina_List *elm_theme_name_available_list_new(void);
1882 * Free the list returned by elm_theme_name_available_list_new()
1884 * This frees the list of themes returned by
1885 * elm_theme_name_available_list_new(). Once freed the list should no longer
1886 * be used. a new list mys be created.
1888 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1890 * Set a specific theme to be used for this object and its children
1892 * @param obj The object to set the theme on
1893 * @param th The theme to set
1895 * This sets a specific theme that will be used for the given object and any
1896 * child objects it has. If @p th is NULL then the theme to be used is
1897 * cleared and the object will inherit its theme from its parent (which
1898 * ultimately will use the default theme if no specific themes are set).
1900 * Use special themes with great care as this will annoy users and make
1901 * configuration difficult. Avoid any custom themes at all if it can be
1904 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1906 * Get the specific theme to be used
1908 * @param obj The object to get the specific theme from
1909 * @return The specifc theme set.
1911 * This will return a specific theme set, or NULL if no specific theme is
1912 * set on that object. It will not return inherited themes from parents, only
1913 * the specific theme set for that specific object. See elm_object_theme_set()
1914 * for more information.
1916 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1922 /** @defgroup Win Win
1924 * @image html img/widget/win/preview-00.png
1925 * @image latex img/widget/win/preview-00.eps
1927 * The window class of Elementary. Contains functions to manipulate
1928 * windows. The Evas engine used to render the window contents is specified
1929 * in the system or user elementary config files (whichever is found last),
1930 * and can be overridden with the ELM_ENGINE environment variable for
1931 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1932 * compilation setup and modules actually installed at runtime) are (listed
1933 * in order of best supported and most likely to be complete and work to
1936 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1937 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1939 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1941 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1943 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1945 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1946 * rendering using SDL as the buffer)
1947 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1948 * GDI with software)
1949 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1950 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1951 * grayscale using dedicated 8bit software engine in X11)
1952 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1953 * X11 using 16bit software engine)
1954 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1955 * (Windows CE rendering via GDI with 16bit software renderer)
1956 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1957 * buffer with 16bit software renderer)
1959 * All engines use a simple string to select the engine to render, EXCEPT
1960 * the "shot" engine. This actually encodes the output of the virtual
1961 * screenshot and how long to delay in the engine string. The engine string
1962 * is encoded in the following way:
1964 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1966 * Where options are separated by a ":" char if more than one option is
1967 * given, with delay, if provided being the first option and file the last
1968 * (order is important). The delay specifies how long to wait after the
1969 * window is shown before doing the virtual "in memory" rendering and then
1970 * save the output to the file specified by the file option (and then exit).
1971 * If no delay is given, the default is 0.5 seconds. If no file is given the
1972 * default output file is "out.png". Repeat option is for continous
1973 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1974 * fixed to "out001.png" Some examples of using the shot engine:
1976 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1977 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1978 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1979 * ELM_ENGINE="shot:delay=2.0" elementary_test
1980 * ELM_ENGINE="shot:" elementary_test
1982 * Signals that you can add callbacks for are:
1984 * @li "delete,request": the user requested to close the window. See
1985 * elm_win_autodel_set().
1986 * @li "focus,in": window got focus
1987 * @li "focus,out": window lost focus
1988 * @li "moved": window that holds the canvas was moved
1991 * @li @ref win_example_01
1996 * Defines the types of window that can be created
1998 * These are hints set on the window so that a running Window Manager knows
1999 * how the window should be handled and/or what kind of decorations it
2002 * Currently, only the X11 backed engines use them.
2004 typedef enum _Elm_Win_Type
2006 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
2007 window. Almost every window will be created with this
2009 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
2010 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
2011 window holding desktop icons. */
2012 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
2013 be kept on top of any other window by the Window
2015 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
2017 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
2018 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
2020 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
2021 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
2022 entry in a menubar is clicked. Typically used
2023 with elm_win_override_set(). This hint exists
2024 for completion only, as the EFL way of
2025 implementing a menu would not normally use a
2026 separate window for its contents. */
2027 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
2028 triggered by right-clicking an object. */
2029 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
2030 explanatory text that typically appear after the
2031 mouse cursor hovers over an object for a while.
2032 Typically used with elm_win_override_set() and also
2033 not very commonly used in the EFL. */
2034 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
2035 battery life or a new E-Mail received. */
2036 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
2037 usually used in the EFL. */
2038 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
2039 object being dragged across different windows, or even
2040 applications. Typically used with
2041 elm_win_override_set(). */
2042 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
2043 buffer. No actual window is created for this
2044 type, instead the window and all of its
2045 contents will be rendered to an image buffer.
2046 This allows to have children window inside a
2047 parent one just like any other object would
2048 be, and do other things like applying @c
2049 Evas_Map effects to it. This is the only type
2050 of window that requires the @c parent
2051 parameter of elm_win_add() to be a valid @c
2056 * The differents layouts that can be requested for the virtual keyboard.
2058 * When the application window is being managed by Illume, it may request
2059 * any of the following layouts for the virtual keyboard.
2061 typedef enum _Elm_Win_Keyboard_Mode
2063 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
2064 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
2065 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
2066 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
2067 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
2068 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
2069 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
2070 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
2071 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
2072 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
2073 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
2074 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
2075 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
2076 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
2077 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
2078 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
2079 } Elm_Win_Keyboard_Mode;
2082 * Available commands that can be sent to the Illume manager.
2084 * When running under an Illume session, a window may send commands to the
2085 * Illume manager to perform different actions.
2087 typedef enum _Elm_Illume_Command
2089 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
2091 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
2093 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
2095 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
2096 } Elm_Illume_Command;
2099 * Adds a window object. If this is the first window created, pass NULL as
2102 * @param parent Parent object to add the window to, or NULL
2103 * @param name The name of the window
2104 * @param type The window type, one of #Elm_Win_Type.
2106 * The @p parent paramter can be @c NULL for every window @p type except
2107 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
2108 * which the image object will be created.
2110 * @return The created object, or NULL on failure
2112 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2114 * Add @p subobj as a resize object of window @p obj.
2117 * Setting an object as a resize object of the window means that the
2118 * @p subobj child's size and position will be controlled by the window
2119 * directly. That is, the object will be resized to match the window size
2120 * and should never be moved or resized manually by the developer.
2122 * In addition, resize objects of the window control what the minimum size
2123 * of it will be, as well as whether it can or not be resized by the user.
2125 * For the end user to be able to resize a window by dragging the handles
2126 * or borders provided by the Window Manager, or using any other similar
2127 * mechanism, all of the resize objects in the window should have their
2128 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
2130 * @param obj The window object
2131 * @param subobj The resize object to add
2133 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2135 * Delete @p subobj as a resize object of window @p obj.
2137 * This function removes the object @p subobj from the resize objects of
2138 * the window @p obj. It will not delete the object itself, which will be
2139 * left unmanaged and should be deleted by the developer, manually handled
2140 * or set as child of some other container.
2142 * @param obj The window object
2143 * @param subobj The resize object to add
2145 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2147 * Set the title of the window
2149 * @param obj The window object
2150 * @param title The title to set
2152 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2154 * Get the title of the window
2156 * The returned string is an internal one and should not be freed or
2157 * modified. It will also be rendered invalid if a new title is set or if
2158 * the window is destroyed.
2160 * @param obj The window object
2163 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2165 * Set the window's autodel state.
2167 * When closing the window in any way outside of the program control, like
2168 * pressing the X button in the titlebar or using a command from the
2169 * Window Manager, a "delete,request" signal is emitted to indicate that
2170 * this event occurred and the developer can take any action, which may
2171 * include, or not, destroying the window object.
2173 * When the @p autodel parameter is set, the window will be automatically
2174 * destroyed when this event occurs, after the signal is emitted.
2175 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
2176 * and is up to the program to do so when it's required.
2178 * @param obj The window object
2179 * @param autodel If true, the window will automatically delete itself when
2182 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2184 * Get the window's autodel state.
2186 * @param obj The window object
2187 * @return If the window will automatically delete itself when closed
2189 * @see elm_win_autodel_set()
2191 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2193 * Activate a window object.
2195 * This function sends a request to the Window Manager to activate the
2196 * window pointed by @p obj. If honored by the WM, the window will receive
2197 * the keyboard focus.
2199 * @note This is just a request that a Window Manager may ignore, so calling
2200 * this function does not ensure in any way that the window will be the
2201 * active one after it.
2203 * @param obj The window object
2205 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2207 * Lower a window object.
2209 * Places the window pointed by @p obj at the bottom of the stack, so that
2210 * no other window is covered by it.
2212 * If elm_win_override_set() is not set, the Window Manager may ignore this
2215 * @param obj The window object
2217 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 * Raise a window object.
2221 * Places the window pointed by @p obj at the top of the stack, so that it's
2222 * not covered by any other window.
2224 * If elm_win_override_set() is not set, the Window Manager may ignore this
2227 * @param obj The window object
2229 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2231 * Set the borderless state of a window.
2233 * This function requests the Window Manager to not draw any decoration
2234 * around the window.
2236 * @param obj The window object
2237 * @param borderless If true, the window is borderless
2239 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2241 * Get the borderless state of a window.
2243 * @param obj The window object
2244 * @return If true, the window is borderless
2246 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2248 * Set the shaped state of a window.
2250 * Shaped windows, when supported, will render the parts of the window that
2251 * has no content, transparent.
2253 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2254 * background object or cover the entire window in any other way, or the
2255 * parts of the canvas that have no data will show framebuffer artifacts.
2257 * @param obj The window object
2258 * @param shaped If true, the window is shaped
2260 * @see elm_win_alpha_set()
2262 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2264 * Get the shaped state of a window.
2266 * @param obj The window object
2267 * @return If true, the window is shaped
2269 * @see elm_win_shaped_set()
2271 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2273 * Set the alpha channel state of a window.
2275 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2276 * possibly making parts of the window completely or partially transparent.
2277 * This is also subject to the underlying system supporting it, like for
2278 * example, running under a compositing manager. If no compositing is
2279 * available, enabling this option will instead fallback to using shaped
2280 * windows, with elm_win_shaped_set().
2282 * @param obj The window object
2283 * @param alpha If true, the window has an alpha channel
2285 * @see elm_win_alpha_set()
2287 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2289 * Get the transparency state of a window.
2291 * @param obj The window object
2292 * @return If true, the window is transparent
2294 * @see elm_win_transparent_set()
2296 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2298 * Set the transparency state of a window.
2300 * Use elm_win_alpha_set() instead.
2302 * @param obj The window object
2303 * @param transparent If true, the window is transparent
2305 * @see elm_win_alpha_set()
2307 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2309 * Get the alpha channel state of a window.
2311 * @param obj The window object
2312 * @return If true, the window has an alpha channel
2314 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2316 * Set the override state of a window.
2318 * A window with @p override set to EINA_TRUE will not be managed by the
2319 * Window Manager. This means that no decorations of any kind will be shown
2320 * for it, moving and resizing must be handled by the application, as well
2321 * as the window visibility.
2323 * This should not be used for normal windows, and even for not so normal
2324 * ones, it should only be used when there's a good reason and with a lot
2325 * of care. Mishandling override windows may result situations that
2326 * disrupt the normal workflow of the end user.
2328 * @param obj The window object
2329 * @param override If true, the window is overridden
2331 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2333 * Get the override state of a window.
2335 * @param obj The window object
2336 * @return If true, the window is overridden
2338 * @see elm_win_override_set()
2340 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2342 * Set the fullscreen state of a window.
2344 * @param obj The window object
2345 * @param fullscreen If true, the window is fullscreen
2347 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2349 * Get the fullscreen state of a window.
2351 * @param obj The window object
2352 * @return If true, the window is fullscreen
2354 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2356 * Set the maximized state of a window.
2358 * @param obj The window object
2359 * @param maximized If true, the window is maximized
2361 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2363 * Get the maximized state of a window.
2365 * @param obj The window object
2366 * @return If true, the window is maximized
2368 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2370 * Set the iconified state of a window.
2372 * @param obj The window object
2373 * @param iconified If true, the window is iconified
2375 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2377 * Get the iconified state of a window.
2379 * @param obj The window object
2380 * @return If true, the window is iconified
2382 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2384 * Set the layer of the window.
2386 * What this means exactly will depend on the underlying engine used.
2388 * In the case of X11 backed engines, the value in @p layer has the
2389 * following meanings:
2390 * @li < 3: The window will be placed below all others.
2391 * @li > 5: The window will be placed above all others.
2392 * @li other: The window will be placed in the default layer.
2394 * @param obj The window object
2395 * @param layer The layer of the window
2397 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2399 * Get the layer of the window.
2401 * @param obj The window object
2402 * @return The layer of the window
2404 * @see elm_win_layer_set()
2406 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2408 * Set the rotation of the window.
2410 * Most engines only work with multiples of 90.
2412 * This function is used to set the orientation of the window @p obj to
2413 * match that of the screen. The window itself will be resized to adjust
2414 * to the new geometry of its contents. If you want to keep the window size,
2415 * see elm_win_rotation_with_resize_set().
2417 * @param obj The window object
2418 * @param rotation The rotation of the window, in degrees (0-360),
2419 * counter-clockwise.
2421 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2423 * Rotates the window and resizes it.
2425 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2426 * that they fit inside the current window geometry.
2428 * @param obj The window object
2429 * @param layer The rotation of the window in degrees (0-360),
2430 * counter-clockwise.
2432 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2434 * Get the rotation of the window.
2436 * @param obj The window object
2437 * @return The rotation of the window in degrees (0-360)
2439 * @see elm_win_rotation_set()
2440 * @see elm_win_rotation_with_resize_set()
2442 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2444 * Set the sticky state of the window.
2446 * Hints the Window Manager that the window in @p obj should be left fixed
2447 * at its position even when the virtual desktop it's on moves or changes.
2449 * @param obj The window object
2450 * @param sticky If true, the window's sticky state is enabled
2452 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2454 * Get the sticky state of the window.
2456 * @param obj The window object
2457 * @return If true, the window's sticky state is enabled
2459 * @see elm_win_sticky_set()
2461 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2463 * Set if this window is an illume conformant window
2465 * @param obj The window object
2466 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2468 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2470 * Get if this window is an illume conformant window
2472 * @param obj The window object
2473 * @return A boolean if this window is illume conformant or not
2475 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2477 * Set a window to be an illume quickpanel window
2479 * By default window objects are not quickpanel windows.
2481 * @param obj The window object
2482 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2484 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2486 * Get if this window is a quickpanel or not
2488 * @param obj The window object
2489 * @return A boolean if this window is a quickpanel or not
2491 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2493 * Set the major priority of a quickpanel window
2495 * @param obj The window object
2496 * @param priority The major priority for this quickpanel
2498 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2500 * Get the major priority of a quickpanel window
2502 * @param obj The window object
2503 * @return The major priority of this quickpanel
2505 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2507 * Set the minor priority of a quickpanel window
2509 * @param obj The window object
2510 * @param priority The minor priority for this quickpanel
2512 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2514 * Get the minor priority of a quickpanel window
2516 * @param obj The window object
2517 * @return The minor priority of this quickpanel
2519 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2521 * Set which zone this quickpanel should appear in
2523 * @param obj The window object
2524 * @param zone The requested zone for this quickpanel
2526 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2528 * Get which zone this quickpanel should appear in
2530 * @param obj The window object
2531 * @return The requested zone for this quickpanel
2533 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2535 * Set the window to be skipped by keyboard focus
2537 * This sets the window to be skipped by normal keyboard input. This means
2538 * a window manager will be asked to not focus this window as well as omit
2539 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2541 * Call this and enable it on a window BEFORE you show it for the first time,
2542 * otherwise it may have no effect.
2544 * Use this for windows that have only output information or might only be
2545 * interacted with by the mouse or fingers, and never for typing input.
2546 * Be careful that this may have side-effects like making the window
2547 * non-accessible in some cases unless the window is specially handled. Use
2550 * @param obj The window object
2551 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2553 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2555 * Send a command to the windowing environment
2557 * This is intended to work in touchscreen or small screen device
2558 * environments where there is a more simplistic window management policy in
2559 * place. This uses the window object indicated to select which part of the
2560 * environment to control (the part that this window lives in), and provides
2561 * a command and an optional parameter structure (use NULL for this if not
2564 * @param obj The window object that lives in the environment to control
2565 * @param command The command to send
2566 * @param params Optional parameters for the command
2568 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2570 * Get the inlined image object handle
2572 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2573 * then the window is in fact an evas image object inlined in the parent
2574 * canvas. You can get this object (be careful to not manipulate it as it
2575 * is under control of elementary), and use it to do things like get pixel
2576 * data, save the image to a file, etc.
2578 * @param obj The window object to get the inlined image from
2579 * @return The inlined image object, or NULL if none exists
2581 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2583 * Set the enabled status for the focus highlight in a window
2585 * This function will enable or disable the focus highlight only for the
2586 * given window, regardless of the global setting for it
2588 * @param obj The window where to enable the highlight
2589 * @param enabled The enabled value for the highlight
2591 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2593 * Get the enabled value of the focus highlight for this window
2595 * @param obj The window in which to check if the focus highlight is enabled
2597 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2599 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2601 * Set the style for the focus highlight on this window
2603 * Sets the style to use for theming the highlight of focused objects on
2604 * the given window. If @p style is NULL, the default will be used.
2606 * @param obj The window where to set the style
2607 * @param style The style to set
2609 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2611 * Get the style set for the focus highlight object
2613 * Gets the style set for this windows highilght object, or NULL if none
2616 * @param obj The window to retrieve the highlights style from
2618 * @return The style set or NULL if none was. Default is used in that case.
2620 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2622 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2623 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2624 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2625 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2626 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2627 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2628 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2630 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2631 * (blank mouse, private mouse obj, defaultmouse)
2635 * Sets the keyboard mode of the window.
2637 * @param obj The window object
2638 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2640 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2642 * Gets the keyboard mode of the window.
2644 * @param obj The window object
2645 * @return The mode, one of #Elm_Win_Keyboard_Mode
2647 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2649 * Sets whether the window is a keyboard.
2651 * @param obj The window object
2652 * @param is_keyboard If true, the window is a virtual keyboard
2654 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2656 * Gets whether the window is a keyboard.
2658 * @param obj The window object
2659 * @return If the window is a virtual keyboard
2661 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2664 * Get the screen position of a window.
2666 * @param obj The window object
2667 * @param x The int to store the x coordinate to
2668 * @param y The int to store the y coordinate to
2670 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2676 * @defgroup Inwin Inwin
2678 * @image html img/widget/inwin/preview-00.png
2679 * @image latex img/widget/inwin/preview-00.eps
2680 * @image html img/widget/inwin/preview-01.png
2681 * @image latex img/widget/inwin/preview-01.eps
2682 * @image html img/widget/inwin/preview-02.png
2683 * @image latex img/widget/inwin/preview-02.eps
2685 * An inwin is a window inside a window that is useful for a quick popup.
2686 * It does not hover.
2688 * It works by creating an object that will occupy the entire window, so it
2689 * must be created using an @ref Win "elm_win" as parent only. The inwin
2690 * object can be hidden or restacked below every other object if it's
2691 * needed to show what's behind it without destroying it. If this is done,
2692 * the elm_win_inwin_activate() function can be used to bring it back to
2693 * full visibility again.
2695 * There are three styles available in the default theme. These are:
2696 * @li default: The inwin is sized to take over most of the window it's
2698 * @li minimal: The size of the inwin will be the minimum necessary to show
2700 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2701 * possible, but it's sized vertically the most it needs to fit its\
2704 * Some examples of Inwin can be found in the following:
2705 * @li @ref inwin_example_01
2710 * Adds an inwin to the current window
2712 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2713 * Never call this function with anything other than the top-most window
2714 * as its parameter, unless you are fond of undefined behavior.
2716 * After creating the object, the widget will set itself as resize object
2717 * for the window with elm_win_resize_object_add(), so when shown it will
2718 * appear to cover almost the entire window (how much of it depends on its
2719 * content and the style used). It must not be added into other container
2720 * objects and it needs not be moved or resized manually.
2722 * @param parent The parent object
2723 * @return The new object or NULL if it cannot be created
2725 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2727 * Activates an inwin object, ensuring its visibility
2729 * This function will make sure that the inwin @p obj is completely visible
2730 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2731 * to the front. It also sets the keyboard focus to it, which will be passed
2734 * The object's theme will also receive the signal "elm,action,show" with
2737 * @param obj The inwin to activate
2739 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2741 * Set the content of an inwin object.
2743 * Once the content object is set, a previously set one will be deleted.
2744 * If you want to keep that old content object, use the
2745 * elm_win_inwin_content_unset() function.
2747 * @param obj The inwin object
2748 * @param content The object to set as content
2750 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2752 * Get the content of an inwin object.
2754 * Return the content object which is set for this widget.
2756 * The returned object is valid as long as the inwin is still alive and no
2757 * other content is set on it. Deleting the object will notify the inwin
2758 * about it and this one will be left empty.
2760 * If you need to remove an inwin's content to be reused somewhere else,
2761 * see elm_win_inwin_content_unset().
2763 * @param obj The inwin object
2764 * @return The content that is being used
2766 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2768 * Unset the content of an inwin object.
2770 * Unparent and return the content object which was set for this widget.
2772 * @param obj The inwin object
2773 * @return The content that was being used
2775 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2779 /* X specific calls - won't work on non-x engines (return 0) */
2780 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2781 /* smart callbacks called:
2782 * "delete,request" - the user requested to delete the window
2783 * "focus,in" - window got focus
2784 * "focus,out" - window lost focus
2785 * "moved" - window that holds the canvas was moved
2791 * @image html img/widget/bg/preview-00.png
2792 * @image latex img/widget/bg/preview-00.eps
2794 * @brief Background object, used for setting a solid color, image or Edje
2795 * group as background to a window or any container object.
2797 * The bg object is used for setting a solid background to a window or
2798 * packing into any container object. It works just like an image, but has
2799 * some properties useful to a background, like setting it to tiled,
2800 * centered, scaled or stretched.
2802 * Here is some sample code using it:
2803 * @li @ref bg_01_example_page
2804 * @li @ref bg_02_example_page
2805 * @li @ref bg_03_example_page
2809 typedef enum _Elm_Bg_Option
2811 ELM_BG_OPTION_CENTER, /**< center the background */
2812 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2813 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2814 ELM_BG_OPTION_TILE /**< tile background at its original size */
2818 * Add a new background to the parent
2820 * @param parent The parent object
2821 * @return The new object or NULL if it cannot be created
2825 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2828 * Set the file (image or edje) used for the background
2830 * @param obj The bg object
2831 * @param file The file path
2832 * @param group Optional key (group in Edje) within the file
2834 * This sets the image file used in the background object. The image (or edje)
2835 * will be stretched (retaining aspect if its an image file) to completely fill
2836 * the bg object. This may mean some parts are not visible.
2838 * @note Once the image of @p obj is set, a previously set one will be deleted,
2839 * even if @p file is NULL.
2843 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2846 * Get the file (image or edje) used for the background
2848 * @param obj The bg object
2849 * @param file The file path
2850 * @param group Optional key (group in Edje) within the file
2854 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2857 * Set the option used for the background image
2859 * @param obj The bg object
2860 * @param option The desired background option (TILE, SCALE)
2862 * This sets the option used for manipulating the display of the background
2863 * image. The image can be tiled or scaled.
2867 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2870 * Get the option used for the background image
2872 * @param obj The bg object
2873 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2877 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2879 * Set the option used for the background color
2881 * @param obj The bg object
2886 * This sets the color used for the background rectangle. Its range goes
2891 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2893 * Get the option used for the background color
2895 * @param obj The bg object
2902 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2905 * Set the overlay object used for the background object.
2907 * @param obj The bg object
2908 * @param overlay The overlay object
2910 * This provides a way for elm_bg to have an 'overlay' that will be on top
2911 * of the bg. Once the over object is set, a previously set one will be
2912 * deleted, even if you set the new one to NULL. If you want to keep that
2913 * old content object, use the elm_bg_overlay_unset() function.
2918 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2921 * Get the overlay object used for the background object.
2923 * @param obj The bg object
2924 * @return The content that is being used
2926 * Return the content object which is set for this widget
2930 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2933 * Get the overlay object used for the background object.
2935 * @param obj The bg object
2936 * @return The content that was being used
2938 * Unparent and return the overlay object which was set for this widget
2942 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2945 * Set the size of the pixmap representation of the image.
2947 * This option just makes sense if an image is going to be set in the bg.
2949 * @param obj The bg object
2950 * @param w The new width of the image pixmap representation.
2951 * @param h The new height of the image pixmap representation.
2953 * This function sets a new size for pixmap representation of the given bg
2954 * image. It allows the image to be loaded already in the specified size,
2955 * reducing the memory usage and load time when loading a big image with load
2956 * size set to a smaller size.
2958 * NOTE: this is just a hint, the real size of the pixmap may differ
2959 * depending on the type of image being loaded, being bigger than requested.
2963 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2964 /* smart callbacks called:
2968 * @defgroup Icon Icon
2970 * @image html img/widget/icon/preview-00.png
2971 * @image latex img/widget/icon/preview-00.eps
2973 * An object that provides standard icon images (delete, edit, arrows, etc.)
2974 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2976 * The icon image requested can be in the elementary theme, or in the
2977 * freedesktop.org paths. It's possible to set the order of preference from
2978 * where the image will be used.
2980 * This API is very similar to @ref Image, but with ready to use images.
2982 * Default images provided by the theme are described below.
2984 * The first list contains icons that were first intended to be used in
2985 * toolbars, but can be used in many other places too:
3001 * Now some icons that were designed to be used in menus (but again, you can
3002 * use them anywhere else):
3007 * @li menu/arrow_down
3008 * @li menu/arrow_left
3009 * @li menu/arrow_right
3018 * And here we have some media player specific icons:
3019 * @li media_player/forward
3020 * @li media_player/info
3021 * @li media_player/next
3022 * @li media_player/pause
3023 * @li media_player/play
3024 * @li media_player/prev
3025 * @li media_player/rewind
3026 * @li media_player/stop
3028 * Signals that you can add callbacks for are:
3030 * "clicked" - This is called when a user has clicked the icon
3032 * An example of usage for this API follows:
3033 * @li @ref tutorial_icon
3041 typedef enum _Elm_Icon_Type
3048 * @enum _Elm_Icon_Lookup_Order
3049 * @typedef Elm_Icon_Lookup_Order
3051 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
3052 * theme, FDO paths, or both?
3056 typedef enum _Elm_Icon_Lookup_Order
3058 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
3059 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
3060 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
3061 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
3062 } Elm_Icon_Lookup_Order;
3065 * Add a new icon object to the parent.
3067 * @param parent The parent object
3068 * @return The new object or NULL if it cannot be created
3070 * @see elm_icon_file_set()
3074 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3076 * Set the file that will be used as icon.
3078 * @param obj The icon object
3079 * @param file The path to file that will be used as icon image
3080 * @param group The group that the icon belongs to in edje file
3082 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3084 * @note The icon image set by this function can be changed by
3085 * elm_icon_standard_set().
3087 * @see elm_icon_file_get()
3091 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3093 * Set a location in memory to be used as an icon
3095 * @param obj The icon object
3096 * @param img The binary data that will be used as an image
3097 * @param size The size of binary data @p img
3098 * @param format Optional format of @p img to pass to the image loader
3099 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
3101 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3103 * @note The icon image set by this function can be changed by
3104 * elm_icon_standard_set().
3108 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);
3110 * Get the file that will be used as icon.
3112 * @param obj The icon object
3113 * @param file The path to file that will be used as icon icon image
3114 * @param group The group that the icon belongs to in edje file
3116 * @see elm_icon_file_set()
3120 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3121 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3123 * Set the icon by icon standards names.
3125 * @param obj The icon object
3126 * @param name The icon name
3128 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3130 * For example, freedesktop.org defines standard icon names such as "home",
3131 * "network", etc. There can be different icon sets to match those icon
3132 * keys. The @p name given as parameter is one of these "keys", and will be
3133 * used to look in the freedesktop.org paths and elementary theme. One can
3134 * change the lookup order with elm_icon_order_lookup_set().
3136 * If name is not found in any of the expected locations and it is the
3137 * absolute path of an image file, this image will be used.
3139 * @note The icon image set by this function can be changed by
3140 * elm_icon_file_set().
3142 * @see elm_icon_standard_get()
3143 * @see elm_icon_file_set()
3147 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
3149 * Get the icon name set by icon standard names.
3151 * @param obj The icon object
3152 * @return The icon name
3154 * If the icon image was set using elm_icon_file_set() instead of
3155 * elm_icon_standard_set(), then this function will return @c NULL.
3157 * @see elm_icon_standard_set()
3161 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3163 * Set the smooth effect for an icon object.
3165 * @param obj The icon object
3166 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3167 * otherwise. Default is @c EINA_TRUE.
3169 * Set the scaling algorithm to be used when scaling the icon image. Smooth
3170 * scaling provides a better resulting image, but is slower.
3172 * The smooth scaling should be disabled when making animations that change
3173 * the icon size, since they will be faster. Animations that don't require
3174 * resizing of the icon can keep the smooth scaling enabled (even if the icon
3175 * is already scaled, since the scaled icon image will be cached).
3177 * @see elm_icon_smooth_get()
3181 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3183 * Get the smooth effect for an icon object.
3185 * @param obj The icon object
3186 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3188 * @see elm_icon_smooth_set()
3192 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3194 * Disable scaling of this object.
3196 * @param obj The icon object.
3197 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3198 * otherwise. Default is @c EINA_FALSE.
3200 * This function disables scaling of the icon object through the function
3201 * elm_object_scale_set(). However, this does not affect the object
3202 * size/resize in any way. For that effect, take a look at
3203 * elm_icon_scale_set().
3205 * @see elm_icon_no_scale_get()
3206 * @see elm_icon_scale_set()
3207 * @see elm_object_scale_set()
3211 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3213 * Get whether scaling is disabled on the object.
3215 * @param obj The icon object
3216 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3218 * @see elm_icon_no_scale_set()
3222 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3224 * Set if the object is (up/down) resizeable.
3226 * @param obj The icon object
3227 * @param scale_up A bool to set if the object is resizeable up. Default is
3229 * @param scale_down A bool to set if the object is resizeable down. Default
3232 * This function limits the icon object resize ability. If @p scale_up is set to
3233 * @c EINA_FALSE, the object can't have its height or width resized to a value
3234 * higher than the original icon size. Same is valid for @p scale_down.
3236 * @see elm_icon_scale_get()
3240 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3242 * Get if the object is (up/down) resizeable.
3244 * @param obj The icon object
3245 * @param scale_up A bool to set if the object is resizeable up
3246 * @param scale_down A bool to set if the object is resizeable down
3248 * @see elm_icon_scale_set()
3252 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3254 * Get the object's image size
3256 * @param obj The icon object
3257 * @param w A pointer to store the width in
3258 * @param h A pointer to store the height in
3262 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3264 * Set if the icon fill the entire object area.
3266 * @param obj The icon object
3267 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3268 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3270 * When the icon object is resized to a different aspect ratio from the
3271 * original icon image, the icon image will still keep its aspect. This flag
3272 * tells how the image should fill the object's area. They are: keep the
3273 * entire icon inside the limits of height and width of the object (@p
3274 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3275 * of the object, and the icon will fill the entire object (@p fill_outside
3278 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3279 * retain property to false. Thus, the icon image will always keep its
3280 * original aspect ratio.
3282 * @see elm_icon_fill_outside_get()
3283 * @see elm_image_fill_outside_set()
3287 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3289 * Get if the object is filled outside.
3291 * @param obj The icon object
3292 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3294 * @see elm_icon_fill_outside_set()
3298 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3300 * Set the prescale size for the icon.
3302 * @param obj The icon object
3303 * @param size The prescale size. This value is used for both width and
3306 * This function sets a new size for pixmap representation of the given
3307 * icon. It allows the icon to be loaded already in the specified size,
3308 * reducing the memory usage and load time when loading a big icon with load
3309 * size set to a smaller size.
3311 * It's equivalent to the elm_bg_load_size_set() function for bg.
3313 * @note this is just a hint, the real size of the pixmap may differ
3314 * depending on the type of icon being loaded, being bigger than requested.
3316 * @see elm_icon_prescale_get()
3317 * @see elm_bg_load_size_set()
3321 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3323 * Get the prescale size for the icon.
3325 * @param obj The icon object
3326 * @return The prescale size
3328 * @see elm_icon_prescale_set()
3332 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3334 * Sets the icon lookup order used by elm_icon_standard_set().
3336 * @param obj The icon object
3337 * @param order The icon lookup order (can be one of
3338 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3339 * or ELM_ICON_LOOKUP_THEME)
3341 * @see elm_icon_order_lookup_get()
3342 * @see Elm_Icon_Lookup_Order
3346 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3348 * Gets the icon lookup order.
3350 * @param obj The icon object
3351 * @return The icon lookup order
3353 * @see elm_icon_order_lookup_set()
3354 * @see Elm_Icon_Lookup_Order
3358 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3365 * @defgroup Image Image
3367 * @image html img/widget/image/preview-00.png
3368 * @image latex img/widget/image/preview-00.eps
3370 * An object that allows one to load an image file to it. It can be used
3371 * anywhere like any other elementary widget.
3373 * This widget provides most of the functionality provided from @ref Bg or @ref
3374 * Icon, but with a slightly different API (use the one that fits better your
3377 * The features not provided by those two other image widgets are:
3378 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3379 * @li change the object orientation with elm_image_orient_set();
3380 * @li and turning the image editable with elm_image_editable_set().
3382 * Signals that you can add callbacks for are:
3384 * @li @c "clicked" - This is called when a user has clicked the image
3386 * An example of usage for this API follows:
3387 * @li @ref tutorial_image
3396 * @enum _Elm_Image_Orient
3397 * @typedef Elm_Image_Orient
3399 * Possible orientation options for elm_image_orient_set().
3401 * @image html elm_image_orient_set.png
3402 * @image latex elm_image_orient_set.eps width=\textwidth
3406 typedef enum _Elm_Image_Orient
3408 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3409 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3410 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3411 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3412 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3413 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3414 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3415 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3419 * Add a new image to the parent.
3421 * @param parent The parent object
3422 * @return The new object or NULL if it cannot be created
3424 * @see elm_image_file_set()
3428 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3430 * Set the file that will be used as image.
3432 * @param obj The image object
3433 * @param file The path to file that will be used as image
3434 * @param group The group that the image belongs in edje file (if it's an
3437 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3439 * @see elm_image_file_get()
3443 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3445 * Get the file that will be used as image.
3447 * @param obj The image object
3448 * @param file The path to file
3449 * @param group The group that the image belongs in edje file
3451 * @see elm_image_file_set()
3455 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3457 * Set the smooth effect for an image.
3459 * @param obj The image object
3460 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3461 * otherwise. Default is @c EINA_TRUE.
3463 * Set the scaling algorithm to be used when scaling the image. Smooth
3464 * scaling provides a better resulting image, but is slower.
3466 * The smooth scaling should be disabled when making animations that change
3467 * the image size, since it will be faster. Animations that don't require
3468 * resizing of the image can keep the smooth scaling enabled (even if the
3469 * image is already scaled, since the scaled image will be cached).
3471 * @see elm_image_smooth_get()
3475 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3477 * Get the smooth effect for an image.
3479 * @param obj The image object
3480 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3482 * @see elm_image_smooth_get()
3486 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3488 * Gets the current size of the image.
3490 * @param obj The image object.
3491 * @param w Pointer to store width, or NULL.
3492 * @param h Pointer to store height, or NULL.
3494 * This is the real size of the image, not the size of the object.
3496 * On error, neither w or h will be written.
3500 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3502 * Disable scaling of this object.
3504 * @param obj The image object.
3505 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3506 * otherwise. Default is @c EINA_FALSE.
3508 * This function disables scaling of the elm_image widget through the
3509 * function elm_object_scale_set(). However, this does not affect the widget
3510 * size/resize in any way. For that effect, take a look at
3511 * elm_image_scale_set().
3513 * @see elm_image_no_scale_get()
3514 * @see elm_image_scale_set()
3515 * @see elm_object_scale_set()
3519 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3521 * Get whether scaling is disabled on the object.
3523 * @param obj The image object
3524 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3526 * @see elm_image_no_scale_set()
3530 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3532 * Set if the object is (up/down) resizeable.
3534 * @param obj The image object
3535 * @param scale_up A bool to set if the object is resizeable up. Default is
3537 * @param scale_down A bool to set if the object is resizeable down. Default
3540 * This function limits the image resize ability. If @p scale_up is set to
3541 * @c EINA_FALSE, the object can't have its height or width resized to a value
3542 * higher than the original image size. Same is valid for @p scale_down.
3544 * @see elm_image_scale_get()
3548 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3550 * Get if the object is (up/down) resizeable.
3552 * @param obj The image object
3553 * @param scale_up A bool to set if the object is resizeable up
3554 * @param scale_down A bool to set if the object is resizeable down
3556 * @see elm_image_scale_set()
3560 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3562 * Set if the image fill the entire object area when keeping the aspect ratio.
3564 * @param obj The image object
3565 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3566 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3568 * When the image should keep its aspect ratio even if resized to another
3569 * aspect ratio, there are two possibilities to resize it: keep the entire
3570 * image inside the limits of height and width of the object (@p fill_outside
3571 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3572 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3574 * @note This option will have no effect if
3575 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3577 * @see elm_image_fill_outside_get()
3578 * @see elm_image_aspect_ratio_retained_set()
3582 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3584 * Get if the object is filled outside
3586 * @param obj The image object
3587 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3589 * @see elm_image_fill_outside_set()
3593 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3595 * Set the prescale size for the image
3597 * @param obj The image object
3598 * @param size The prescale size. This value is used for both width and
3601 * This function sets a new size for pixmap representation of the given
3602 * image. It allows the image to be loaded already in the specified size,
3603 * reducing the memory usage and load time when loading a big image with load
3604 * size set to a smaller size.
3606 * It's equivalent to the elm_bg_load_size_set() function for bg.
3608 * @note this is just a hint, the real size of the pixmap may differ
3609 * depending on the type of image being loaded, being bigger than requested.
3611 * @see elm_image_prescale_get()
3612 * @see elm_bg_load_size_set()
3616 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3618 * Get the prescale size for the image
3620 * @param obj The image object
3621 * @return The prescale size
3623 * @see elm_image_prescale_set()
3627 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3629 * Set the image orientation.
3631 * @param obj The image object
3632 * @param orient The image orientation
3633 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3634 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3635 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3636 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3637 * Default is #ELM_IMAGE_ORIENT_NONE.
3639 * This function allows to rotate or flip the given image.
3641 * @see elm_image_orient_get()
3642 * @see @ref Elm_Image_Orient
3646 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3648 * Get the image orientation.
3650 * @param obj The image object
3651 * @return The image orientation
3652 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3653 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3654 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3655 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3657 * @see elm_image_orient_set()
3658 * @see @ref Elm_Image_Orient
3662 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3664 * Make the image 'editable'.
3666 * @param obj Image object.
3667 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3669 * This means the image is a valid drag target for drag and drop, and can be
3670 * cut or pasted too.
3674 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3676 * Make the image 'editable'.
3678 * @param obj Image object.
3679 * @return Editability.
3681 * This means the image is a valid drag target for drag and drop, and can be
3682 * cut or pasted too.
3686 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3688 * Get the basic Evas_Image object from this object (widget).
3690 * @param obj The image object to get the inlined image from
3691 * @return The inlined image object, or NULL if none exists
3693 * This function allows one to get the underlying @c Evas_Object of type
3694 * Image from this elementary widget. It can be useful to do things like get
3695 * the pixel data, save the image to a file, etc.
3697 * @note Be careful to not manipulate it, as it is under control of
3702 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3704 * Set whether the original aspect ratio of the image should be kept on resize.
3706 * @param obj The image object.
3707 * @param retained @c EINA_TRUE if the image should retain the aspect,
3708 * @c EINA_FALSE otherwise.
3710 * The original aspect ratio (width / height) of the image is usually
3711 * distorted to match the object's size. Enabling this option will retain
3712 * this original aspect, and the way that the image is fit into the object's
3713 * area depends on the option set by elm_image_fill_outside_set().
3715 * @see elm_image_aspect_ratio_retained_get()
3716 * @see elm_image_fill_outside_set()
3720 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3722 * Get if the object retains the original aspect ratio.
3724 * @param obj The image object.
3725 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3730 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3732 /* smart callbacks called:
3733 * "clicked" - the user clicked the image
3741 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3743 typedef enum _Elm_GLView_Mode
3745 ELM_GLVIEW_ALPHA = 1,
3746 ELM_GLVIEW_DEPTH = 2,
3747 ELM_GLVIEW_STENCIL = 4
3751 * Defines a policy for the glview resizing.
3753 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3755 typedef enum _Elm_GLView_Resize_Policy
3757 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3758 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3759 } Elm_GLView_Resize_Policy;
3761 typedef enum _Elm_GLView_Render_Policy
3763 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3764 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3765 } Elm_GLView_Render_Policy;
3768 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3769 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3770 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3771 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3773 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3774 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3775 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3776 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3777 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3778 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3779 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3785 * @image html img/widget/box/preview-00.png
3786 * @image latex img/widget/box/preview-00.eps width=\textwidth
3788 * @image html img/box.png
3789 * @image latex img/box.eps width=\textwidth
3791 * A box arranges objects in a linear fashion, governed by a layout function
3792 * that defines the details of this arrangement.
3794 * By default, the box will use an internal function to set the layout to
3795 * a single row, either vertical or horizontal. This layout is affected
3796 * by a number of parameters, such as the homogeneous flag set by
3797 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3798 * elm_box_align_set() and the hints set to each object in the box.
3800 * For this default layout, it's possible to change the orientation with
3801 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3802 * placing its elements ordered from top to bottom. When horizontal is set,
3803 * the order will go from left to right. If the box is set to be
3804 * homogeneous, every object in it will be assigned the same space, that
3805 * of the largest object. Padding can be used to set some spacing between
3806 * the cell given to each object. The alignment of the box, set with
3807 * elm_box_align_set(), determines how the bounding box of all the elements
3808 * will be placed within the space given to the box widget itself.
3810 * The size hints of each object also affect how they are placed and sized
3811 * within the box. evas_object_size_hint_min_set() will give the minimum
3812 * size the object can have, and the box will use it as the basis for all
3813 * latter calculations. Elementary widgets set their own minimum size as
3814 * needed, so there's rarely any need to use it manually.
3816 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3817 * used to tell whether the object will be allocated the minimum size it
3818 * needs or if the space given to it should be expanded. It's important
3819 * to realize that expanding the size given to the object is not the same
3820 * thing as resizing the object. It could very well end being a small
3821 * widget floating in a much larger empty space. If not set, the weight
3822 * for objects will normally be 0.0 for both axis, meaning the widget will
3823 * not be expanded. To take as much space possible, set the weight to
3824 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3826 * Besides how much space each object is allocated, it's possible to control
3827 * how the widget will be placed within that space using
3828 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3829 * for both axis, meaning the object will be centered, but any value from
3830 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3831 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3832 * is -1.0, means the object will be resized to fill the entire space it
3835 * In addition, customized functions to define the layout can be set, which
3836 * allow the application developer to organize the objects within the box
3837 * in any number of ways.
3839 * The special elm_box_layout_transition() function can be used
3840 * to switch from one layout to another, animating the motion of the
3841 * children of the box.
3843 * @note Objects should not be added to box objects using _add() calls.
3845 * Some examples on how to use boxes follow:
3846 * @li @ref box_example_01
3847 * @li @ref box_example_02
3852 * @typedef Elm_Box_Transition
3854 * Opaque handler containing the parameters to perform an animated
3855 * transition of the layout the box uses.
3857 * @see elm_box_transition_new()
3858 * @see elm_box_layout_set()
3859 * @see elm_box_layout_transition()
3861 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3864 * Add a new box to the parent
3866 * By default, the box will be in vertical mode and non-homogeneous.
3868 * @param parent The parent object
3869 * @return The new object or NULL if it cannot be created
3871 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3873 * Set the horizontal orientation
3875 * By default, box object arranges their contents vertically from top to
3877 * By calling this function with @p horizontal as EINA_TRUE, the box will
3878 * become horizontal, arranging contents from left to right.
3880 * @note This flag is ignored if a custom layout function is set.
3882 * @param obj The box object
3883 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3884 * EINA_FALSE = vertical)
3886 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3888 * Get the horizontal orientation
3890 * @param obj The box object
3891 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3893 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895 * Set the box to arrange its children homogeneously
3897 * If enabled, homogeneous layout makes all items the same size, according
3898 * to the size of the largest of its children.
3900 * @note This flag is ignored if a custom layout function is set.
3902 * @param obj The box object
3903 * @param homogeneous The homogeneous flag
3905 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3907 * Get whether the box is using homogeneous mode or not
3909 * @param obj The box object
3910 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3912 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3913 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3914 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3916 * Add an object to the beginning of the pack list
3918 * Pack @p subobj into the box @p obj, placing it first in the list of
3919 * children objects. The actual position the object will get on screen
3920 * depends on the layout used. If no custom layout is set, it will be at
3921 * the top or left, depending if the box is vertical or horizontal,
3924 * @param obj The box object
3925 * @param subobj The object to add to the box
3927 * @see elm_box_pack_end()
3928 * @see elm_box_pack_before()
3929 * @see elm_box_pack_after()
3930 * @see elm_box_unpack()
3931 * @see elm_box_unpack_all()
3932 * @see elm_box_clear()
3934 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3936 * Add an object at the end of the pack list
3938 * Pack @p subobj into the box @p obj, placing it last in the list of
3939 * children objects. The actual position the object will get on screen
3940 * depends on the layout used. If no custom layout is set, it will be at
3941 * the bottom or right, depending if the box is vertical or horizontal,
3944 * @param obj The box object
3945 * @param subobj The object to add to the box
3947 * @see elm_box_pack_start()
3948 * @see elm_box_pack_before()
3949 * @see elm_box_pack_after()
3950 * @see elm_box_unpack()
3951 * @see elm_box_unpack_all()
3952 * @see elm_box_clear()
3954 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3956 * Adds an object to the box before the indicated object
3958 * This will add the @p subobj to the box indicated before the object
3959 * indicated with @p before. If @p before is not already in the box, results
3960 * are undefined. Before means either to the left of the indicated object or
3961 * above it depending on orientation.
3963 * @param obj The box object
3964 * @param subobj The object to add to the box
3965 * @param before The object before which to add it
3967 * @see elm_box_pack_start()
3968 * @see elm_box_pack_end()
3969 * @see elm_box_pack_after()
3970 * @see elm_box_unpack()
3971 * @see elm_box_unpack_all()
3972 * @see elm_box_clear()
3974 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3976 * Adds an object to the box after the indicated object
3978 * This will add the @p subobj to the box indicated after the object
3979 * indicated with @p after. If @p after is not already in the box, results
3980 * are undefined. After means either to the right of the indicated object or
3981 * below it depending on orientation.
3983 * @param obj The box object
3984 * @param subobj The object to add to the box
3985 * @param after The object after which to add it
3987 * @see elm_box_pack_start()
3988 * @see elm_box_pack_end()
3989 * @see elm_box_pack_before()
3990 * @see elm_box_unpack()
3991 * @see elm_box_unpack_all()
3992 * @see elm_box_clear()
3994 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3996 * Clear the box of all children
3998 * Remove all the elements contained by the box, deleting the respective
4001 * @param obj The box object
4003 * @see elm_box_unpack()
4004 * @see elm_box_unpack_all()
4006 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4010 * Remove the object given by @p subobj from the box @p obj without
4013 * @param obj The box object
4015 * @see elm_box_unpack_all()
4016 * @see elm_box_clear()
4018 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4020 * Remove all items from the box, without deleting them
4022 * Clear the box from all children, but don't delete the respective objects.
4023 * If no other references of the box children exist, the objects will never
4024 * be deleted, and thus the application will leak the memory. Make sure
4025 * when using this function that you hold a reference to all the objects
4026 * in the box @p obj.
4028 * @param obj The box object
4030 * @see elm_box_clear()
4031 * @see elm_box_unpack()
4033 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4035 * Retrieve a list of the objects packed into the box
4037 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
4038 * The order of the list corresponds to the packing order the box uses.
4040 * You must free this list with eina_list_free() once you are done with it.
4042 * @param obj The box object
4044 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046 * Set the space (padding) between the box's elements.
4048 * Extra space in pixels that will be added between a box child and its
4049 * neighbors after its containing cell has been calculated. This padding
4050 * is set for all elements in the box, besides any possible padding that
4051 * individual elements may have through their size hints.
4053 * @param obj The box object
4054 * @param horizontal The horizontal space between elements
4055 * @param vertical The vertical space between elements
4057 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4059 * Get the space (padding) between the box's elements.
4061 * @param obj The box object
4062 * @param horizontal The horizontal space between elements
4063 * @param vertical The vertical space between elements
4065 * @see elm_box_padding_set()
4067 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4069 * Set the alignment of the whole bouding box of contents.
4071 * Sets how the bounding box containing all the elements of the box, after
4072 * their sizes and position has been calculated, will be aligned within
4073 * the space given for the whole box widget.
4075 * @param obj The box object
4076 * @param horizontal The horizontal alignment of elements
4077 * @param vertical The vertical alignment of elements
4079 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
4081 * Get the alignment of the whole bouding box of contents.
4083 * @param obj The box object
4084 * @param horizontal The horizontal alignment of elements
4085 * @param vertical The vertical alignment of elements
4087 * @see elm_box_align_set()
4089 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
4092 * Set the layout defining function to be used by the box
4094 * Whenever anything changes that requires the box in @p obj to recalculate
4095 * the size and position of its elements, the function @p cb will be called
4096 * to determine what the layout of the children will be.
4098 * Once a custom function is set, everything about the children layout
4099 * is defined by it. The flags set by elm_box_horizontal_set() and
4100 * elm_box_homogeneous_set() no longer have any meaning, and the values
4101 * given by elm_box_padding_set() and elm_box_align_set() are up to this
4102 * layout function to decide if they are used and how. These last two
4103 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
4104 * passed to @p cb. The @c Evas_Object the function receives is not the
4105 * Elementary widget, but the internal Evas Box it uses, so none of the
4106 * functions described here can be used on it.
4108 * Any of the layout functions in @c Evas can be used here, as well as the
4109 * special elm_box_layout_transition().
4111 * The final @p data argument received by @p cb is the same @p data passed
4112 * here, and the @p free_data function will be called to free it
4113 * whenever the box is destroyed or another layout function is set.
4115 * Setting @p cb to NULL will revert back to the default layout function.
4117 * @param obj The box object
4118 * @param cb The callback function used for layout
4119 * @param data Data that will be passed to layout function
4120 * @param free_data Function called to free @p data
4122 * @see elm_box_layout_transition()
4124 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);
4126 * Special layout function that animates the transition from one layout to another
4128 * Normally, when switching the layout function for a box, this will be
4129 * reflected immediately on screen on the next render, but it's also
4130 * possible to do this through an animated transition.
4132 * This is done by creating an ::Elm_Box_Transition and setting the box
4133 * layout to this function.
4137 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
4138 * evas_object_box_layout_vertical, // start
4139 * NULL, // data for initial layout
4140 * NULL, // free function for initial data
4141 * evas_object_box_layout_horizontal, // end
4142 * NULL, // data for final layout
4143 * NULL, // free function for final data
4144 * anim_end, // will be called when animation ends
4145 * NULL); // data for anim_end function\
4146 * elm_box_layout_set(box, elm_box_layout_transition, t,
4147 * elm_box_transition_free);
4150 * @note This function can only be used with elm_box_layout_set(). Calling
4151 * it directly will not have the expected results.
4153 * @see elm_box_transition_new
4154 * @see elm_box_transition_free
4155 * @see elm_box_layout_set
4157 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
4159 * Create a new ::Elm_Box_Transition to animate the switch of layouts
4161 * If you want to animate the change from one layout to another, you need
4162 * to set the layout function of the box to elm_box_layout_transition(),
4163 * passing as user data to it an instance of ::Elm_Box_Transition with the
4164 * necessary information to perform this animation. The free function to
4165 * set for the layout is elm_box_transition_free().
4167 * The parameters to create an ::Elm_Box_Transition sum up to how long
4168 * will it be, in seconds, a layout function to describe the initial point,
4169 * another for the final position of the children and one function to be
4170 * called when the whole animation ends. This last function is useful to
4171 * set the definitive layout for the box, usually the same as the end
4172 * layout for the animation, but could be used to start another transition.
4174 * @param start_layout The layout function that will be used to start the animation
4175 * @param start_layout_data The data to be passed the @p start_layout function
4176 * @param start_layout_free_data Function to free @p start_layout_data
4177 * @param end_layout The layout function that will be used to end the animation
4178 * @param end_layout_free_data The data to be passed the @p end_layout function
4179 * @param end_layout_free_data Function to free @p end_layout_data
4180 * @param transition_end_cb Callback function called when animation ends
4181 * @param transition_end_data Data to be passed to @p transition_end_cb
4182 * @return An instance of ::Elm_Box_Transition
4184 * @see elm_box_transition_new
4185 * @see elm_box_layout_transition
4187 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);
4189 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
4191 * This function is mostly useful as the @c free_data parameter in
4192 * elm_box_layout_set() when elm_box_layout_transition().
4194 * @param data The Elm_Box_Transition instance to be freed.
4196 * @see elm_box_transition_new
4197 * @see elm_box_layout_transition
4199 EAPI void elm_box_transition_free(void *data);
4206 * @defgroup Button Button
4208 * @image html img/widget/button/preview-00.png
4209 * @image latex img/widget/button/preview-00.eps
4210 * @image html img/widget/button/preview-01.png
4211 * @image latex img/widget/button/preview-01.eps
4212 * @image html img/widget/button/preview-02.png
4213 * @image latex img/widget/button/preview-02.eps
4215 * This is a push-button. Press it and run some function. It can contain
4216 * a simple label and icon object and it also has an autorepeat feature.
4218 * This widgets emits the following signals:
4219 * @li "clicked": the user clicked the button (press/release).
4220 * @li "repeated": the user pressed the button without releasing it.
4221 * @li "pressed": button was pressed.
4222 * @li "unpressed": button was released after being pressed.
4223 * In all three cases, the @c event parameter of the callback will be
4226 * Also, defined in the default theme, the button has the following styles
4228 * @li default: a normal button.
4229 * @li anchor: Like default, but the button fades away when the mouse is not
4230 * over it, leaving only the text or icon.
4231 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4232 * continuous look across its options.
4233 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4235 * Follow through a complete example @ref button_example_01 "here".
4239 * Add a new button to the parent's canvas
4241 * @param parent The parent object
4242 * @return The new object or NULL if it cannot be created
4244 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4246 * Set the label used in the button
4248 * The passed @p label can be NULL to clean any existing text in it and
4249 * leave the button as an icon only object.
4251 * @param obj The button object
4252 * @param label The text will be written on the button
4253 * @deprecated use elm_object_text_set() instead.
4255 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4257 * Get the label set for the button
4259 * The string returned is an internal pointer and should not be freed or
4260 * altered. It will also become invalid when the button is destroyed.
4261 * The string returned, if not NULL, is a stringshare, so if you need to
4262 * keep it around even after the button is destroyed, you can use
4263 * eina_stringshare_ref().
4265 * @param obj The button object
4266 * @return The text set to the label, or NULL if nothing is set
4267 * @deprecated use elm_object_text_set() instead.
4269 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4271 * Set the icon used for the button
4273 * Setting a new icon will delete any other that was previously set, making
4274 * any reference to them invalid. If you need to maintain the previous
4275 * object alive, unset it first with elm_button_icon_unset().
4277 * @param obj The button object
4278 * @param icon The icon object for the button
4280 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4282 * Get the icon used for the button
4284 * Return the icon object which is set for this widget. If the button is
4285 * destroyed or another icon is set, the returned object will be deleted
4286 * and any reference to it will be invalid.
4288 * @param obj The button object
4289 * @return The icon object that is being used
4291 * @see elm_button_icon_unset()
4293 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4295 * Remove the icon set without deleting it and return the object
4297 * This function drops the reference the button holds of the icon object
4298 * and returns this last object. It is used in case you want to remove any
4299 * icon, or set another one, without deleting the actual object. The button
4300 * will be left without an icon set.
4302 * @param obj The button object
4303 * @return The icon object that was being used
4305 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4307 * Turn on/off the autorepeat event generated when the button is kept pressed
4309 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4310 * signal when they are clicked.
4312 * When on, keeping a button pressed will continuously emit a @c repeated
4313 * signal until the button is released. The time it takes until it starts
4314 * emitting the signal is given by
4315 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4316 * new emission by elm_button_autorepeat_gap_timeout_set().
4318 * @param obj The button object
4319 * @param on A bool to turn on/off the event
4321 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4323 * Get whether the autorepeat feature is enabled
4325 * @param obj The button object
4326 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4328 * @see elm_button_autorepeat_set()
4330 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4332 * Set the initial timeout before the autorepeat event is generated
4334 * Sets the timeout, in seconds, since the button is pressed until the
4335 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4336 * won't be any delay and the even will be fired the moment the button is
4339 * @param obj The button object
4340 * @param t Timeout in seconds
4342 * @see elm_button_autorepeat_set()
4343 * @see elm_button_autorepeat_gap_timeout_set()
4345 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4347 * Get the initial timeout before the autorepeat event is generated
4349 * @param obj The button object
4350 * @return Timeout in seconds
4352 * @see elm_button_autorepeat_initial_timeout_set()
4354 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4356 * Set the interval between each generated autorepeat event
4358 * After the first @c repeated event is fired, all subsequent ones will
4359 * follow after a delay of @p t seconds for each.
4361 * @param obj The button object
4362 * @param t Interval in seconds
4364 * @see elm_button_autorepeat_initial_timeout_set()
4366 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4368 * Get the interval between each generated autorepeat event
4370 * @param obj The button object
4371 * @return Interval in seconds
4373 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4379 * @defgroup File_Selector_Button File Selector Button
4381 * @image html img/widget/fileselector_button/preview-00.png
4382 * @image latex img/widget/fileselector_button/preview-00.eps
4383 * @image html img/widget/fileselector_button/preview-01.png
4384 * @image latex img/widget/fileselector_button/preview-01.eps
4385 * @image html img/widget/fileselector_button/preview-02.png
4386 * @image latex img/widget/fileselector_button/preview-02.eps
4388 * This is a button that, when clicked, creates an Elementary
4389 * window (or inner window) <b> with a @ref Fileselector "file
4390 * selector widget" within</b>. When a file is chosen, the (inner)
4391 * window is closed and the button emits a signal having the
4392 * selected file as it's @c event_info.
4394 * This widget encapsulates operations on its internal file
4395 * selector on its own API. There is less control over its file
4396 * selector than that one would have instatiating one directly.
4398 * The following styles are available for this button:
4401 * @li @c "hoversel_vertical"
4402 * @li @c "hoversel_vertical_entry"
4404 * Smart callbacks one can register to:
4405 * - @c "file,chosen" - the user has selected a path, whose string
4406 * pointer comes as the @c event_info data (a stringshared
4409 * Here is an example on its usage:
4410 * @li @ref fileselector_button_example
4412 * @see @ref File_Selector_Entry for a similar widget.
4417 * Add a new file selector button widget to the given parent
4418 * Elementary (container) object
4420 * @param parent The parent object
4421 * @return a new file selector button widget handle or @c NULL, on
4424 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4427 * Set the label for a given file selector button widget
4429 * @param obj The file selector button widget
4430 * @param label The text label to be displayed on @p obj
4432 * @deprecated use elm_object_text_set() instead.
4434 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4437 * Get the label set for a given file selector button widget
4439 * @param obj The file selector button widget
4440 * @return The button label
4442 * @deprecated use elm_object_text_set() instead.
4444 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4447 * Set the icon on a given file selector button widget
4449 * @param obj The file selector button widget
4450 * @param icon The icon object for the button
4452 * Once the icon object is set, a previously set one will be
4453 * deleted. If you want to keep the latter, use the
4454 * elm_fileselector_button_icon_unset() function.
4456 * @see elm_fileselector_button_icon_get()
4458 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4461 * Get the icon set for a given file selector button widget
4463 * @param obj The file selector button widget
4464 * @return The icon object currently set on @p obj or @c NULL, if
4467 * @see elm_fileselector_button_icon_set()
4469 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4472 * Unset the icon used in a given file selector button widget
4474 * @param obj The file selector button widget
4475 * @return The icon object that was being used on @p obj or @c
4478 * Unparent and return the icon object which was set for this
4481 * @see elm_fileselector_button_icon_set()
4483 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4486 * Set the title for a given file selector button widget's window
4488 * @param obj The file selector button widget
4489 * @param title The title string
4491 * This will change the window's title, when the file selector pops
4492 * out after a click on the button. Those windows have the default
4493 * (unlocalized) value of @c "Select a file" as titles.
4495 * @note It will only take any effect if the file selector
4496 * button widget is @b not under "inwin mode".
4498 * @see elm_fileselector_button_window_title_get()
4500 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4503 * Get the title set for a given file selector button widget's
4506 * @param obj The file selector button widget
4507 * @return Title of the file selector button's window
4509 * @see elm_fileselector_button_window_title_get() for more details
4511 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4514 * Set the size of a given file selector button widget's window,
4515 * holding the file selector itself.
4517 * @param obj The file selector button widget
4518 * @param width The window's width
4519 * @param height The window's height
4521 * @note it will only take any effect if the file selector button
4522 * widget is @b not under "inwin mode". The default size for the
4523 * window (when applicable) is 400x400 pixels.
4525 * @see elm_fileselector_button_window_size_get()
4527 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4530 * Get the size of a given file selector button widget's window,
4531 * holding the file selector itself.
4533 * @param obj The file selector button widget
4534 * @param width Pointer into which to store the width value
4535 * @param height Pointer into which to store the height value
4537 * @note Use @c NULL pointers on the size values you're not
4538 * interested in: they'll be ignored by the function.
4540 * @see elm_fileselector_button_window_size_set(), for more details
4542 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4545 * Set the initial file system path for a given file selector
4548 * @param obj The file selector button widget
4549 * @param path The path string
4551 * It must be a <b>directory</b> path, which will have the contents
4552 * displayed initially in the file selector's view, when invoked
4553 * from @p obj. The default initial path is the @c "HOME"
4554 * environment variable's value.
4556 * @see elm_fileselector_button_path_get()
4558 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4561 * Get the initial file system path set for a given file selector
4564 * @param obj The file selector button widget
4565 * @return path The path string
4567 * @see elm_fileselector_button_path_set() for more details
4569 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4572 * Enable/disable a tree view in the given file selector button
4573 * widget's internal file selector
4575 * @param obj The file selector button widget
4576 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4579 * This has the same effect as elm_fileselector_expandable_set(),
4580 * but now applied to a file selector button's internal file
4583 * @note There's no way to put a file selector button's internal
4584 * file selector in "grid mode", as one may do with "pure" file
4587 * @see elm_fileselector_expandable_get()
4589 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4592 * Get whether tree view is enabled for the given file selector
4593 * button widget's internal file selector
4595 * @param obj The file selector button widget
4596 * @return @c EINA_TRUE if @p obj widget's internal file selector
4597 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4599 * @see elm_fileselector_expandable_set() for more details
4601 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4604 * Set whether a given file selector button widget's internal file
4605 * selector is to display folders only or the directory contents,
4608 * @param obj The file selector button widget
4609 * @param only @c EINA_TRUE to make @p obj widget's internal file
4610 * selector only display directories, @c EINA_FALSE to make files
4611 * to be displayed in it too
4613 * This has the same effect as elm_fileselector_folder_only_set(),
4614 * but now applied to a file selector button's internal file
4617 * @see elm_fileselector_folder_only_get()
4619 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4622 * Get whether a given file selector button widget's internal file
4623 * selector is displaying folders only or the directory contents,
4626 * @param obj The file selector button widget
4627 * @return @c EINA_TRUE if @p obj widget's internal file
4628 * selector is only displaying directories, @c EINA_FALSE if files
4629 * are being displayed in it too (and on errors)
4631 * @see elm_fileselector_button_folder_only_set() for more details
4633 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4636 * Enable/disable the file name entry box where the user can type
4637 * in a name for a file, in a given file selector button widget's
4638 * internal file selector.
4640 * @param obj The file selector button widget
4641 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4642 * file selector a "saving dialog", @c EINA_FALSE otherwise
4644 * This has the same effect as elm_fileselector_is_save_set(),
4645 * but now applied to a file selector button's internal file
4648 * @see elm_fileselector_is_save_get()
4650 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4653 * Get whether the given file selector button widget's internal
4654 * file selector is in "saving dialog" mode
4656 * @param obj The file selector button widget
4657 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4658 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4661 * @see elm_fileselector_button_is_save_set() for more details
4663 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4666 * Set whether a given file selector button widget's internal file
4667 * selector will raise an Elementary "inner window", instead of a
4668 * dedicated Elementary window. By default, it won't.
4670 * @param obj The file selector button widget
4671 * @param value @c EINA_TRUE to make it use an inner window, @c
4672 * EINA_TRUE to make it use a dedicated window
4674 * @see elm_win_inwin_add() for more information on inner windows
4675 * @see elm_fileselector_button_inwin_mode_get()
4677 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4680 * Get whether a given file selector button widget's internal file
4681 * selector will raise an Elementary "inner window", instead of a
4682 * dedicated Elementary window.
4684 * @param obj The file selector button widget
4685 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4686 * if it will use a dedicated window
4688 * @see elm_fileselector_button_inwin_mode_set() for more details
4690 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4697 * @defgroup File_Selector_Entry File Selector Entry
4699 * @image html img/widget/fileselector_entry/preview-00.png
4700 * @image latex img/widget/fileselector_entry/preview-00.eps
4702 * This is an entry made to be filled with or display a <b>file
4703 * system path string</b>. Besides the entry itself, the widget has
4704 * a @ref File_Selector_Button "file selector button" on its side,
4705 * which will raise an internal @ref Fileselector "file selector widget",
4706 * when clicked, for path selection aided by file system
4709 * This file selector may appear in an Elementary window or in an
4710 * inner window. When a file is chosen from it, the (inner) window
4711 * is closed and the selected file's path string is exposed both as
4712 * an smart event and as the new text on the entry.
4714 * This widget encapsulates operations on its internal file
4715 * selector on its own API. There is less control over its file
4716 * selector than that one would have instatiating one directly.
4718 * Smart callbacks one can register to:
4719 * - @c "changed" - The text within the entry was changed
4720 * - @c "activated" - The entry has had editing finished and
4721 * changes are to be "committed"
4722 * - @c "press" - The entry has been clicked
4723 * - @c "longpressed" - The entry has been clicked (and held) for a
4725 * - @c "clicked" - The entry has been clicked
4726 * - @c "clicked,double" - The entry has been double clicked
4727 * - @c "focused" - The entry has received focus
4728 * - @c "unfocused" - The entry has lost focus
4729 * - @c "selection,paste" - A paste action has occurred on the
4731 * - @c "selection,copy" - A copy action has occurred on the entry
4732 * - @c "selection,cut" - A cut action has occurred on the entry
4733 * - @c "unpressed" - The file selector entry's button was released
4734 * after being pressed.
4735 * - @c "file,chosen" - The user has selected a path via the file
4736 * selector entry's internal file selector, whose string pointer
4737 * comes as the @c event_info data (a stringshared string)
4739 * Here is an example on its usage:
4740 * @li @ref fileselector_entry_example
4742 * @see @ref File_Selector_Button for a similar widget.
4747 * Add a new file selector entry widget to the given parent
4748 * Elementary (container) object
4750 * @param parent The parent object
4751 * @return a new file selector entry widget handle or @c NULL, on
4754 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4757 * Set the label for a given file selector entry widget's button
4759 * @param obj The file selector entry widget
4760 * @param label The text label to be displayed on @p obj widget's
4763 * @deprecated use elm_object_text_set() instead.
4765 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4768 * Get the label set for a given file selector entry widget's button
4770 * @param obj The file selector entry widget
4771 * @return The widget button's label
4773 * @deprecated use elm_object_text_set() instead.
4775 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4778 * Set the icon on a given file selector entry widget's button
4780 * @param obj The file selector entry widget
4781 * @param icon The icon object for the entry's button
4783 * Once the icon object is set, a previously set one will be
4784 * deleted. If you want to keep the latter, use the
4785 * elm_fileselector_entry_button_icon_unset() function.
4787 * @see elm_fileselector_entry_button_icon_get()
4789 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4792 * Get the icon set for a given file selector entry widget's button
4794 * @param obj The file selector entry widget
4795 * @return The icon object currently set on @p obj widget's button
4796 * or @c NULL, if none is
4798 * @see elm_fileselector_entry_button_icon_set()
4800 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4803 * Unset the icon used in a given file selector entry widget's
4806 * @param obj The file selector entry widget
4807 * @return The icon object that was being used on @p obj widget's
4808 * button or @c NULL, on errors
4810 * Unparent and return the icon object which was set for this
4813 * @see elm_fileselector_entry_button_icon_set()
4815 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4818 * Set the title for a given file selector entry widget's window
4820 * @param obj The file selector entry widget
4821 * @param title The title string
4823 * This will change the window's title, when the file selector pops
4824 * out after a click on the entry's button. Those windows have the
4825 * default (unlocalized) value of @c "Select a file" as titles.
4827 * @note It will only take any effect if the file selector
4828 * entry widget is @b not under "inwin mode".
4830 * @see elm_fileselector_entry_window_title_get()
4832 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4835 * Get the title set for a given file selector entry widget's
4838 * @param obj The file selector entry widget
4839 * @return Title of the file selector entry's window
4841 * @see elm_fileselector_entry_window_title_get() for more details
4843 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4846 * Set the size of a given file selector entry widget's window,
4847 * holding the file selector itself.
4849 * @param obj The file selector entry widget
4850 * @param width The window's width
4851 * @param height The window's height
4853 * @note it will only take any effect if the file selector entry
4854 * widget is @b not under "inwin mode". The default size for the
4855 * window (when applicable) is 400x400 pixels.
4857 * @see elm_fileselector_entry_window_size_get()
4859 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4862 * Get the size of a given file selector entry widget's window,
4863 * holding the file selector itself.
4865 * @param obj The file selector entry widget
4866 * @param width Pointer into which to store the width value
4867 * @param height Pointer into which to store the height value
4869 * @note Use @c NULL pointers on the size values you're not
4870 * interested in: they'll be ignored by the function.
4872 * @see elm_fileselector_entry_window_size_set(), for more details
4874 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4877 * Set the initial file system path and the entry's path string for
4878 * a given file selector entry widget
4880 * @param obj The file selector entry widget
4881 * @param path The path string
4883 * It must be a <b>directory</b> path, which will have the contents
4884 * displayed initially in the file selector's view, when invoked
4885 * from @p obj. The default initial path is the @c "HOME"
4886 * environment variable's value.
4888 * @see elm_fileselector_entry_path_get()
4890 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4893 * Get the entry's path string for a given file selector entry
4896 * @param obj The file selector entry widget
4897 * @return path The path string
4899 * @see elm_fileselector_entry_path_set() for more details
4901 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4904 * Enable/disable a tree view in the given file selector entry
4905 * widget's internal file selector
4907 * @param obj The file selector entry widget
4908 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4911 * This has the same effect as elm_fileselector_expandable_set(),
4912 * but now applied to a file selector entry's internal file
4915 * @note There's no way to put a file selector entry's internal
4916 * file selector in "grid mode", as one may do with "pure" file
4919 * @see elm_fileselector_expandable_get()
4921 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4924 * Get whether tree view is enabled for the given file selector
4925 * entry widget's internal file selector
4927 * @param obj The file selector entry widget
4928 * @return @c EINA_TRUE if @p obj widget's internal file selector
4929 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4931 * @see elm_fileselector_expandable_set() for more details
4933 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4936 * Set whether a given file selector entry widget's internal file
4937 * selector is to display folders only or the directory contents,
4940 * @param obj The file selector entry widget
4941 * @param only @c EINA_TRUE to make @p obj widget's internal file
4942 * selector only display directories, @c EINA_FALSE to make files
4943 * to be displayed in it too
4945 * This has the same effect as elm_fileselector_folder_only_set(),
4946 * but now applied to a file selector entry's internal file
4949 * @see elm_fileselector_folder_only_get()
4951 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4954 * Get whether a given file selector entry widget's internal file
4955 * selector is displaying folders only or the directory contents,
4958 * @param obj The file selector entry widget
4959 * @return @c EINA_TRUE if @p obj widget's internal file
4960 * selector is only displaying directories, @c EINA_FALSE if files
4961 * are being displayed in it too (and on errors)
4963 * @see elm_fileselector_entry_folder_only_set() for more details
4965 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4968 * Enable/disable the file name entry box where the user can type
4969 * in a name for a file, in a given file selector entry widget's
4970 * internal file selector.
4972 * @param obj The file selector entry widget
4973 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4974 * file selector a "saving dialog", @c EINA_FALSE otherwise
4976 * This has the same effect as elm_fileselector_is_save_set(),
4977 * but now applied to a file selector entry's internal file
4980 * @see elm_fileselector_is_save_get()
4982 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4985 * Get whether the given file selector entry widget's internal
4986 * file selector is in "saving dialog" mode
4988 * @param obj The file selector entry widget
4989 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4990 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4993 * @see elm_fileselector_entry_is_save_set() for more details
4995 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4998 * Set whether a given file selector entry widget's internal file
4999 * selector will raise an Elementary "inner window", instead of a
5000 * dedicated Elementary window. By default, it won't.
5002 * @param obj The file selector entry widget
5003 * @param value @c EINA_TRUE to make it use an inner window, @c
5004 * EINA_TRUE to make it use a dedicated window
5006 * @see elm_win_inwin_add() for more information on inner windows
5007 * @see elm_fileselector_entry_inwin_mode_get()
5009 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5012 * Get whether a given file selector entry widget's internal file
5013 * selector will raise an Elementary "inner window", instead of a
5014 * dedicated Elementary window.
5016 * @param obj The file selector entry widget
5017 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
5018 * if it will use a dedicated window
5020 * @see elm_fileselector_entry_inwin_mode_set() for more details
5022 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5025 * Set the initial file system path for a given file selector entry
5028 * @param obj The file selector entry widget
5029 * @param path The path string
5031 * It must be a <b>directory</b> path, which will have the contents
5032 * displayed initially in the file selector's view, when invoked
5033 * from @p obj. The default initial path is the @c "HOME"
5034 * environment variable's value.
5036 * @see elm_fileselector_entry_path_get()
5038 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5041 * Get the parent directory's path to the latest file selection on
5042 * a given filer selector entry widget
5044 * @param obj The file selector object
5045 * @return The (full) path of the directory of the last selection
5046 * on @p obj widget, a @b stringshared string
5048 * @see elm_fileselector_entry_path_set()
5050 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5057 * @defgroup Scroller Scroller
5059 * A scroller holds a single object and "scrolls it around". This means that
5060 * it allows the user to use a scrollbar (or a finger) to drag the viewable
5061 * region around, allowing to move through a much larger object that is
5062 * contained in the scroller. The scroiller will always have a small minimum
5063 * size by default as it won't be limited by the contents of the scroller.
5065 * Signals that you can add callbacks for are:
5066 * @li "edge,left" - the left edge of the content has been reached
5067 * @li "edge,right" - the right edge of the content has been reached
5068 * @li "edge,top" - the top edge of the content has been reached
5069 * @li "edge,bottom" - the bottom edge of the content has been reached
5070 * @li "scroll" - the content has been scrolled (moved)
5071 * @li "scroll,anim,start" - scrolling animation has started
5072 * @li "scroll,anim,stop" - scrolling animation has stopped
5073 * @li "scroll,drag,start" - dragging the contents around has started
5074 * @li "scroll,drag,stop" - dragging the contents around has stopped
5075 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
5078 * @note When Elemementary is in embedded mode the scrollbars will not be
5079 * dragable, they appear merely as indicators of how much has been scrolled.
5080 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
5081 * fingerscroll) won't work.
5083 * In @ref tutorial_scroller you'll find an example of how to use most of
5088 * @brief Type that controls when scrollbars should appear.
5090 * @see elm_scroller_policy_set()
5092 typedef enum _Elm_Scroller_Policy
5094 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
5095 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
5096 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
5097 ELM_SCROLLER_POLICY_LAST
5098 } Elm_Scroller_Policy;
5100 * @brief Add a new scroller to the parent
5102 * @param parent The parent object
5103 * @return The new object or NULL if it cannot be created
5105 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5107 * @brief Set the content of the scroller widget (the object to be scrolled around).
5109 * @param obj The scroller object
5110 * @param content The new content object
5112 * Once the content object is set, a previously set one will be deleted.
5113 * If you want to keep that old content object, use the
5114 * elm_scroller_content_unset() function.
5116 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5118 * @brief Get the content of the scroller widget
5120 * @param obj The slider object
5121 * @return The content that is being used
5123 * Return the content object which is set for this widget
5125 * @see elm_scroller_content_set()
5127 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5129 * @brief Unset the content of the scroller widget
5131 * @param obj The slider object
5132 * @return The content that was being used
5134 * Unparent and return the content object which was set for this widget
5136 * @see elm_scroller_content_set()
5138 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5140 * @brief Set custom theme elements for the scroller
5142 * @param obj The scroller object
5143 * @param widget The widget name to use (default is "scroller")
5144 * @param base The base name to use (default is "base")
5146 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5148 * @brief Make the scroller minimum size limited to the minimum size of the content
5150 * @param obj The scroller object
5151 * @param w Enable limiting minimum size horizontally
5152 * @param h Enable limiting minimum size vertically
5154 * By default the scroller will be as small as its design allows,
5155 * irrespective of its content. This will make the scroller minimum size the
5156 * right size horizontally and/or vertically to perfectly fit its content in
5159 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5161 * @brief Show a specific virtual region within the scroller content object
5163 * @param obj The scroller object
5164 * @param x X coordinate of the region
5165 * @param y Y coordinate of the region
5166 * @param w Width of the region
5167 * @param h Height of the region
5169 * This will ensure all (or part if it does not fit) of the designated
5170 * region in the virtual content object (0, 0 starting at the top-left of the
5171 * virtual content object) is shown within the scroller.
5173 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);
5175 * @brief Set the scrollbar visibility policy
5177 * @param obj The scroller object
5178 * @param policy_h Horizontal scrollbar policy
5179 * @param policy_v Vertical scrollbar policy
5181 * This sets the scrollbar visibility policy for the given scroller.
5182 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
5183 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
5184 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
5185 * respectively for the horizontal and vertical scrollbars.
5187 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5189 * @brief Gets scrollbar visibility policy
5191 * @param obj The scroller object
5192 * @param policy_h Horizontal scrollbar policy
5193 * @param policy_v Vertical scrollbar policy
5195 * @see elm_scroller_policy_set()
5197 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5199 * @brief Get the currently visible content region
5201 * @param obj The scroller object
5202 * @param x X coordinate of the region
5203 * @param y Y coordinate of the region
5204 * @param w Width of the region
5205 * @param h Height of the region
5207 * This gets the current region in the content object that is visible through
5208 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5209 * w, @p h values pointed to.
5211 * @note All coordinates are relative to the content.
5213 * @see elm_scroller_region_show()
5215 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);
5217 * @brief Get the size of the content object
5219 * @param obj The scroller object
5220 * @param w Width return
5221 * @param h Height return
5223 * This gets the size of the content object of the scroller.
5225 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5227 * @brief Set bouncing behavior
5229 * @param obj The scroller object
5230 * @param h_bounce Will the scroller bounce horizontally or not
5231 * @param v_bounce Will the scroller bounce vertically or not
5233 * When scrolling, the scroller may "bounce" when reaching an edge of the
5234 * content object. This is a visual way to indicate the end has been reached.
5235 * This is enabled by default for both axis. This will set if it is enabled
5236 * for that axis with the boolean parameters for each axis.
5238 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5240 * @brief Get the bounce mode
5242 * @param obj The Scroller object
5243 * @param h_bounce Allow bounce horizontally
5244 * @param v_bounce Allow bounce vertically
5246 * @see elm_scroller_bounce_set()
5248 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5250 * @brief Set scroll page size relative to viewport size.
5252 * @param obj The scroller object
5253 * @param h_pagerel The horizontal page relative size
5254 * @param v_pagerel The vertical page relative size
5256 * The scroller is capable of limiting scrolling by the user to "pages". That
5257 * is to jump by and only show a "whole page" at a time as if the continuous
5258 * area of the scroller content is split into page sized pieces. This sets
5259 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5260 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5261 * axis. This is mutually exclusive with page size
5262 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5263 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5264 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5267 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5269 * @brief Set scroll page size.
5271 * @param obj The scroller object
5272 * @param h_pagesize The horizontal page size
5273 * @param v_pagesize The vertical page size
5275 * This sets the page size to an absolute fixed value, with 0 turning it off
5278 * @see elm_scroller_page_relative_set()
5280 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5282 * @brief Show a specific virtual region within the scroller content object.
5284 * @param obj The scroller object
5285 * @param x X coordinate of the region
5286 * @param y Y coordinate of the region
5287 * @param w Width of the region
5288 * @param h Height of the region
5290 * This will ensure all (or part if it does not fit) of the designated
5291 * region in the virtual content object (0, 0 starting at the top-left of the
5292 * virtual content object) is shown within the scroller. Unlike
5293 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5294 * to this location (if configuration in general calls for transitions). It
5295 * may not jump immediately to the new location and make take a while and
5296 * show other content along the way.
5298 * @see elm_scroller_region_show()
5300 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);
5302 * @brief Set event propagation on a scroller
5304 * @param obj The scroller object
5305 * @param propagation If propagation is enabled or not
5307 * This enables or disabled event propagation from the scroller content to
5308 * the scroller and its parent. By default event propagation is disabled.
5310 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5312 * @brief Get event propagation for a scroller
5314 * @param obj The scroller object
5315 * @return The propagation state
5317 * This gets the event propagation for a scroller.
5319 * @see elm_scroller_propagate_events_set()
5321 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5327 * @defgroup Label Label
5329 * @image html img/widget/label/preview-00.png
5330 * @image latex img/widget/label/preview-00.eps
5332 * @brief Widget to display text, with simple html-like markup.
5334 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5335 * text doesn't fit the geometry of the label it will be ellipsized or be
5336 * cut. Elementary provides several themes for this widget:
5337 * @li default - No animation
5338 * @li marker - Centers the text in the label and make it bold by default
5339 * @li slide_long - The entire text appears from the right of the screen and
5340 * slides until it disappears in the left of the screen(reappering on the
5342 * @li slide_short - The text appears in the left of the label and slides to
5343 * the right to show the overflow. When all of the text has been shown the
5344 * position is reset.
5345 * @li slide_bounce - The text appears in the left of the label and slides to
5346 * the right to show the overflow. When all of the text has been shown the
5347 * animation reverses, moving the text to the left.
5349 * Custom themes can of course invent new markup tags and style them any way
5352 * See @ref tutorial_label for a demonstration of how to use a label widget.
5356 * @brief Add a new label to the parent
5358 * @param parent The parent object
5359 * @return The new object or NULL if it cannot be created
5361 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5363 * @brief Set the label on the label object
5365 * @param obj The label object
5366 * @param label The label will be used on the label object
5367 * @deprecated See elm_object_text_set()
5369 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 */
5371 * @brief Get the label used on the label object
5373 * @param obj The label object
5374 * @return The string inside the label
5375 * @deprecated See elm_object_text_get()
5377 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5379 * @brief Set the wrapping behavior of the label
5381 * @param obj The label object
5382 * @param wrap To wrap text or not
5384 * By default no wrapping is done. Possible values for @p wrap are:
5385 * @li ELM_WRAP_NONE - No wrapping
5386 * @li ELM_WRAP_CHAR - wrap between characters
5387 * @li ELM_WRAP_WORD - wrap between words
5388 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5390 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5392 * @brief Get the wrapping behavior of the label
5394 * @param obj The label object
5397 * @see elm_label_line_wrap_set()
5399 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5401 * @brief Set wrap width of the label
5403 * @param obj The label object
5404 * @param w The wrap width in pixels at a minimum where words need to wrap
5406 * This function sets the maximum width size hint of the label.
5408 * @warning This is only relevant if the label is inside a container.
5410 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5412 * @brief Get wrap width of the label
5414 * @param obj The label object
5415 * @return The wrap width in pixels at a minimum where words need to wrap
5417 * @see elm_label_wrap_width_set()
5419 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5421 * @brief Set wrap height of the label
5423 * @param obj The label object
5424 * @param h The wrap height in pixels at a minimum where words need to wrap
5426 * This function sets the maximum height size hint of the label.
5428 * @warning This is only relevant if the label is inside a container.
5430 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5432 * @brief get wrap width of the label
5434 * @param obj The label object
5435 * @return The wrap height in pixels at a minimum where words need to wrap
5437 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5439 * @brief Set the font size on the label object.
5441 * @param obj The label object
5442 * @param size font size
5444 * @warning NEVER use this. It is for hyper-special cases only. use styles
5445 * instead. e.g. "big", "medium", "small" - or better name them by use:
5446 * "title", "footnote", "quote" etc.
5448 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5450 * @brief Set the text color on the label object
5452 * @param obj The label object
5453 * @param r Red property background color of The label object
5454 * @param g Green property background color of The label object
5455 * @param b Blue property background color of The label object
5456 * @param a Alpha property background color of The label object
5458 * @warning NEVER use this. It is for hyper-special cases only. use styles
5459 * instead. e.g. "big", "medium", "small" - or better name them by use:
5460 * "title", "footnote", "quote" etc.
5462 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);
5464 * @brief Set the text align on the label object
5466 * @param obj The label object
5467 * @param align align mode ("left", "center", "right")
5469 * @warning NEVER use this. It is for hyper-special cases only. use styles
5470 * instead. e.g. "big", "medium", "small" - or better name them by use:
5471 * "title", "footnote", "quote" etc.
5473 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5475 * @brief Set background color of the label
5477 * @param obj The label object
5478 * @param r Red property background color of The label object
5479 * @param g Green property background color of The label object
5480 * @param b Blue property background color of The label object
5481 * @param a Alpha property background alpha of The label object
5483 * @warning NEVER use this. It is for hyper-special cases only. use styles
5484 * instead. e.g. "big", "medium", "small" - or better name them by use:
5485 * "title", "footnote", "quote" etc.
5487 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);
5489 * @brief Set the ellipsis behavior of the label
5491 * @param obj The label object
5492 * @param ellipsis To ellipsis text or not
5494 * If set to true and the text doesn't fit in the label an ellipsis("...")
5495 * will be shown at the end of the widget.
5497 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5498 * choosen wrap method was ELM_WRAP_WORD.
5500 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5502 * @brief Set the text slide of the label
5504 * @param obj The label object
5505 * @param slide To start slide or stop
5507 * If set to true the text of the label will slide throught the length of
5510 * @warning This only work with the themes "slide_short", "slide_long" and
5513 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5515 * @brief Get the text slide mode of the label
5517 * @param obj The label object
5518 * @return slide slide mode value
5520 * @see elm_label_slide_set()
5522 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5524 * @brief Set the slide duration(speed) of the label
5526 * @param obj The label object
5527 * @return The duration in seconds in moving text from slide begin position
5528 * to slide end position
5530 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5532 * @brief Get the slide duration(speed) of the label
5534 * @param obj The label object
5535 * @return The duration time in moving text from slide begin position to slide end position
5537 * @see elm_label_slide_duration_set()
5539 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5545 * @defgroup Toggle Toggle
5547 * @image html img/widget/toggle/preview-00.png
5548 * @image latex img/widget/toggle/preview-00.eps
5550 * @brief A toggle is a slider which can be used to toggle between
5551 * two values. It has two states: on and off.
5553 * Signals that you can add callbacks for are:
5554 * @li "changed" - Whenever the toggle value has been changed. Is not called
5555 * until the toggle is released by the cursor (assuming it
5556 * has been triggered by the cursor in the first place).
5558 * @ref tutorial_toggle show how to use a toggle.
5562 * @brief Add a toggle to @p parent.
5564 * @param parent The parent object
5566 * @return The toggle object
5568 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5570 * @brief Sets the label to be displayed with the toggle.
5572 * @param obj The toggle object
5573 * @param label The label to be displayed
5575 * @deprecated use elm_object_text_set() instead.
5577 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5579 * @brief Gets the label of the toggle
5581 * @param obj toggle object
5582 * @return The label of the toggle
5584 * @deprecated use elm_object_text_get() instead.
5586 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5588 * @brief Set the icon used for the toggle
5590 * @param obj The toggle object
5591 * @param icon The icon object for the button
5593 * Once the icon object is set, a previously set one will be deleted
5594 * If you want to keep that old content object, use the
5595 * elm_toggle_icon_unset() function.
5597 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5599 * @brief Get the icon used for the toggle
5601 * @param obj The toggle object
5602 * @return The icon object that is being used
5604 * Return the icon object which is set for this widget.
5606 * @see elm_toggle_icon_set()
5608 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610 * @brief Unset the icon used for the toggle
5612 * @param obj The toggle object
5613 * @return The icon object that was being used
5615 * Unparent and return the icon object which was set for this widget.
5617 * @see elm_toggle_icon_set()
5619 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5621 * @brief Sets the labels to be associated with the on and off states of the toggle.
5623 * @param obj The toggle object
5624 * @param onlabel The label displayed when the toggle is in the "on" state
5625 * @param offlabel The label displayed when the toggle is in the "off" state
5627 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5629 * @brief Gets the labels associated with the on and off states of the toggle.
5631 * @param obj The toggle object
5632 * @param onlabel A char** to place the onlabel of @p obj into
5633 * @param offlabel A char** to place the offlabel of @p obj into
5635 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5637 * @brief Sets the state of the toggle to @p state.
5639 * @param obj The toggle object
5640 * @param state The state of @p obj
5642 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5644 * @brief Gets the state of the toggle to @p state.
5646 * @param obj The toggle object
5647 * @return The state of @p obj
5649 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5651 * @brief Sets the state pointer of the toggle to @p statep.
5653 * @param obj The toggle object
5654 * @param statep The state pointer of @p obj
5656 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5662 * @defgroup Frame Frame
5664 * @image html img/widget/frame/preview-00.png
5665 * @image latex img/widget/frame/preview-00.eps
5667 * @brief Frame is a widget that holds some content and has a title.
5669 * The default look is a frame with a title, but Frame supports multple
5677 * @li outdent_bottom
5679 * Of all this styles only default shows the title. Frame emits no signals.
5681 * For a detailed example see the @ref tutorial_frame.
5686 * @brief Add a new frame to the parent
5688 * @param parent The parent object
5689 * @return The new object or NULL if it cannot be created
5691 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5693 * @brief Set the frame label
5695 * @param obj The frame object
5696 * @param label The label of this frame object
5698 * @deprecated use elm_object_text_set() instead.
5700 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5702 * @brief Get the frame label
5704 * @param obj The frame object
5706 * @return The label of this frame objet or NULL if unable to get frame
5708 * @deprecated use elm_object_text_get() instead.
5710 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5712 * @brief Set the content of the frame widget
5714 * Once the content object is set, a previously set one will be deleted.
5715 * If you want to keep that old content object, use the
5716 * elm_frame_content_unset() function.
5718 * @param obj The frame object
5719 * @param content The content will be filled in this frame object
5721 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5723 * @brief Get the content of the frame widget
5725 * Return the content object which is set for this widget
5727 * @param obj The frame object
5728 * @return The content that is being used
5730 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5732 * @brief Unset the content of the frame widget
5734 * Unparent and return the content object which was set for this widget
5736 * @param obj The frame object
5737 * @return The content that was being used
5739 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5745 * @defgroup Table Table
5747 * A container widget to arrange other widgets in a table where items can
5748 * also span multiple columns or rows - even overlap (and then be raised or
5749 * lowered accordingly to adjust stacking if they do overlap).
5751 * The followin are examples of how to use a table:
5752 * @li @ref tutorial_table_01
5753 * @li @ref tutorial_table_02
5758 * @brief Add a new table to the parent
5760 * @param parent The parent object
5761 * @return The new object or NULL if it cannot be created
5763 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5765 * @brief Set the homogeneous layout in the table
5767 * @param obj The layout object
5768 * @param homogeneous A boolean to set if the layout is homogeneous in the
5769 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5771 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5773 * @brief Get the current table homogeneous mode.
5775 * @param obj The table object
5776 * @return A boolean to indicating if the layout is homogeneous in the table
5777 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5779 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5781 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5783 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5785 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5787 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5789 * @brief Set padding between cells.
5791 * @param obj The layout object.
5792 * @param horizontal set the horizontal padding.
5793 * @param vertical set the vertical padding.
5795 * Default value is 0.
5797 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5799 * @brief Get padding between cells.
5801 * @param obj The layout object.
5802 * @param horizontal set the horizontal padding.
5803 * @param vertical set the vertical padding.
5805 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5807 * @brief Add a subobject on the table with the coordinates passed
5809 * @param obj The table object
5810 * @param subobj The subobject to be added to the table
5811 * @param x Row number
5812 * @param y Column number
5816 * @note All positioning inside the table is relative to rows and columns, so
5817 * a value of 0 for x and y, means the top left cell of the table, and a
5818 * value of 1 for w and h means @p subobj only takes that 1 cell.
5820 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5822 * @brief Remove child from table.
5824 * @param obj The table object
5825 * @param subobj The subobject
5827 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5829 * @brief Faster way to remove all child objects from a table object.
5831 * @param obj The table object
5832 * @param clear If true, will delete children, else just remove from table.
5834 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5836 * @brief Set the packing location of an existing child of the table
5838 * @param subobj The subobject to be modified in the table
5839 * @param x Row number
5840 * @param y Column number
5844 * Modifies the position of an object already in the table.
5846 * @note All positioning inside the table is relative to rows and columns, so
5847 * a value of 0 for x and y, means the top left cell of the table, and a
5848 * value of 1 for w and h means @p subobj only takes that 1 cell.
5850 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5852 * @brief Get the packing location of an existing child of the table
5854 * @param subobj The subobject to be modified in the table
5855 * @param x Row number
5856 * @param y Column number
5860 * @see elm_table_pack_set()
5862 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5868 * @defgroup Gengrid Gengrid (Generic grid)
5870 * This widget aims to position objects in a grid layout while
5871 * actually creating and rendering only the visible ones, using the
5872 * same idea as the @ref Genlist "genlist": the user defines a @b
5873 * class for each item, specifying functions that will be called at
5874 * object creation, deletion, etc. When those items are selected by
5875 * the user, a callback function is issued. Users may interact with
5876 * a gengrid via the mouse (by clicking on items to select them and
5877 * clicking on the grid's viewport and swiping to pan the whole
5878 * view) or via the keyboard, navigating through item with the
5881 * @section Gengrid_Layouts Gengrid layouts
5883 * Gengrids may layout its items in one of two possible layouts:
5887 * When in "horizontal mode", items will be placed in @b columns,
5888 * from top to bottom and, when the space for a column is filled,
5889 * another one is started on the right, thus expanding the grid
5890 * horizontally, making for horizontal scrolling. When in "vertical
5891 * mode" , though, items will be placed in @b rows, from left to
5892 * right and, when the space for a row is filled, another one is
5893 * started below, thus expanding the grid vertically (and making
5894 * for vertical scrolling).
5896 * @section Gengrid_Items Gengrid items
5898 * An item in a gengrid can have 0 or more text labels (they can be
5899 * regular text or textblock Evas objects - that's up to the style
5900 * to determine), 0 or more icons (which are simply objects
5901 * swallowed into the gengrid item's theming Edje object) and 0 or
5902 * more <b>boolean states</b>, which have the behavior left to the
5903 * user to define. The Edje part names for each of these properties
5904 * will be looked up, in the theme file for the gengrid, under the
5905 * Edje (string) data items named @c "labels", @c "icons" and @c
5906 * "states", respectively. For each of those properties, if more
5907 * than one part is provided, they must have names listed separated
5908 * by spaces in the data fields. For the default gengrid item
5909 * theme, we have @b one label part (@c "elm.text"), @b two icon
5910 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5913 * A gengrid item may be at one of several styles. Elementary
5914 * provides one by default - "default", but this can be extended by
5915 * system or application custom themes/overlays/extensions (see
5916 * @ref Theme "themes" for more details).
5918 * @section Gengrid_Item_Class Gengrid item classes
5920 * In order to have the ability to add and delete items on the fly,
5921 * gengrid implements a class (callback) system where the
5922 * application provides a structure with information about that
5923 * type of item (gengrid may contain multiple different items with
5924 * different classes, states and styles). Gengrid will call the
5925 * functions in this struct (methods) when an item is "realized"
5926 * (i.e., created dynamically, while the user is scrolling the
5927 * grid). All objects will simply be deleted when no longer needed
5928 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5929 * contains the following members:
5930 * - @c item_style - This is a constant string and simply defines
5931 * the name of the item style. It @b must be specified and the
5932 * default should be @c "default".
5933 * - @c func.label_get - This function is called when an item
5934 * object is actually created. The @c data parameter will point to
5935 * the same data passed to elm_gengrid_item_append() and related
5936 * item creation functions. The @c obj parameter is the gengrid
5937 * object itself, while the @c part one is the name string of one
5938 * of the existing text parts in the Edje group implementing the
5939 * item's theme. This function @b must return a strdup'()ed string,
5940 * as the caller will free() it when done. See
5941 * #Elm_Gengrid_Item_Label_Get_Cb.
5942 * - @c func.icon_get - This function is called when an item object
5943 * is actually created. The @c data parameter will point to the
5944 * same data passed to elm_gengrid_item_append() and related item
5945 * creation functions. The @c obj parameter is the gengrid object
5946 * itself, while the @c part one is the name string of one of the
5947 * existing (icon) swallow parts in the Edje group implementing the
5948 * item's theme. It must return @c NULL, when no icon is desired,
5949 * or a valid object handle, otherwise. The object will be deleted
5950 * by the gengrid on its deletion or when the item is "unrealized".
5951 * See #Elm_Gengrid_Item_Icon_Get_Cb.
5952 * - @c func.state_get - This function is called when an item
5953 * object is actually created. The @c data parameter will point to
5954 * the same data passed to elm_gengrid_item_append() and related
5955 * item creation functions. The @c obj parameter is the gengrid
5956 * object itself, while the @c part one is the name string of one
5957 * of the state parts in the Edje group implementing the item's
5958 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5959 * true/on. Gengrids will emit a signal to its theming Edje object
5960 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5961 * "source" arguments, respectively, when the state is true (the
5962 * default is false), where @c XXX is the name of the (state) part.
5963 * See #Elm_Gengrid_Item_State_Get_Cb.
5964 * - @c func.del - This is called when elm_gengrid_item_del() is
5965 * called on an item or elm_gengrid_clear() is called on the
5966 * gengrid. This is intended for use when gengrid items are
5967 * deleted, so any data attached to the item (e.g. its data
5968 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
5970 * @section Gengrid_Usage_Hints Usage hints
5972 * If the user wants to have multiple items selected at the same
5973 * time, elm_gengrid_multi_select_set() will permit it. If the
5974 * gengrid is single-selection only (the default), then
5975 * elm_gengrid_select_item_get() will return the selected item or
5976 * @c NULL, if none is selected. If the gengrid is under
5977 * multi-selection, then elm_gengrid_selected_items_get() will
5978 * return a list (that is only valid as long as no items are
5979 * modified (added, deleted, selected or unselected) of child items
5982 * If an item changes (internal (boolean) state, label or icon
5983 * changes), then use elm_gengrid_item_update() to have gengrid
5984 * update the item with the new state. A gengrid will re-"realize"
5985 * the item, thus calling the functions in the
5986 * #Elm_Gengrid_Item_Class set for that item.
5988 * To programmatically (un)select an item, use
5989 * elm_gengrid_item_selected_set(). To get its selected state use
5990 * elm_gengrid_item_selected_get(). To make an item disabled
5991 * (unable to be selected and appear differently) use
5992 * elm_gengrid_item_disabled_set() to set this and
5993 * elm_gengrid_item_disabled_get() to get the disabled state.
5995 * Grid cells will only have their selection smart callbacks called
5996 * when firstly getting selected. Any further clicks will do
5997 * nothing, unless you enable the "always select mode", with
5998 * elm_gengrid_always_select_mode_set(), thus making every click to
5999 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
6000 * turn off the ability to select items entirely in the widget and
6001 * they will neither appear selected nor call the selection smart
6004 * Remember that you can create new styles and add your own theme
6005 * augmentation per application with elm_theme_extension_add(). If
6006 * you absolutely must have a specific style that overrides any
6007 * theme the user or system sets up you can use
6008 * elm_theme_overlay_add() to add such a file.
6010 * @section Gengrid_Smart_Events Gengrid smart events
6012 * Smart events that you can add callbacks for are:
6013 * - @c "activated" - The user has double-clicked or pressed
6014 * (enter|return|spacebar) on an item. The @c event_info parameter
6015 * is the gengrid item that was activated.
6016 * - @c "clicked,double" - The user has double-clicked an item.
6017 * The @c event_info parameter is the gengrid item that was double-clicked.
6018 * - @c "selected" - The user has made an item selected. The
6019 * @c event_info parameter is the gengrid item that was selected.
6020 * - @c "unselected" - The user has made an item unselected. The
6021 * @c event_info parameter is the gengrid item that was unselected.
6022 * - @c "realized" - This is called when the item in the gengrid
6023 * has its implementing Evas object instantiated, de facto. @c
6024 * event_info is the gengrid item that was created. The object
6025 * may be deleted at any time, so it is highly advised to the
6026 * caller @b not to use the object pointer returned from
6027 * elm_gengrid_item_object_get(), because it may point to freed
6029 * - @c "unrealized" - This is called when the implementing Evas
6030 * object for this item is deleted. @c event_info is the gengrid
6031 * item that was deleted.
6032 * - @c "changed" - Called when an item is added, removed, resized
6033 * or moved and when the gengrid is resized or gets "horizontal"
6035 * - @c "drag,start,up" - Called when the item in the gengrid has
6036 * been dragged (not scrolled) up.
6037 * - @c "drag,start,down" - Called when the item in the gengrid has
6038 * been dragged (not scrolled) down.
6039 * - @c "drag,start,left" - Called when the item in the gengrid has
6040 * been dragged (not scrolled) left.
6041 * - @c "drag,start,right" - Called when the item in the gengrid has
6042 * been dragged (not scrolled) right.
6043 * - @c "drag,stop" - Called when the item in the gengrid has
6044 * stopped being dragged.
6045 * - @c "drag" - Called when the item in the gengrid is being
6047 * - @c "scroll" - called when the content has been scrolled
6049 * - @c "scroll,drag,start" - called when dragging the content has
6051 * - @c "scroll,drag,stop" - called when dragging the content has
6054 * List of gendrid examples:
6055 * @li @ref gengrid_example
6059 * @addtogroup Gengrid
6063 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
6064 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
6065 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
6066 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
6067 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. */
6068 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. */
6069 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
6071 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
6072 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
6073 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
6074 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
6077 * @struct _Elm_Gengrid_Item_Class
6079 * Gengrid item class definition. See @ref Gengrid_Item_Class for
6082 struct _Elm_Gengrid_Item_Class
6084 const char *item_style;
6085 struct _Elm_Gengrid_Item_Class_Func
6087 Elm_Gengrid_Item_Label_Get_Cb label_get;
6088 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
6089 Elm_Gengrid_Item_State_Get_Cb state_get;
6090 Elm_Gengrid_Item_Del_Cb del;
6092 }; /**< #Elm_Gengrid_Item_Class member definitions */
6095 * Add a new gengrid widget to the given parent Elementary
6096 * (container) object
6098 * @param parent The parent object
6099 * @return a new gengrid widget handle or @c NULL, on errors
6101 * This function inserts a new gengrid widget on the canvas.
6103 * @see elm_gengrid_item_size_set()
6104 * @see elm_gengrid_horizontal_set()
6105 * @see elm_gengrid_item_append()
6106 * @see elm_gengrid_item_del()
6107 * @see elm_gengrid_clear()
6111 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6114 * Set the size for the items of a given gengrid widget
6116 * @param obj The gengrid object.
6117 * @param w The items' width.
6118 * @param h The items' height;
6120 * A gengrid, after creation, has still no information on the size
6121 * to give to each of its cells. So, you most probably will end up
6122 * with squares one @ref Fingers "finger" wide, the default
6123 * size. Use this function to force a custom size for you items,
6124 * making them as big as you wish.
6126 * @see elm_gengrid_item_size_get()
6130 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6133 * Get the size set for the items of a given gengrid widget
6135 * @param obj The gengrid object.
6136 * @param w Pointer to a variable where to store the items' width.
6137 * @param h Pointer to a variable where to store the items' height.
6139 * @note Use @c NULL pointers on the size values you're not
6140 * interested in: they'll be ignored by the function.
6142 * @see elm_gengrid_item_size_get() for more details
6146 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6149 * Set the items grid's alignment within a given gengrid widget
6151 * @param obj The gengrid object.
6152 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
6153 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
6155 * This sets the alignment of the whole grid of items of a gengrid
6156 * within its given viewport. By default, those values are both
6157 * 0.5, meaning that the gengrid will have its items grid placed
6158 * exactly in the middle of its viewport.
6160 * @note If given alignment values are out of the cited ranges,
6161 * they'll be changed to the nearest boundary values on the valid
6164 * @see elm_gengrid_align_get()
6168 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
6171 * Get the items grid's alignment values within a given gengrid
6174 * @param obj The gengrid object.
6175 * @param align_x Pointer to a variable where to store the
6176 * horizontal alignment.
6177 * @param align_y Pointer to a variable where to store the vertical
6180 * @note Use @c NULL pointers on the alignment values you're not
6181 * interested in: they'll be ignored by the function.
6183 * @see elm_gengrid_align_set() for more details
6187 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
6190 * Set whether a given gengrid widget is or not able have items
6193 * @param obj The gengrid object
6194 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
6195 * @c EINA_FALSE to turn it off
6197 * If a gengrid is set to allow reordering, a click held for more
6198 * than 0.5 over a given item will highlight it specially,
6199 * signalling the gengrid has entered the reordering state. From
6200 * that time on, the user will be able to, while still holding the
6201 * mouse button down, move the item freely in the gengrid's
6202 * viewport, replacing to said item to the locations it goes to.
6203 * The replacements will be animated and, whenever the user
6204 * releases the mouse button, the item being replaced gets a new
6205 * definitive place in the grid.
6207 * @see elm_gengrid_reorder_mode_get()
6211 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6214 * Get whether a given gengrid widget is or not able have items
6217 * @param obj The gengrid object
6218 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6221 * @see elm_gengrid_reorder_mode_set() for more details
6225 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6228 * Append a new item in a given gengrid widget.
6230 * @param obj The gengrid object.
6231 * @param gic The item class for the item.
6232 * @param data The item data.
6233 * @param func Convenience function called when the item is
6235 * @param func_data Data to be passed to @p func.
6236 * @return A handle to the item added or @c NULL, on errors.
6238 * This adds an item to the beginning of the gengrid.
6240 * @see elm_gengrid_item_prepend()
6241 * @see elm_gengrid_item_insert_before()
6242 * @see elm_gengrid_item_insert_after()
6243 * @see elm_gengrid_item_del()
6247 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);
6250 * Prepend a new item in a given gengrid widget.
6252 * @param obj The gengrid object.
6253 * @param gic The item class for the item.
6254 * @param data The item data.
6255 * @param func Convenience function called when the item is
6257 * @param func_data Data to be passed to @p func.
6258 * @return A handle to the item added or @c NULL, on errors.
6260 * This adds an item to the end of the gengrid.
6262 * @see elm_gengrid_item_append()
6263 * @see elm_gengrid_item_insert_before()
6264 * @see elm_gengrid_item_insert_after()
6265 * @see elm_gengrid_item_del()
6269 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);
6272 * Insert an item before another in a gengrid widget
6274 * @param obj The gengrid object.
6275 * @param gic The item class for the item.
6276 * @param data The item data.
6277 * @param relative The item to place this new one before.
6278 * @param func Convenience function called when the item is
6280 * @param func_data Data to be passed to @p func.
6281 * @return A handle to the item added or @c NULL, on errors.
6283 * This inserts an item before another in the gengrid.
6285 * @see elm_gengrid_item_append()
6286 * @see elm_gengrid_item_prepend()
6287 * @see elm_gengrid_item_insert_after()
6288 * @see elm_gengrid_item_del()
6292 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);
6295 * Insert an item after another in a gengrid widget
6297 * @param obj The gengrid object.
6298 * @param gic The item class for the item.
6299 * @param data The item data.
6300 * @param relative The item to place this new one after.
6301 * @param func Convenience function called when the item is
6303 * @param func_data Data to be passed to @p func.
6304 * @return A handle to the item added or @c NULL, on errors.
6306 * This inserts an item after another in the gengrid.
6308 * @see elm_gengrid_item_append()
6309 * @see elm_gengrid_item_prepend()
6310 * @see elm_gengrid_item_insert_after()
6311 * @see elm_gengrid_item_del()
6315 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);
6317 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);
6319 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);
6322 * Set whether items on a given gengrid widget are to get their
6323 * selection callbacks issued for @b every subsequent selection
6324 * click on them or just for the first click.
6326 * @param obj The gengrid object
6327 * @param always_select @c EINA_TRUE to make items "always
6328 * selected", @c EINA_FALSE, otherwise
6330 * By default, grid items will only call their selection callback
6331 * function when firstly getting selected, any subsequent further
6332 * clicks will do nothing. With this call, you make those
6333 * subsequent clicks also to issue the selection callbacks.
6335 * @note <b>Double clicks</b> will @b always be reported on items.
6337 * @see elm_gengrid_always_select_mode_get()
6341 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6344 * Get whether items on a given gengrid widget have their selection
6345 * callbacks issued for @b every subsequent selection click on them
6346 * or just for the first click.
6348 * @param obj The gengrid object.
6349 * @return @c EINA_TRUE if the gengrid items are "always selected",
6350 * @c EINA_FALSE, otherwise
6352 * @see elm_gengrid_always_select_mode_set() for more details
6356 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6359 * Set whether items on a given gengrid widget can be selected or not.
6361 * @param obj The gengrid object
6362 * @param no_select @c EINA_TRUE to make items selectable,
6363 * @c EINA_FALSE otherwise
6365 * This will make items in @p obj selectable or not. In the latter
6366 * case, any user interacion on the gendrid items will neither make
6367 * them appear selected nor them call their selection callback
6370 * @see elm_gengrid_no_select_mode_get()
6374 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6377 * Get whether items on a given gengrid widget can be selected or
6380 * @param obj The gengrid object
6381 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6384 * @see elm_gengrid_no_select_mode_set() for more details
6388 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6391 * Enable or disable multi-selection in a given gengrid widget
6393 * @param obj The gengrid object.
6394 * @param multi @c EINA_TRUE, to enable multi-selection,
6395 * @c EINA_FALSE to disable it.
6397 * Multi-selection is the ability for one to have @b more than one
6398 * item selected, on a given gengrid, simultaneously. When it is
6399 * enabled, a sequence of clicks on different items will make them
6400 * all selected, progressively. A click on an already selected item
6401 * will unselect it. If interecting via the keyboard,
6402 * multi-selection is enabled while holding the "Shift" key.
6404 * @note By default, multi-selection is @b disabled on gengrids
6406 * @see elm_gengrid_multi_select_get()
6410 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6413 * Get whether multi-selection is enabled or disabled for a given
6416 * @param obj The gengrid object.
6417 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6418 * EINA_FALSE otherwise
6420 * @see elm_gengrid_multi_select_set() for more details
6424 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6427 * Enable or disable bouncing effect for a given gengrid widget
6429 * @param obj The gengrid object
6430 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6431 * @c EINA_FALSE to disable it
6432 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6433 * @c EINA_FALSE to disable it
6435 * The bouncing effect occurs whenever one reaches the gengrid's
6436 * edge's while panning it -- it will scroll past its limits a
6437 * little bit and return to the edge again, in a animated for,
6440 * @note By default, gengrids have bouncing enabled on both axis
6442 * @see elm_gengrid_bounce_get()
6446 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6449 * Get whether bouncing effects are enabled or disabled, for a
6450 * given gengrid widget, on each axis
6452 * @param obj The gengrid object
6453 * @param h_bounce Pointer to a variable where to store the
6454 * horizontal bouncing flag.
6455 * @param v_bounce Pointer to a variable where to store the
6456 * vertical bouncing flag.
6458 * @see elm_gengrid_bounce_set() for more details
6462 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6465 * Set a given gengrid widget's scrolling page size, relative to
6466 * its viewport size.
6468 * @param obj The gengrid object
6469 * @param h_pagerel The horizontal page (relative) size
6470 * @param v_pagerel The vertical page (relative) size
6472 * The gengrid's scroller is capable of binding scrolling by the
6473 * user to "pages". It means that, while scrolling and, specially
6474 * after releasing the mouse button, the grid will @b snap to the
6475 * nearest displaying page's area. When page sizes are set, the
6476 * grid's continuous content area is split into (equal) page sized
6479 * This function sets the size of a page <b>relatively to the
6480 * viewport dimensions</b> of the gengrid, for each axis. A value
6481 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6482 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6483 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6484 * 1.0. Values beyond those will make it behave behave
6485 * inconsistently. If you only want one axis to snap to pages, use
6486 * the value @c 0.0 for the other one.
6488 * There is a function setting page size values in @b absolute
6489 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6490 * is mutually exclusive to this one.
6492 * @see elm_gengrid_page_relative_get()
6496 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6499 * Get a given gengrid widget's scrolling page size, relative to
6500 * its viewport size.
6502 * @param obj The gengrid object
6503 * @param h_pagerel Pointer to a variable where to store the
6504 * horizontal page (relative) size
6505 * @param v_pagerel Pointer to a variable where to store the
6506 * vertical page (relative) size
6508 * @see elm_gengrid_page_relative_set() for more details
6512 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6515 * Set a given gengrid widget's scrolling page size
6517 * @param obj The gengrid object
6518 * @param h_pagerel The horizontal page size, in pixels
6519 * @param v_pagerel The vertical page size, in pixels
6521 * The gengrid's scroller is capable of binding scrolling by the
6522 * user to "pages". It means that, while scrolling and, specially
6523 * after releasing the mouse button, the grid will @b snap to the
6524 * nearest displaying page's area. When page sizes are set, the
6525 * grid's continuous content area is split into (equal) page sized
6528 * This function sets the size of a page of the gengrid, in pixels,
6529 * for each axis. Sane usable values are, between @c 0 and the
6530 * dimensions of @p obj, for each axis. Values beyond those will
6531 * make it behave behave inconsistently. If you only want one axis
6532 * to snap to pages, use the value @c 0 for the other one.
6534 * There is a function setting page size values in @b relative
6535 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6536 * use is mutually exclusive to this one.
6540 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6543 * Set for what direction a given gengrid widget will expand while
6544 * placing its items.
6546 * @param obj The gengrid object.
6547 * @param setting @c EINA_TRUE to make the gengrid expand
6548 * horizontally, @c EINA_FALSE to expand vertically.
6550 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6551 * in @b columns, from top to bottom and, when the space for a
6552 * column is filled, another one is started on the right, thus
6553 * expanding the grid horizontally. When in "vertical mode"
6554 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6555 * to right and, when the space for a row is filled, another one is
6556 * started below, thus expanding the grid vertically.
6558 * @see elm_gengrid_horizontal_get()
6562 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6565 * Get for what direction a given gengrid widget will expand while
6566 * placing its items.
6568 * @param obj The gengrid object.
6569 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6570 * @c EINA_FALSE if it's set to expand vertically.
6572 * @see elm_gengrid_horizontal_set() for more detais
6576 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6579 * Get the first item in a given gengrid widget
6581 * @param obj The gengrid object
6582 * @return The first item's handle or @c NULL, if there are no
6583 * items in @p obj (and on errors)
6585 * This returns the first item in the @p obj's internal list of
6588 * @see elm_gengrid_last_item_get()
6592 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6595 * Get the last item in a given gengrid widget
6597 * @param obj The gengrid object
6598 * @return The last item's handle or @c NULL, if there are no
6599 * items in @p obj (and on errors)
6601 * This returns the last item in the @p obj's internal list of
6604 * @see elm_gengrid_first_item_get()
6608 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6611 * Get the @b next item in a gengrid widget's internal list of items,
6612 * given a handle to one of those items.
6614 * @param item The gengrid item to fetch next from
6615 * @return The item after @p item, or @c NULL if there's none (and
6618 * This returns the item placed after the @p item, on the container
6621 * @see elm_gengrid_item_prev_get()
6625 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6628 * Get the @b previous item in a gengrid widget's internal list of items,
6629 * given a handle to one of those items.
6631 * @param item The gengrid item to fetch previous from
6632 * @return The item before @p item, or @c NULL if there's none (and
6635 * This returns the item placed before the @p item, on the container
6638 * @see elm_gengrid_item_next_get()
6642 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6645 * Get the gengrid object's handle which contains a given gengrid
6648 * @param item The item to fetch the container from
6649 * @return The gengrid (parent) object
6651 * This returns the gengrid object itself that an item belongs to.
6655 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6658 * Remove a gengrid item from the its parent, deleting it.
6660 * @param item The item to be removed.
6661 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6663 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6668 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6671 * Update the contents of a given gengrid item
6673 * @param item The gengrid item
6675 * This updates an item by calling all the item class functions
6676 * again to get the icons, labels and states. Use this when the
6677 * original item data has changed and you want thta changes to be
6682 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6683 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6684 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6687 * Return the data associated to a given gengrid item
6689 * @param item The gengrid item.
6690 * @return the data associated to this item.
6692 * This returns the @c data value passed on the
6693 * elm_gengrid_item_append() and related item addition calls.
6695 * @see elm_gengrid_item_append()
6696 * @see elm_gengrid_item_data_set()
6700 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6703 * Set the data associated to a given gengrid item
6705 * @param item The gengrid item
6706 * @param data The new data pointer to set on it
6708 * This @b overrides the @c data value passed on the
6709 * elm_gengrid_item_append() and related item addition calls. This
6710 * function @b won't call elm_gengrid_item_update() automatically,
6711 * so you'd issue it afterwards if you want to hove the item
6712 * updated to reflect the that new data.
6714 * @see elm_gengrid_item_data_get()
6718 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6721 * Get a given gengrid item's position, relative to the whole
6722 * gengrid's grid area.
6724 * @param item The Gengrid item.
6725 * @param x Pointer to variable where to store the item's <b>row
6727 * @param y Pointer to variable where to store the item's <b>column
6730 * This returns the "logical" position of the item whithin the
6731 * gengrid. For example, @c (0, 1) would stand for first row,
6736 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6739 * Set whether a given gengrid item is selected or not
6741 * @param item The gengrid item
6742 * @param selected Use @c EINA_TRUE, to make it selected, @c
6743 * EINA_FALSE to make it unselected
6745 * This sets the selected state of an item. If multi selection is
6746 * not enabled on the containing gengrid and @p selected is @c
6747 * EINA_TRUE, any other previously selected items will get
6748 * unselected in favor of this new one.
6750 * @see elm_gengrid_item_selected_get()
6754 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6757 * Get whether a given gengrid item is selected or not
6759 * @param item The gengrid item
6760 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6762 * @see elm_gengrid_item_selected_set() for more details
6766 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6769 * Get the real Evas object created to implement the view of a
6770 * given gengrid item
6772 * @param item The gengrid item.
6773 * @return the Evas object implementing this item's view.
6775 * This returns the actual Evas object used to implement the
6776 * specified gengrid item's view. This may be @c NULL, as it may
6777 * not have been created or may have been deleted, at any time, by
6778 * the gengrid. <b>Do not modify this object</b> (move, resize,
6779 * show, hide, etc.), as the gengrid is controlling it. This
6780 * function is for querying, emitting custom signals or hooking
6781 * lower level callbacks for events on that object. Do not delete
6782 * this object under any circumstances.
6784 * @see elm_gengrid_item_data_get()
6788 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6791 * Show the portion of a gengrid's internal grid containing a given
6792 * item, @b immediately.
6794 * @param item The item to display
6796 * This causes gengrid to @b redraw its viewport's contents to the
6797 * region contining the given @p item item, if it is not fully
6800 * @see elm_gengrid_item_bring_in()
6804 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6807 * Animatedly bring in, to the visible are of a gengrid, a given
6810 * @param item The gengrid item to display
6812 * This causes gengrig to jump to the given @p item item and show
6813 * it (by scrolling), if it is not fully visible. This will use
6814 * animation to do so and take a period of time to complete.
6816 * @see elm_gengrid_item_show()
6820 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6823 * Set whether a given gengrid item is disabled or not.
6825 * @param item The gengrid item
6826 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6827 * to enable it back.
6829 * A disabled item cannot be selected or unselected. It will also
6830 * change its appearance, to signal the user it's disabled.
6832 * @see elm_gengrid_item_disabled_get()
6836 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6839 * Get whether a given gengrid item is disabled or not.
6841 * @param item The gengrid item
6842 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6845 * @see elm_gengrid_item_disabled_set() for more details
6849 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6852 * Set the text to be shown in a given gengrid item's tooltips.
6854 * @param item The gengrid item
6855 * @param text The text to set in the content
6857 * This call will setup the text to be used as tooltip to that item
6858 * (analogous to elm_object_tooltip_text_set(), but being item
6859 * tooltips with higher precedence than object tooltips). It can
6860 * have only one tooltip at a time, so any previous tooltip data
6865 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6868 * Set the content to be shown in a given gengrid item's tooltips
6870 * @param item The gengrid item.
6871 * @param func The function returning the tooltip contents.
6872 * @param data What to provide to @a func as callback data/context.
6873 * @param del_cb Called when data is not needed anymore, either when
6874 * another callback replaces @p func, the tooltip is unset with
6875 * elm_gengrid_item_tooltip_unset() or the owner @p item
6876 * dies. This callback receives as its first parameter the
6877 * given @p data, being @c event_info the item handle.
6879 * This call will setup the tooltip's contents to @p item
6880 * (analogous to elm_object_tooltip_content_cb_set(), but being
6881 * item tooltips with higher precedence than object tooltips). It
6882 * can have only one tooltip at a time, so any previous tooltip
6883 * content will get removed. @p func (with @p data) will be called
6884 * every time Elementary needs to show the tooltip and it should
6885 * return a valid Evas object, which will be fully managed by the
6886 * tooltip system, getting deleted when the tooltip is gone.
6890 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);
6893 * Unset a tooltip from a given gengrid item
6895 * @param item gengrid item to remove a previously set tooltip from.
6897 * This call removes any tooltip set on @p item. The callback
6898 * provided as @c del_cb to
6899 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6900 * notify it is not used anymore (and have resources cleaned, if
6903 * @see elm_gengrid_item_tooltip_content_cb_set()
6907 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6910 * Set a different @b style for a given gengrid item's tooltip.
6912 * @param item gengrid item with tooltip set
6913 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6914 * "default", @c "transparent", etc)
6916 * Tooltips can have <b>alternate styles</b> to be displayed on,
6917 * which are defined by the theme set on Elementary. This function
6918 * works analogously as elm_object_tooltip_style_set(), but here
6919 * applied only to gengrid item objects. The default style for
6920 * tooltips is @c "default".
6922 * @note before you set a style you should define a tooltip with
6923 * elm_gengrid_item_tooltip_content_cb_set() or
6924 * elm_gengrid_item_tooltip_text_set()
6926 * @see elm_gengrid_item_tooltip_style_get()
6930 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6933 * Get the style set a given gengrid item's tooltip.
6935 * @param item gengrid item with tooltip already set on.
6936 * @return style the theme style in use, which defaults to
6937 * "default". If the object does not have a tooltip set,
6938 * then @c NULL is returned.
6940 * @see elm_gengrid_item_tooltip_style_set() for more details
6944 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6946 * @brief Disable size restrictions on an object's tooltip
6947 * @param item The tooltip's anchor object
6948 * @param disable If EINA_TRUE, size restrictions are disabled
6949 * @return EINA_FALSE on failure, EINA_TRUE on success
6951 * This function allows a tooltip to expand beyond its parant window's canvas.
6952 * It will instead be limited only by the size of the display.
6954 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6956 * @brief Retrieve size restriction state of an object's tooltip
6957 * @param item The tooltip's anchor object
6958 * @return If EINA_TRUE, size restrictions are disabled
6960 * This function returns whether a tooltip is allowed to expand beyond
6961 * its parant window's canvas.
6962 * It will instead be limited only by the size of the display.
6964 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6966 * Set the type of mouse pointer/cursor decoration to be shown,
6967 * when the mouse pointer is over the given gengrid widget item
6969 * @param item gengrid item to customize cursor on
6970 * @param cursor the cursor type's name
6972 * This function works analogously as elm_object_cursor_set(), but
6973 * here the cursor's changing area is restricted to the item's
6974 * area, and not the whole widget's. Note that that item cursors
6975 * have precedence over widget cursors, so that a mouse over @p
6976 * item will always show cursor @p type.
6978 * If this function is called twice for an object, a previously set
6979 * cursor will be unset on the second call.
6981 * @see elm_object_cursor_set()
6982 * @see elm_gengrid_item_cursor_get()
6983 * @see elm_gengrid_item_cursor_unset()
6987 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6990 * Get the type of mouse pointer/cursor decoration set to be shown,
6991 * when the mouse pointer is over the given gengrid widget item
6993 * @param item gengrid item with custom cursor set
6994 * @return the cursor type's name or @c NULL, if no custom cursors
6995 * were set to @p item (and on errors)
6997 * @see elm_object_cursor_get()
6998 * @see elm_gengrid_item_cursor_set() for more details
6999 * @see elm_gengrid_item_cursor_unset()
7003 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7006 * Unset any custom mouse pointer/cursor decoration set to be
7007 * shown, when the mouse pointer is over the given gengrid widget
7008 * item, thus making it show the @b default cursor again.
7010 * @param item a gengrid item
7012 * Use this call to undo any custom settings on this item's cursor
7013 * decoration, bringing it back to defaults (no custom style set).
7015 * @see elm_object_cursor_unset()
7016 * @see elm_gengrid_item_cursor_set() for more details
7020 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7023 * Set a different @b style for a given custom cursor set for a
7026 * @param item gengrid item with custom cursor set
7027 * @param style the <b>theme style</b> to use (e.g. @c "default",
7028 * @c "transparent", etc)
7030 * This function only makes sense when one is using custom mouse
7031 * cursor decorations <b>defined in a theme file</b> , which can
7032 * have, given a cursor name/type, <b>alternate styles</b> on
7033 * it. It works analogously as elm_object_cursor_style_set(), but
7034 * here applied only to gengrid item objects.
7036 * @warning Before you set a cursor style you should have defined a
7037 * custom cursor previously on the item, with
7038 * elm_gengrid_item_cursor_set()
7040 * @see elm_gengrid_item_cursor_engine_only_set()
7041 * @see elm_gengrid_item_cursor_style_get()
7045 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
7048 * Get the current @b style set for a given gengrid item's custom
7051 * @param item gengrid item with custom cursor set.
7052 * @return style the cursor style in use. If the object does not
7053 * have a cursor set, then @c NULL is returned.
7055 * @see elm_gengrid_item_cursor_style_set() for more details
7059 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7062 * Set if the (custom) cursor for a given gengrid item should be
7063 * searched in its theme, also, or should only rely on the
7066 * @param item item with custom (custom) cursor already set on
7067 * @param engine_only Use @c EINA_TRUE to have cursors looked for
7068 * only on those provided by the rendering engine, @c EINA_FALSE to
7069 * have them searched on the widget's theme, as well.
7071 * @note This call is of use only if you've set a custom cursor
7072 * for gengrid items, with elm_gengrid_item_cursor_set().
7074 * @note By default, cursors will only be looked for between those
7075 * provided by the rendering engine.
7079 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7082 * Get if the (custom) cursor for a given gengrid item is being
7083 * searched in its theme, also, or is only relying on the rendering
7086 * @param item a gengrid item
7087 * @return @c EINA_TRUE, if cursors are being looked for only on
7088 * those provided by the rendering engine, @c EINA_FALSE if they
7089 * are being searched on the widget's theme, as well.
7091 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
7095 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7098 * Remove all items from a given gengrid widget
7100 * @param obj The gengrid object.
7102 * This removes (and deletes) all items in @p obj, leaving it
7105 * @see elm_gengrid_item_del(), to remove just one item.
7109 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7112 * Get the selected item in a given gengrid widget
7114 * @param obj The gengrid object.
7115 * @return The selected item's handleor @c NULL, if none is
7116 * selected at the moment (and on errors)
7118 * This returns the selected item in @p obj. If multi selection is
7119 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
7120 * the first item in the list is selected, which might not be very
7121 * useful. For that case, see elm_gengrid_selected_items_get().
7125 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7128 * Get <b>a list</b> of selected items in a given gengrid
7130 * @param obj The gengrid object.
7131 * @return The list of selected items or @c NULL, if none is
7132 * selected at the moment (and on errors)
7134 * This returns a list of the selected items, in the order that
7135 * they appear in the grid. This list is only valid as long as no
7136 * more items are selected or unselected (or unselected implictly
7137 * by deletion). The list contains #Elm_Gengrid_Item pointers as
7140 * @see elm_gengrid_selected_item_get()
7144 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7151 * @defgroup Clock Clock
7153 * @image html img/widget/clock/preview-00.png
7154 * @image latex img/widget/clock/preview-00.eps
7156 * This is a @b digital clock widget. In its default theme, it has a
7157 * vintage "flipping numbers clock" appearance, which will animate
7158 * sheets of individual algarisms individually as time goes by.
7160 * A newly created clock will fetch system's time (already
7161 * considering local time adjustments) to start with, and will tick
7162 * accondingly. It may or may not show seconds.
7164 * Clocks have an @b edition mode. When in it, the sheets will
7165 * display extra arrow indications on the top and bottom and the
7166 * user may click on them to raise or lower the time values. After
7167 * it's told to exit edition mode, it will keep ticking with that
7168 * new time set (it keeps the difference from local time).
7170 * Also, when under edition mode, user clicks on the cited arrows
7171 * which are @b held for some time will make the clock to flip the
7172 * sheet, thus editing the time, continuosly and automatically for
7173 * the user. The interval between sheet flips will keep growing in
7174 * time, so that it helps the user to reach a time which is distant
7177 * The time display is, by default, in military mode (24h), but an
7178 * am/pm indicator may be optionally shown, too, when it will
7181 * Smart callbacks one can register to:
7182 * - "changed" - the clock's user changed the time
7184 * Here is an example on its usage:
7185 * @li @ref clock_example
7194 * Identifiers for which clock digits should be editable, when a
7195 * clock widget is in edition mode. Values may be ORed together to
7196 * make a mask, naturally.
7198 * @see elm_clock_edit_set()
7199 * @see elm_clock_digit_edit_set()
7201 typedef enum _Elm_Clock_Digedit
7203 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
7204 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
7205 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
7206 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
7207 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
7208 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
7209 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
7210 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
7211 } Elm_Clock_Digedit;
7214 * Add a new clock widget to the given parent Elementary
7215 * (container) object
7217 * @param parent The parent object
7218 * @return a new clock widget handle or @c NULL, on errors
7220 * This function inserts a new clock widget on the canvas.
7224 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7227 * Set a clock widget's time, programmatically
7229 * @param obj The clock widget object
7230 * @param hrs The hours to set
7231 * @param min The minutes to set
7232 * @param sec The secondes to set
7234 * This function updates the time that is showed by the clock
7237 * Values @b must be set within the following ranges:
7238 * - 0 - 23, for hours
7239 * - 0 - 59, for minutes
7240 * - 0 - 59, for seconds,
7242 * even if the clock is not in "military" mode.
7244 * @warning The behavior for values set out of those ranges is @b
7249 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7252 * Get a clock widget's time values
7254 * @param obj The clock object
7255 * @param[out] hrs Pointer to the variable to get the hours value
7256 * @param[out] min Pointer to the variable to get the minutes value
7257 * @param[out] sec Pointer to the variable to get the seconds value
7259 * This function gets the time set for @p obj, returning
7260 * it on the variables passed as the arguments to function
7262 * @note Use @c NULL pointers on the time values you're not
7263 * interested in: they'll be ignored by the function.
7267 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7270 * Set whether a given clock widget is under <b>edition mode</b> or
7271 * under (default) displaying-only mode.
7273 * @param obj The clock object
7274 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7275 * put it back to "displaying only" mode
7277 * This function makes a clock's time to be editable or not <b>by
7278 * user interaction</b>. When in edition mode, clocks @b stop
7279 * ticking, until one brings them back to canonical mode. The
7280 * elm_clock_digit_edit_set() function will influence which digits
7281 * of the clock will be editable. By default, all of them will be
7282 * (#ELM_CLOCK_NONE).
7284 * @note am/pm sheets, if being shown, will @b always be editable
7285 * under edition mode.
7287 * @see elm_clock_edit_get()
7291 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7294 * Retrieve whether a given clock widget is under <b>edition
7295 * mode</b> or under (default) displaying-only mode.
7297 * @param obj The clock object
7298 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7301 * This function retrieves whether the clock's time can be edited
7302 * or not by user interaction.
7304 * @see elm_clock_edit_set() for more details
7308 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7311 * Set what digits of the given clock widget should be editable
7312 * when in edition mode.
7314 * @param obj The clock object
7315 * @param digedit Bit mask indicating the digits to be editable
7316 * (values in #Elm_Clock_Digedit).
7318 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7319 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7322 * @see elm_clock_digit_edit_get()
7326 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7329 * Retrieve what digits of the given clock widget should be
7330 * editable when in edition mode.
7332 * @param obj The clock object
7333 * @return Bit mask indicating the digits to be editable
7334 * (values in #Elm_Clock_Digedit).
7336 * @see elm_clock_digit_edit_set() for more details
7340 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7343 * Set if the given clock widget must show hours in military or
7346 * @param obj The clock object
7347 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7350 * This function sets if the clock must show hours in military or
7351 * am/pm mode. In some countries like Brazil the military mode
7352 * (00-24h-format) is used, in opposition to the USA, where the
7353 * am/pm mode is more commonly used.
7355 * @see elm_clock_show_am_pm_get()
7359 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7362 * Get if the given clock widget shows hours in military or am/pm
7365 * @param obj The clock object
7366 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7369 * This function gets if the clock shows hours in military or am/pm
7372 * @see elm_clock_show_am_pm_set() for more details
7376 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7379 * Set if the given clock widget must show time with seconds or not
7381 * @param obj The clock object
7382 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7384 * This function sets if the given clock must show or not elapsed
7385 * seconds. By default, they are @b not shown.
7387 * @see elm_clock_show_seconds_get()
7391 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7394 * Get whether the given clock widget is showing time with seconds
7397 * @param obj The clock object
7398 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7400 * This function gets whether @p obj is showing or not the elapsed
7403 * @see elm_clock_show_seconds_set()
7407 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7410 * Set the interval on time updates for an user mouse button hold
7411 * on clock widgets' time edition.
7413 * @param obj The clock object
7414 * @param interval The (first) interval value in seconds
7416 * This interval value is @b decreased while the user holds the
7417 * mouse pointer either incrementing or decrementing a given the
7418 * clock digit's value.
7420 * This helps the user to get to a given time distant from the
7421 * current one easier/faster, as it will start to flip quicker and
7422 * quicker on mouse button holds.
7424 * The calculation for the next flip interval value, starting from
7425 * the one set with this call, is the previous interval divided by
7426 * 1.05, so it decreases a little bit.
7428 * The default starting interval value for automatic flips is
7431 * @see elm_clock_interval_get()
7435 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7438 * Get the interval on time updates for an user mouse button hold
7439 * on clock widgets' time edition.
7441 * @param obj The clock object
7442 * @return The (first) interval value, in seconds, set on it
7444 * @see elm_clock_interval_set() for more details
7448 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7455 * @defgroup Layout Layout
7457 * @image html img/widget/layout/preview-00.png
7458 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7460 * @image html img/layout-predefined.png
7461 * @image latex img/layout-predefined.eps width=\textwidth
7463 * This is a container widget that takes a standard Edje design file and
7464 * wraps it very thinly in a widget.
7466 * An Edje design (theme) file has a very wide range of possibilities to
7467 * describe the behavior of elements added to the Layout. Check out the Edje
7468 * documentation and the EDC reference to get more information about what can
7469 * be done with Edje.
7471 * Just like @ref List, @ref Box, and other container widgets, any
7472 * object added to the Layout will become its child, meaning that it will be
7473 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7475 * The Layout widget can contain as many Contents, Boxes or Tables as
7476 * described in its theme file. For instance, objects can be added to
7477 * different Tables by specifying the respective Table part names. The same
7478 * is valid for Content and Box.
7480 * The objects added as child of the Layout will behave as described in the
7481 * part description where they were added. There are 3 possible types of
7482 * parts where a child can be added:
7484 * @section secContent Content (SWALLOW part)
7486 * Only one object can be added to the @c SWALLOW part (but you still can
7487 * have many @c SWALLOW parts and one object on each of them). Use the @c
7488 * elm_layout_content_* set of functions to set, retrieve and unset objects
7489 * as content of the @c SWALLOW. After being set to this part, the object
7490 * size, position, visibility, clipping and other description properties
7491 * will be totally controled by the description of the given part (inside
7492 * the Edje theme file).
7494 * One can use @c evas_object_size_hint_* functions on the child to have some
7495 * kind of control over its behavior, but the resulting behavior will still
7496 * depend heavily on the @c SWALLOW part description.
7498 * The Edje theme also can change the part description, based on signals or
7499 * scripts running inside the theme. This change can also be animated. All of
7500 * this will affect the child object set as content accordingly. The object
7501 * size will be changed if the part size is changed, it will animate move if
7502 * the part is moving, and so on.
7504 * The following picture demonstrates a Layout widget with a child object
7505 * added to its @c SWALLOW:
7507 * @image html layout_swallow.png
7508 * @image latex layout_swallow.eps width=\textwidth
7510 * @section secBox Box (BOX part)
7512 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7513 * allows one to add objects to the box and have them distributed along its
7514 * area, accordingly to the specified @a layout property (now by @a layout we
7515 * mean the chosen layouting design of the Box, not the Layout widget
7518 * A similar effect for having a box with its position, size and other things
7519 * controled by the Layout theme would be to create an Elementary @ref Box
7520 * widget and add it as a Content in the @c SWALLOW part.
7522 * The main difference of using the Layout Box is that its behavior, the box
7523 * properties like layouting format, padding, align, etc. will be all
7524 * controled by the theme. This means, for example, that a signal could be
7525 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7526 * handled the signal by changing the box padding, or align, or both. Using
7527 * the Elementary @ref Box widget is not necessarily harder or easier, it
7528 * just depends on the circunstances and requirements.
7530 * The Layout Box can be used through the @c elm_layout_box_* set of
7533 * The following picture demonstrates a Layout widget with many child objects
7534 * added to its @c BOX part:
7536 * @image html layout_box.png
7537 * @image latex layout_box.eps width=\textwidth
7539 * @section secTable Table (TABLE part)
7541 * Just like the @ref secBox, the Layout Table is very similar to the
7542 * Elementary @ref Table widget. It allows one to add objects to the Table
7543 * specifying the row and column where the object should be added, and any
7544 * column or row span if necessary.
7546 * Again, we could have this design by adding a @ref Table widget to the @c
7547 * SWALLOW part using elm_layout_content_set(). The same difference happens
7548 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7549 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7551 * The Layout Table can be used through the @c elm_layout_table_* set of
7554 * The following picture demonstrates a Layout widget with many child objects
7555 * added to its @c TABLE part:
7557 * @image html layout_table.png
7558 * @image latex layout_table.eps width=\textwidth
7560 * @section secPredef Predefined Layouts
7562 * Another interesting thing about the Layout widget is that it offers some
7563 * predefined themes that come with the default Elementary theme. These
7564 * themes can be set by the call elm_layout_theme_set(), and provide some
7565 * basic functionality depending on the theme used.
7567 * Most of them already send some signals, some already provide a toolbar or
7568 * back and next buttons.
7570 * These are available predefined theme layouts. All of them have class = @c
7571 * layout, group = @c application, and style = one of the following options:
7573 * @li @c toolbar-content - application with toolbar and main content area
7574 * @li @c toolbar-content-back - application with toolbar and main content
7575 * area with a back button and title area
7576 * @li @c toolbar-content-back-next - application with toolbar and main
7577 * content area with a back and next buttons and title area
7578 * @li @c content-back - application with a main content area with a back
7579 * button and title area
7580 * @li @c content-back-next - application with a main content area with a
7581 * back and next buttons and title area
7582 * @li @c toolbar-vbox - application with toolbar and main content area as a
7584 * @li @c toolbar-table - application with toolbar and main content area as a
7587 * @section secExamples Examples
7589 * Some examples of the Layout widget can be found here:
7590 * @li @ref layout_example_01
7591 * @li @ref layout_example_02
7592 * @li @ref layout_example_03
7593 * @li @ref layout_example_edc
7598 * Add a new layout to the parent
7600 * @param parent The parent object
7601 * @return The new object or NULL if it cannot be created
7603 * @see elm_layout_file_set()
7604 * @see elm_layout_theme_set()
7608 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7610 * Set the file that will be used as layout
7612 * @param obj The layout object
7613 * @param file The path to file (edj) that will be used as layout
7614 * @param group The group that the layout belongs in edje file
7616 * @return (1 = success, 0 = error)
7620 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7622 * Set the edje group from the elementary theme that will be used as layout
7624 * @param obj The layout object
7625 * @param clas the clas of the group
7626 * @param group the group
7627 * @param style the style to used
7629 * @return (1 = success, 0 = error)
7633 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7635 * Set the layout content.
7637 * @param obj The layout object
7638 * @param swallow The swallow part name in the edje file
7639 * @param content The child that will be added in this layout object
7641 * Once the content object is set, a previously set one will be deleted.
7642 * If you want to keep that old content object, use the
7643 * elm_layout_content_unset() function.
7645 * @note In an Edje theme, the part used as a content container is called @c
7646 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7647 * expected to be a part name just like the second parameter of
7648 * elm_layout_box_append().
7650 * @see elm_layout_box_append()
7651 * @see elm_layout_content_get()
7652 * @see elm_layout_content_unset()
7657 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7659 * Get the child object in the given content part.
7661 * @param obj The layout object
7662 * @param swallow The SWALLOW part to get its content
7664 * @return The swallowed object or NULL if none or an error occurred
7666 * @see elm_layout_content_set()
7670 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7672 * Unset the layout content.
7674 * @param obj The layout object
7675 * @param swallow The swallow part name in the edje file
7676 * @return The content that was being used
7678 * Unparent and return the content object which was set for this part.
7680 * @see elm_layout_content_set()
7684 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7686 * Set the text of the given part
7688 * @param obj The layout object
7689 * @param part The TEXT part where to set the text
7690 * @param text The text to set
7693 * @deprecated use elm_object_text_* instead.
7695 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7697 * Get the text set in the given part
7699 * @param obj The layout object
7700 * @param part The TEXT part to retrieve the text off
7702 * @return The text set in @p part
7705 * @deprecated use elm_object_text_* instead.
7707 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7709 * Append child to layout box part.
7711 * @param obj the layout object
7712 * @param part the box part to which the object will be appended.
7713 * @param child the child object to append to box.
7715 * Once the object is appended, it will become child of the layout. Its
7716 * lifetime will be bound to the layout, whenever the layout dies the child
7717 * will be deleted automatically. One should use elm_layout_box_remove() to
7718 * make this layout forget about the object.
7720 * @see elm_layout_box_prepend()
7721 * @see elm_layout_box_insert_before()
7722 * @see elm_layout_box_insert_at()
7723 * @see elm_layout_box_remove()
7727 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7729 * Prepend child to layout box part.
7731 * @param obj the layout object
7732 * @param part the box part to prepend.
7733 * @param child the child object to prepend to box.
7735 * Once the object is prepended, it will become child of the layout. Its
7736 * lifetime will be bound to the layout, whenever the layout dies the child
7737 * will be deleted automatically. One should use elm_layout_box_remove() to
7738 * make this layout forget about the object.
7740 * @see elm_layout_box_append()
7741 * @see elm_layout_box_insert_before()
7742 * @see elm_layout_box_insert_at()
7743 * @see elm_layout_box_remove()
7747 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7749 * Insert child to layout box part before a reference object.
7751 * @param obj the layout object
7752 * @param part the box part to insert.
7753 * @param child the child object to insert into box.
7754 * @param reference another reference object to insert before in box.
7756 * Once the object is inserted, it will become child of the layout. Its
7757 * lifetime will be bound to the layout, whenever the layout dies the child
7758 * will be deleted automatically. One should use elm_layout_box_remove() to
7759 * make this layout forget about the object.
7761 * @see elm_layout_box_append()
7762 * @see elm_layout_box_prepend()
7763 * @see elm_layout_box_insert_before()
7764 * @see elm_layout_box_remove()
7768 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7770 * Insert child to layout box part at a given position.
7772 * @param obj the layout object
7773 * @param part the box part to insert.
7774 * @param child the child object to insert into box.
7775 * @param pos the numeric position >=0 to insert the child.
7777 * Once the object is inserted, it will become child of the layout. Its
7778 * lifetime will be bound to the layout, whenever the layout dies the child
7779 * will be deleted automatically. One should use elm_layout_box_remove() to
7780 * make this layout forget about the object.
7782 * @see elm_layout_box_append()
7783 * @see elm_layout_box_prepend()
7784 * @see elm_layout_box_insert_before()
7785 * @see elm_layout_box_remove()
7789 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7791 * Remove a child of the given part box.
7793 * @param obj The layout object
7794 * @param part The box part name to remove child.
7795 * @param child The object to remove from box.
7796 * @return The object that was being used, or NULL if not found.
7798 * The object will be removed from the box part and its lifetime will
7799 * not be handled by the layout anymore. This is equivalent to
7800 * elm_layout_content_unset() for box.
7802 * @see elm_layout_box_append()
7803 * @see elm_layout_box_remove_all()
7807 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7809 * Remove all child of the given part box.
7811 * @param obj The layout object
7812 * @param part The box part name to remove child.
7813 * @param clear If EINA_TRUE, then all objects will be deleted as
7814 * well, otherwise they will just be removed and will be
7815 * dangling on the canvas.
7817 * The objects will be removed from the box part and their lifetime will
7818 * not be handled by the layout anymore. This is equivalent to
7819 * elm_layout_box_remove() for all box children.
7821 * @see elm_layout_box_append()
7822 * @see elm_layout_box_remove()
7826 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7828 * Insert child to layout table part.
7830 * @param obj the layout object
7831 * @param part the box part to pack child.
7832 * @param child_obj the child object to pack into table.
7833 * @param col the column to which the child should be added. (>= 0)
7834 * @param row the row to which the child should be added. (>= 0)
7835 * @param colspan how many columns should be used to store this object. (>=
7837 * @param rowspan how many rows should be used to store this object. (>= 1)
7839 * Once the object is inserted, it will become child of the table. Its
7840 * lifetime will be bound to the layout, and whenever the layout dies the
7841 * child will be deleted automatically. One should use
7842 * elm_layout_table_remove() to make this layout forget about the object.
7844 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7845 * more space than a single cell. For instance, the following code:
7847 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7850 * Would result in an object being added like the following picture:
7852 * @image html layout_colspan.png
7853 * @image latex layout_colspan.eps width=\textwidth
7855 * @see elm_layout_table_unpack()
7856 * @see elm_layout_table_clear()
7860 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);
7862 * Unpack (remove) a child of the given part table.
7864 * @param obj The layout object
7865 * @param part The table part name to remove child.
7866 * @param child_obj The object to remove from table.
7867 * @return The object that was being used, or NULL if not found.
7869 * The object will be unpacked from the table part and its lifetime
7870 * will not be handled by the layout anymore. This is equivalent to
7871 * elm_layout_content_unset() for table.
7873 * @see elm_layout_table_pack()
7874 * @see elm_layout_table_clear()
7878 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7880 * Remove all child of the given part table.
7882 * @param obj The layout object
7883 * @param part The table part name to remove child.
7884 * @param clear If EINA_TRUE, then all objects will be deleted as
7885 * well, otherwise they will just be removed and will be
7886 * dangling on the canvas.
7888 * The objects will be removed from the table part and their lifetime will
7889 * not be handled by the layout anymore. This is equivalent to
7890 * elm_layout_table_unpack() for all table children.
7892 * @see elm_layout_table_pack()
7893 * @see elm_layout_table_unpack()
7897 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7899 * Get the edje layout
7901 * @param obj The layout object
7903 * @return A Evas_Object with the edje layout settings loaded
7904 * with function elm_layout_file_set
7906 * This returns the edje object. It is not expected to be used to then
7907 * swallow objects via edje_object_part_swallow() for example. Use
7908 * elm_layout_content_set() instead so child object handling and sizing is
7911 * @note This function should only be used if you really need to call some
7912 * low level Edje function on this edje object. All the common stuff (setting
7913 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7914 * with proper elementary functions.
7916 * @see elm_object_signal_callback_add()
7917 * @see elm_object_signal_emit()
7918 * @see elm_object_text_part_set()
7919 * @see elm_layout_content_set()
7920 * @see elm_layout_box_append()
7921 * @see elm_layout_table_pack()
7922 * @see elm_layout_data_get()
7926 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7928 * Get the edje data from the given layout
7930 * @param obj The layout object
7931 * @param key The data key
7933 * @return The edje data string
7935 * This function fetches data specified inside the edje theme of this layout.
7936 * This function return NULL if data is not found.
7938 * In EDC this comes from a data block within the group block that @p
7939 * obj was loaded from. E.g.
7946 * item: "key1" "value1";
7947 * item: "key2" "value2";
7955 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7959 * @param obj The layout object
7961 * Manually forces a sizing re-evaluation. This is useful when the minimum
7962 * size required by the edje theme of this layout has changed. The change on
7963 * the minimum size required by the edje theme is not immediately reported to
7964 * the elementary layout, so one needs to call this function in order to tell
7965 * the widget (layout) that it needs to reevaluate its own size.
7967 * The minimum size of the theme is calculated based on minimum size of
7968 * parts, the size of elements inside containers like box and table, etc. All
7969 * of this can change due to state changes, and that's when this function
7972 * Also note that a standard signal of "size,eval" "elm" emitted from the
7973 * edje object will cause this to happen too.
7977 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7978 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7979 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7980 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7981 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7982 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7983 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);
7984 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7986 * @def elm_layout_icon_set
7987 * Convienience macro to set the icon object in a layout that follows the
7988 * Elementary naming convention for its parts.
7992 #define elm_layout_icon_set(_ly, _obj) \
7995 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7996 if ((_obj)) sig = "elm,state,icon,visible"; \
7997 else sig = "elm,state,icon,hidden"; \
7998 elm_object_signal_emit((_ly), sig, "elm"); \
8002 * @def elm_layout_icon_get
8003 * Convienience macro to get the icon object from a layout that follows the
8004 * Elementary naming convention for its parts.
8008 #define elm_layout_icon_get(_ly) \
8009 elm_layout_content_get((_ly), "elm.swallow.icon")
8012 * @def elm_layout_end_set
8013 * Convienience macro to set the end object in a layout that follows the
8014 * Elementary naming convention for its parts.
8018 #define elm_layout_end_set(_ly, _obj) \
8021 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
8022 if ((_obj)) sig = "elm,state,end,visible"; \
8023 else sig = "elm,state,end,hidden"; \
8024 elm_object_signal_emit((_ly), sig, "elm"); \
8028 * @def elm_layout_end_get
8029 * Convienience macro to get the end object in a layout that follows the
8030 * Elementary naming convention for its parts.
8034 #define elm_layout_end_get(_ly) \
8035 elm_layout_content_get((_ly), "elm.swallow.end")
8038 * @def elm_layout_label_set
8039 * Convienience macro to set the label in a layout that follows the
8040 * Elementary naming convention for its parts.
8043 * @deprecated use elm_object_text_* instead.
8045 #define elm_layout_label_set(_ly, _txt) \
8046 elm_layout_text_set((_ly), "elm.text", (_txt))
8049 * @def elm_layout_label_get
8050 * Convienience macro to get the label in a layout that follows the
8051 * Elementary naming convention for its parts.
8054 * @deprecated use elm_object_text_* instead.
8056 #define elm_layout_label_get(_ly) \
8057 elm_layout_text_get((_ly), "elm.text")
8059 /* smart callbacks called:
8060 * "theme,changed" - when elm theme is changed.
8064 * @defgroup Notify Notify
8066 * @image html img/widget/notify/preview-00.png
8067 * @image latex img/widget/notify/preview-00.eps
8069 * Display a container in a particular region of the parent(top, bottom,
8070 * etc. A timeout can be set to automatically hide the notify. This is so
8071 * that, after an evas_object_show() on a notify object, if a timeout was set
8072 * on it, it will @b automatically get hidden after that time.
8074 * Signals that you can add callbacks for are:
8075 * @li "timeout" - when timeout happens on notify and it's hidden
8076 * @li "block,clicked" - when a click outside of the notify happens
8078 * @ref tutorial_notify show usage of the API.
8083 * @brief Possible orient values for notify.
8085 * This values should be used in conjunction to elm_notify_orient_set() to
8086 * set the position in which the notify should appear(relative to its parent)
8087 * and in conjunction with elm_notify_orient_get() to know where the notify
8090 typedef enum _Elm_Notify_Orient
8092 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
8093 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
8094 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
8095 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
8096 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
8097 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
8098 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
8099 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
8100 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
8101 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
8102 } Elm_Notify_Orient;
8104 * @brief Add a new notify to the parent
8106 * @param parent The parent object
8107 * @return The new object or NULL if it cannot be created
8109 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8111 * @brief Set the content of the notify widget
8113 * @param obj The notify object
8114 * @param content The content will be filled in this notify object
8116 * Once the content object is set, a previously set one will be deleted. If
8117 * you want to keep that old content object, use the
8118 * elm_notify_content_unset() function.
8120 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8122 * @brief Unset the content of the notify widget
8124 * @param obj The notify object
8125 * @return The content that was being used
8127 * Unparent and return the content object which was set for this widget
8129 * @see elm_notify_content_set()
8131 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8133 * @brief Return the content of the notify widget
8135 * @param obj The notify object
8136 * @return The content that is being used
8138 * @see elm_notify_content_set()
8140 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8142 * @brief Set the notify parent
8144 * @param obj The notify object
8145 * @param content The new parent
8147 * Once the parent object is set, a previously set one will be disconnected
8150 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8152 * @brief Get the notify parent
8154 * @param obj The notify object
8155 * @return The parent
8157 * @see elm_notify_parent_set()
8159 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8161 * @brief Set the orientation
8163 * @param obj The notify object
8164 * @param orient The new orientation
8166 * Sets the position in which the notify will appear in its parent.
8168 * @see @ref Elm_Notify_Orient for possible values.
8170 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
8172 * @brief Return the orientation
8173 * @param obj The notify object
8174 * @return The orientation of the notification
8176 * @see elm_notify_orient_set()
8177 * @see Elm_Notify_Orient
8179 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8181 * @brief Set the time interval after which the notify window is going to be
8184 * @param obj The notify object
8185 * @param time The timeout in seconds
8187 * This function sets a timeout and starts the timer controlling when the
8188 * notify is hidden. Since calling evas_object_show() on a notify restarts
8189 * the timer controlling when the notify is hidden, setting this before the
8190 * notify is shown will in effect mean starting the timer when the notify is
8193 * @note Set a value <= 0.0 to disable a running timer.
8195 * @note If the value > 0.0 and the notify is previously visible, the
8196 * timer will be started with this value, canceling any running timer.
8198 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8200 * @brief Return the timeout value (in seconds)
8201 * @param obj the notify object
8203 * @see elm_notify_timeout_set()
8205 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8207 * @brief Sets whether events should be passed to by a click outside
8210 * @param obj The notify object
8211 * @param repeats EINA_TRUE Events are repeats, else no
8213 * When true if the user clicks outside the window the events will be caught
8214 * by the others widgets, else the events are blocked.
8216 * @note The default value is EINA_TRUE.
8218 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8220 * @brief Return true if events are repeat below the notify object
8221 * @param obj the notify object
8223 * @see elm_notify_repeat_events_set()
8225 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8231 * @defgroup Hover Hover
8233 * @image html img/widget/hover/preview-00.png
8234 * @image latex img/widget/hover/preview-00.eps
8236 * A Hover object will hover over its @p parent object at the @p target
8237 * location. Anything in the background will be given a darker coloring to
8238 * indicate that the hover object is on top (at the default theme). When the
8239 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8240 * clicked that @b doesn't cause the hover to be dismissed.
8242 * @note The hover object will take up the entire space of @p target
8245 * Elementary has the following styles for the hover widget:
8249 * @li hoversel_vertical
8251 * The following are the available position for content:
8263 * Signals that you can add callbacks for are:
8264 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8265 * @li "smart,changed" - a content object placed under the "smart"
8266 * policy was replaced to a new slot direction.
8268 * See @ref tutorial_hover for more information.
8272 typedef enum _Elm_Hover_Axis
8274 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8275 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8276 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8277 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8280 * @brief Adds a hover object to @p parent
8282 * @param parent The parent object
8283 * @return The hover object or NULL if one could not be created
8285 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8287 * @brief Sets the target object for the hover.
8289 * @param obj The hover object
8290 * @param target The object to center the hover onto. The hover
8292 * This function will cause the hover to be centered on the target object.
8294 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8296 * @brief Gets the target object for the hover.
8298 * @param obj The hover object
8299 * @param parent The object to locate the hover over.
8301 * @see elm_hover_target_set()
8303 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8305 * @brief Sets the parent object for the hover.
8307 * @param obj The hover object
8308 * @param parent The object to locate the hover over.
8310 * This function will cause the hover to take up the entire space that the
8311 * parent object fills.
8313 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8315 * @brief Gets the parent object for the hover.
8317 * @param obj The hover object
8318 * @return The parent object to locate the hover over.
8320 * @see elm_hover_parent_set()
8322 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8324 * @brief Sets the content of the hover object and the direction in which it
8327 * @param obj The hover object
8328 * @param swallow The direction that the object will be displayed
8329 * at. Accepted values are "left", "top-left", "top", "top-right",
8330 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8332 * @param content The content to place at @p swallow
8334 * Once the content object is set for a given direction, a previously
8335 * set one (on the same direction) will be deleted. If you want to
8336 * keep that old content object, use the elm_hover_content_unset()
8339 * All directions may have contents at the same time, except for
8340 * "smart". This is a special placement hint and its use case
8341 * independs of the calculations coming from
8342 * elm_hover_best_content_location_get(). Its use is for cases when
8343 * one desires only one hover content, but with a dinamic special
8344 * placement within the hover area. The content's geometry, whenever
8345 * it changes, will be used to decide on a best location not
8346 * extrapolating the hover's parent object view to show it in (still
8347 * being the hover's target determinant of its medium part -- move and
8348 * resize it to simulate finger sizes, for example). If one of the
8349 * directions other than "smart" are used, a previously content set
8350 * using it will be deleted, and vice-versa.
8352 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8354 * @brief Get the content of the hover object, in a given direction.
8356 * Return the content object which was set for this widget in the
8357 * @p swallow direction.
8359 * @param obj The hover object
8360 * @param swallow The direction that the object was display at.
8361 * @return The content that was being used
8363 * @see elm_hover_content_set()
8365 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8367 * @brief Unset the content of the hover object, in a given direction.
8369 * Unparent and return the content object set at @p swallow direction.
8371 * @param obj The hover object
8372 * @param swallow The direction that the object was display at.
8373 * @return The content that was being used.
8375 * @see elm_hover_content_set()
8377 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8379 * @brief Returns the best swallow location for content in the hover.
8381 * @param obj The hover object
8382 * @param pref_axis The preferred orientation axis for the hover object to use
8383 * @return The edje location to place content into the hover or @c
8386 * Best is defined here as the location at which there is the most available
8389 * @p pref_axis may be one of
8390 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8391 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8392 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8393 * - @c ELM_HOVER_AXIS_BOTH -- both
8395 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8396 * nescessarily be along the horizontal axis("left" or "right"). If
8397 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8398 * be along the vertical axis("top" or "bottom"). Chossing
8399 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8400 * returned position may be in either axis.
8402 * @see elm_hover_content_set()
8404 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8411 * @defgroup Entry Entry
8413 * @image html img/widget/entry/preview-00.png
8414 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8415 * @image html img/widget/entry/preview-01.png
8416 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8417 * @image html img/widget/entry/preview-02.png
8418 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8419 * @image html img/widget/entry/preview-03.png
8420 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8422 * An entry is a convenience widget which shows a box that the user can
8423 * enter text into. Entries by default don't scroll, so they grow to
8424 * accomodate the entire text, resizing the parent window as needed. This
8425 * can be changed with the elm_entry_scrollable_set() function.
8427 * They can also be single line or multi line (the default) and when set
8428 * to multi line mode they support text wrapping in any of the modes
8429 * indicated by #Elm_Wrap_Type.
8431 * Other features include password mode, filtering of inserted text with
8432 * elm_entry_text_filter_append() and related functions, inline "items" and
8433 * formatted markup text.
8435 * @section entry-markup Formatted text
8437 * The markup tags supported by the Entry are defined by the theme, but
8438 * even when writing new themes or extensions it's a good idea to stick to
8439 * a sane default, to maintain coherency and avoid application breakages.
8440 * Currently defined by the default theme are the following tags:
8441 * @li \<br\>: Inserts a line break.
8442 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8444 * @li \<tab\>: Inserts a tab.
8445 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8447 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8448 * @li \<link\>...\</link\>: Underlines the enclosed text.
8449 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8451 * @section entry-special Special markups
8453 * Besides those used to format text, entries support two special markup
8454 * tags used to insert clickable portions of text or items inlined within
8457 * @subsection entry-anchors Anchors
8459 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8460 * \</a\> tags and an event will be generated when this text is clicked,
8464 * This text is outside <a href=anc-01>but this one is an anchor</a>
8467 * The @c href attribute in the opening tag gives the name that will be
8468 * used to identify the anchor and it can be any valid utf8 string.
8470 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8471 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8472 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8473 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8476 * @subsection entry-items Items
8478 * Inlined in the text, any other @c Evas_Object can be inserted by using
8479 * \<item\> tags this way:
8482 * <item size=16x16 vsize=full href=emoticon/haha></item>
8485 * Just like with anchors, the @c href identifies each item, but these need,
8486 * in addition, to indicate their size, which is done using any one of
8487 * @c size, @c absize or @c relsize attributes. These attributes take their
8488 * value in the WxH format, where W is the width and H the height of the
8491 * @li absize: Absolute pixel size for the item. Whatever value is set will
8492 * be the item's size regardless of any scale value the object may have
8493 * been set to. The final line height will be adjusted to fit larger items.
8494 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8496 * @li relsize: Size is adjusted for the item to fit within the current
8499 * Besides their size, items are specificed a @c vsize value that affects
8500 * how their final size and position are calculated. The possible values
8502 * @li ascent: Item will be placed within the line's baseline and its
8503 * ascent. That is, the height between the line where all characters are
8504 * positioned and the highest point in the line. For @c size and @c absize
8505 * items, the descent value will be added to the total line height to make
8506 * them fit. @c relsize items will be adjusted to fit within this space.
8507 * @li full: Items will be placed between the descent and ascent, or the
8508 * lowest point in the line and its highest.
8510 * The next image shows different configurations of items and how they
8511 * are the previously mentioned options affect their sizes. In all cases,
8512 * the green line indicates the ascent, blue for the baseline and red for
8515 * @image html entry_item.png
8516 * @image latex entry_item.eps width=\textwidth
8518 * And another one to show how size differs from absize. In the first one,
8519 * the scale value is set to 1.0, while the second one is using one of 2.0.
8521 * @image html entry_item_scale.png
8522 * @image latex entry_item_scale.eps width=\textwidth
8524 * After the size for an item is calculated, the entry will request an
8525 * object to place in its space. For this, the functions set with
8526 * elm_entry_item_provider_append() and related functions will be called
8527 * in order until one of them returns a @c non-NULL value. If no providers
8528 * are available, or all of them return @c NULL, then the entry falls back
8529 * to one of the internal defaults, provided the name matches with one of
8532 * All of the following are currently supported:
8535 * - emoticon/angry-shout
8536 * - emoticon/crazy-laugh
8537 * - emoticon/evil-laugh
8539 * - emoticon/goggle-smile
8541 * - emoticon/grumpy-smile
8543 * - emoticon/guilty-smile
8545 * - emoticon/half-smile
8546 * - emoticon/happy-panting
8548 * - emoticon/indifferent
8550 * - emoticon/knowing-grin
8552 * - emoticon/little-bit-sorry
8553 * - emoticon/love-lots
8555 * - emoticon/minimal-smile
8556 * - emoticon/not-happy
8557 * - emoticon/not-impressed
8559 * - emoticon/opensmile
8562 * - emoticon/squint-laugh
8563 * - emoticon/surprised
8564 * - emoticon/suspicious
8565 * - emoticon/tongue-dangling
8566 * - emoticon/tongue-poke
8568 * - emoticon/unhappy
8569 * - emoticon/very-sorry
8572 * - emoticon/worried
8575 * Alternatively, an item may reference an image by its path, using
8576 * the URI form @c file:///path/to/an/image.png and the entry will then
8577 * use that image for the item.
8579 * @section entry-files Loading and saving files
8581 * Entries have convinience functions to load text from a file and save
8582 * changes back to it after a short delay. The automatic saving is enabled
8583 * by default, but can be disabled with elm_entry_autosave_set() and files
8584 * can be loaded directly as plain text or have any markup in them
8585 * recognized. See elm_entry_file_set() for more details.
8587 * @section entry-signals Emitted signals
8589 * This widget emits the following signals:
8591 * @li "changed": The text within the entry was changed.
8592 * @li "changed,user": The text within the entry was changed because of user interaction.
8593 * @li "activated": The enter key was pressed on a single line entry.
8594 * @li "press": A mouse button has been pressed on the entry.
8595 * @li "longpressed": A mouse button has been pressed and held for a couple
8597 * @li "clicked": The entry has been clicked (mouse press and release).
8598 * @li "clicked,double": The entry has been double clicked.
8599 * @li "clicked,triple": The entry has been triple clicked.
8600 * @li "focused": The entry has received focus.
8601 * @li "unfocused": The entry has lost focus.
8602 * @li "selection,paste": A paste of the clipboard contents was requested.
8603 * @li "selection,copy": A copy of the selected text into the clipboard was
8605 * @li "selection,cut": A cut of the selected text into the clipboard was
8607 * @li "selection,start": A selection has begun and no previous selection
8609 * @li "selection,changed": The current selection has changed.
8610 * @li "selection,cleared": The current selection has been cleared.
8611 * @li "cursor,changed": The cursor has changed position.
8612 * @li "anchor,clicked": An anchor has been clicked. The event_info
8613 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8614 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8615 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8616 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8617 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8618 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8619 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8620 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8621 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8622 * @li "preedit,changed": The preedit string has changed.
8624 * @section entry-examples
8626 * An overview of the Entry API can be seen in @ref entry_example_01
8631 * @typedef Elm_Entry_Anchor_Info
8633 * The info sent in the callback for the "anchor,clicked" signals emitted
8636 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8638 * @struct _Elm_Entry_Anchor_Info
8640 * The info sent in the callback for the "anchor,clicked" signals emitted
8643 struct _Elm_Entry_Anchor_Info
8645 const char *name; /**< The name of the anchor, as stated in its href */
8646 int button; /**< The mouse button used to click on it */
8647 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8648 y, /**< Anchor geometry, relative to canvas */
8649 w, /**< Anchor geometry, relative to canvas */
8650 h; /**< Anchor geometry, relative to canvas */
8653 * @typedef Elm_Entry_Filter_Cb
8654 * This callback type is used by entry filters to modify text.
8655 * @param data The data specified as the last param when adding the filter
8656 * @param entry The entry object
8657 * @param text A pointer to the location of the text being filtered. This data can be modified,
8658 * but any additional allocations must be managed by the user.
8659 * @see elm_entry_text_filter_append
8660 * @see elm_entry_text_filter_prepend
8662 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8665 * This adds an entry to @p parent object.
8667 * By default, entries are:
8671 * @li autosave is enabled
8673 * @param parent The parent object
8674 * @return The new object or NULL if it cannot be created
8676 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8678 * Sets the entry to single line mode.
8680 * In single line mode, entries don't ever wrap when the text reaches the
8681 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8682 * key will generate an @c "activate" event instead of adding a new line.
8684 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8685 * and pressing enter will break the text into a different line
8686 * without generating any events.
8688 * @param obj The entry object
8689 * @param single_line If true, the text in the entry
8690 * will be on a single line.
8692 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8694 * Gets whether the entry is set to be single line.
8696 * @param obj The entry object
8697 * @return single_line If true, the text in the entry is set to display
8700 * @see elm_entry_single_line_set()
8702 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8704 * Sets the entry to password mode.
8706 * In password mode, entries are implicitly single line and the display of
8707 * any text in them is replaced with asterisks (*).
8709 * @param obj The entry object
8710 * @param password If true, password mode is enabled.
8712 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8714 * Gets whether the entry is set to password mode.
8716 * @param obj The entry object
8717 * @return If true, the entry is set to display all characters
8720 * @see elm_entry_password_set()
8722 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8724 * This sets the text displayed within the entry to @p entry.
8726 * @param obj The entry object
8727 * @param entry The text to be displayed
8729 * @deprecated Use elm_object_text_set() instead.
8731 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8733 * This returns the text currently shown in object @p entry.
8734 * See also elm_entry_entry_set().
8736 * @param obj The entry object
8737 * @return The currently displayed text or NULL on failure
8739 * @deprecated Use elm_object_text_get() instead.
8741 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8743 * Appends @p entry to the text of the entry.
8745 * Adds the text in @p entry to the end of any text already present in the
8748 * The appended text is subject to any filters set for the widget.
8750 * @param obj The entry object
8751 * @param entry The text to be displayed
8753 * @see elm_entry_text_filter_append()
8755 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8757 * Gets whether the entry is empty.
8759 * Empty means no text at all. If there are any markup tags, like an item
8760 * tag for which no provider finds anything, and no text is displayed, this
8761 * function still returns EINA_FALSE.
8763 * @param obj The entry object
8764 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8766 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8768 * Gets any selected text within the entry.
8770 * If there's any selected text in the entry, this function returns it as
8771 * a string in markup format. NULL is returned if no selection exists or
8772 * if an error occurred.
8774 * The returned value points to an internal string and should not be freed
8775 * or modified in any way. If the @p entry object is deleted or its
8776 * contents are changed, the returned pointer should be considered invalid.
8778 * @param obj The entry object
8779 * @return The selected text within the entry or NULL on failure
8781 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8783 * Inserts the given text into the entry at the current cursor position.
8785 * This inserts text at the cursor position as if it was typed
8786 * by the user (note that this also allows markup which a user
8787 * can't just "type" as it would be converted to escaped text, so this
8788 * call can be used to insert things like emoticon items or bold push/pop
8789 * tags, other font and color change tags etc.)
8791 * If any selection exists, it will be replaced by the inserted text.
8793 * The inserted text is subject to any filters set for the widget.
8795 * @param obj The entry object
8796 * @param entry The text to insert
8798 * @see elm_entry_text_filter_append()
8800 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8802 * Set the line wrap type to use on multi-line entries.
8804 * Sets the wrap type used by the entry to any of the specified in
8805 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8806 * line (without inserting a line break or paragraph separator) when it
8807 * reaches the far edge of the widget.
8809 * Note that this only makes sense for multi-line entries. A widget set
8810 * to be single line will never wrap.
8812 * @param obj The entry object
8813 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8815 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8817 * Gets the wrap mode the entry was set to use.
8819 * @param obj The entry object
8822 * @see also elm_entry_line_wrap_set()
8824 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8826 * Sets if the entry is to be editable or not.
8828 * By default, entries are editable and when focused, any text input by the
8829 * user will be inserted at the current cursor position. But calling this
8830 * function with @p editable as EINA_FALSE will prevent the user from
8831 * inputting text into the entry.
8833 * The only way to change the text of a non-editable entry is to use
8834 * elm_object_text_set(), elm_entry_entry_insert() and other related
8837 * @param obj The entry object
8838 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8839 * if not, the entry is read-only and no user input is allowed.
8841 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8843 * Gets whether the entry is editable or not.
8845 * @param obj The entry object
8846 * @return If true, the entry is editable by the user.
8847 * If false, it is not editable by the user
8849 * @see elm_entry_editable_set()
8851 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8853 * This drops any existing text selection within the entry.
8855 * @param obj The entry object
8857 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8859 * This selects all text within the entry.
8861 * @param obj The entry object
8863 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8865 * This moves the cursor one place to the right within the entry.
8867 * @param obj The entry object
8868 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8870 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8872 * This moves the cursor one place to the left within the entry.
8874 * @param obj The entry object
8875 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8877 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8879 * This moves the cursor one line up within the entry.
8881 * @param obj The entry object
8882 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8884 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8886 * This moves the cursor one line down within the entry.
8888 * @param obj The entry object
8889 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8891 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8893 * This moves the cursor to the beginning of the entry.
8895 * @param obj The entry object
8897 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8899 * This moves the cursor to the end of the entry.
8901 * @param obj The entry object
8903 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8905 * This moves the cursor to the beginning of the current line.
8907 * @param obj The entry object
8909 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8911 * This moves the cursor to the end of the current line.
8913 * @param obj The entry object
8915 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8917 * This begins a selection within the entry as though
8918 * the user were holding down the mouse button to make a selection.
8920 * @param obj The entry object
8922 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8924 * This ends a selection within the entry as though
8925 * the user had just released the mouse button while making a selection.
8927 * @param obj The entry object
8929 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8931 * Gets whether a format node exists at the current cursor position.
8933 * A format node is anything that defines how the text is rendered. It can
8934 * be a visible format node, such as a line break or a paragraph separator,
8935 * or an invisible one, such as bold begin or end tag.
8936 * This function returns whether any format node exists at the current
8939 * @param obj The entry object
8940 * @return EINA_TRUE if the current cursor position contains a format node,
8941 * EINA_FALSE otherwise.
8943 * @see elm_entry_cursor_is_visible_format_get()
8945 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8947 * Gets if the current cursor position holds a visible format node.
8949 * @param obj The entry object
8950 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8951 * if it's an invisible one or no format exists.
8953 * @see elm_entry_cursor_is_format_get()
8955 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8957 * Gets the character pointed by the cursor at its current position.
8959 * This function returns a string with the utf8 character stored at the
8960 * current cursor position.
8961 * Only the text is returned, any format that may exist will not be part
8962 * of the return value.
8964 * @param obj The entry object
8965 * @return The text pointed by the cursors.
8967 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8969 * This function returns the geometry of the cursor.
8971 * It's useful if you want to draw something on the cursor (or where it is),
8972 * or for example in the case of scrolled entry where you want to show the
8975 * @param obj The entry object
8976 * @param x returned geometry
8977 * @param y returned geometry
8978 * @param w returned geometry
8979 * @param h returned geometry
8980 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8982 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);
8984 * Sets the cursor position in the entry to the given value
8986 * The value in @p pos is the index of the character position within the
8987 * contents of the string as returned by elm_entry_cursor_pos_get().
8989 * @param obj The entry object
8990 * @param pos The position of the cursor
8992 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8994 * Retrieves the current position of the cursor in the entry
8996 * @param obj The entry object
8997 * @return The cursor position
8999 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9001 * This executes a "cut" action on the selected text in the entry.
9003 * @param obj The entry object
9005 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
9007 * This executes a "copy" action on the selected text in the entry.
9009 * @param obj The entry object
9011 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
9013 * This executes a "paste" action in the entry.
9015 * @param obj The entry object
9017 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
9019 * This clears and frees the items in a entry's contextual (longpress)
9022 * @param obj The entry object
9024 * @see elm_entry_context_menu_item_add()
9026 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9028 * This adds an item to the entry's contextual menu.
9030 * A longpress on an entry will make the contextual menu show up, if this
9031 * hasn't been disabled with elm_entry_context_menu_disabled_set().
9032 * By default, this menu provides a few options like enabling selection mode,
9033 * which is useful on embedded devices that need to be explicit about it,
9034 * and when a selection exists it also shows the copy and cut actions.
9036 * With this function, developers can add other options to this menu to
9037 * perform any action they deem necessary.
9039 * @param obj The entry object
9040 * @param label The item's text label
9041 * @param icon_file The item's icon file
9042 * @param icon_type The item's icon type
9043 * @param func The callback to execute when the item is clicked
9044 * @param data The data to associate with the item for related functions
9046 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);
9048 * This disables the entry's contextual (longpress) menu.
9050 * @param obj The entry object
9051 * @param disabled If true, the menu is disabled
9053 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9055 * This returns whether the entry's contextual (longpress) menu is
9058 * @param obj The entry object
9059 * @return If true, the menu is disabled
9061 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9063 * This appends a custom item provider to the list for that entry
9065 * This appends the given callback. The list is walked from beginning to end
9066 * with each function called given the item href string in the text. If the
9067 * function returns an object handle other than NULL (it should create an
9068 * object to do this), then this object is used to replace that item. If
9069 * not the next provider is called until one provides an item object, or the
9070 * default provider in entry does.
9072 * @param obj The entry object
9073 * @param func The function called to provide the item object
9074 * @param data The data passed to @p func
9076 * @see @ref entry-items
9078 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);
9080 * This prepends a custom item provider to the list for that entry
9082 * This prepends the given callback. See elm_entry_item_provider_append() for
9085 * @param obj The entry object
9086 * @param func The function called to provide the item object
9087 * @param data The data passed to @p func
9089 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);
9091 * This removes a custom item provider to the list for that entry
9093 * This removes the given callback. See elm_entry_item_provider_append() for
9096 * @param obj The entry object
9097 * @param func The function called to provide the item object
9098 * @param data The data passed to @p func
9100 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);
9102 * Append a filter function for text inserted in the entry
9104 * Append the given callback to the list. This functions will be called
9105 * whenever any text is inserted into the entry, with the text to be inserted
9106 * as a parameter. The callback function is free to alter the text in any way
9107 * it wants, but it must remember to free the given pointer and update it.
9108 * If the new text is to be discarded, the function can free it and set its
9109 * text parameter to NULL. This will also prevent any following filters from
9112 * @param obj The entry object
9113 * @param func The function to use as text filter
9114 * @param data User data to pass to @p func
9116 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9118 * Prepend a filter function for text insdrted in the entry
9120 * Prepend the given callback to the list. See elm_entry_text_filter_append()
9121 * for more information
9123 * @param obj The entry object
9124 * @param func The function to use as text filter
9125 * @param data User data to pass to @p func
9127 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9129 * Remove a filter from the list
9131 * Removes the given callback from the filter list. See
9132 * elm_entry_text_filter_append() for more information.
9134 * @param obj The entry object
9135 * @param func The filter function to remove
9136 * @param data The user data passed when adding the function
9138 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9140 * This converts a markup (HTML-like) string into UTF-8.
9142 * The returned string is a malloc'ed buffer and it should be freed when
9143 * not needed anymore.
9145 * @param s The string (in markup) to be converted
9146 * @return The converted string (in UTF-8). It should be freed.
9148 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9150 * This converts a UTF-8 string into markup (HTML-like).
9152 * The returned string is a malloc'ed buffer and it should be freed when
9153 * not needed anymore.
9155 * @param s The string (in UTF-8) to be converted
9156 * @return The converted string (in markup). It should be freed.
9158 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9160 * This sets the file (and implicitly loads it) for the text to display and
9161 * then edit. All changes are written back to the file after a short delay if
9162 * the entry object is set to autosave (which is the default).
9164 * If the entry had any other file set previously, any changes made to it
9165 * will be saved if the autosave feature is enabled, otherwise, the file
9166 * will be silently discarded and any non-saved changes will be lost.
9168 * @param obj The entry object
9169 * @param file The path to the file to load and save
9170 * @param format The file format
9172 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9174 * Gets the file being edited by the entry.
9176 * This function can be used to retrieve any file set on the entry for
9177 * edition, along with the format used to load and save it.
9179 * @param obj The entry object
9180 * @param file The path to the file to load and save
9181 * @param format The file format
9183 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9185 * This function writes any changes made to the file set with
9186 * elm_entry_file_set()
9188 * @param obj The entry object
9190 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9192 * This sets the entry object to 'autosave' the loaded text file or not.
9194 * @param obj The entry object
9195 * @param autosave Autosave the loaded file or not
9197 * @see elm_entry_file_set()
9199 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9201 * This gets the entry object's 'autosave' status.
9203 * @param obj The entry object
9204 * @return Autosave the loaded file or not
9206 * @see elm_entry_file_set()
9208 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9210 * Control pasting of text and images for the widget.
9212 * Normally the entry allows both text and images to be pasted. By setting
9213 * textonly to be true, this prevents images from being pasted.
9215 * Note this only changes the behaviour of text.
9217 * @param obj The entry object
9218 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9221 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9223 * Getting elm_entry text paste/drop mode.
9225 * In textonly mode, only text may be pasted or dropped into the widget.
9227 * @param obj The entry object
9228 * @return If the widget only accepts text from pastes.
9230 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9232 * Enable or disable scrolling in entry
9234 * Normally the entry is not scrollable unless you enable it with this call.
9236 * @param obj The entry object
9237 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9239 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9241 * Get the scrollable state of the entry
9243 * Normally the entry is not scrollable. This gets the scrollable state
9244 * of the entry. See elm_entry_scrollable_set() for more information.
9246 * @param obj The entry object
9247 * @return The scrollable state
9249 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9251 * This sets a widget to be displayed to the left of a scrolled entry.
9253 * @param obj The scrolled entry object
9254 * @param icon The widget to display on the left side of the scrolled
9257 * @note A previously set widget will be destroyed.
9258 * @note If the object being set does not have minimum size hints set,
9259 * it won't get properly displayed.
9261 * @see elm_entry_end_set()
9263 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9265 * Gets the leftmost widget of the scrolled entry. This object is
9266 * owned by the scrolled entry and should not be modified.
9268 * @param obj The scrolled entry object
9269 * @return the left widget inside the scroller
9271 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9273 * Unset the leftmost widget of the scrolled entry, unparenting and
9276 * @param obj The scrolled entry object
9277 * @return the previously set icon sub-object of this entry, on
9280 * @see elm_entry_icon_set()
9282 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9284 * Sets the visibility of the left-side widget of the scrolled entry,
9285 * set by elm_entry_icon_set().
9287 * @param obj The scrolled entry object
9288 * @param setting EINA_TRUE if the object should be displayed,
9289 * EINA_FALSE if not.
9291 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9293 * This sets a widget to be displayed to the end of a scrolled entry.
9295 * @param obj The scrolled entry object
9296 * @param end The widget to display on the right side of the scrolled
9299 * @note A previously set widget will be destroyed.
9300 * @note If the object being set does not have minimum size hints set,
9301 * it won't get properly displayed.
9303 * @see elm_entry_icon_set
9305 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9307 * Gets the endmost widget of the scrolled entry. This object is owned
9308 * by the scrolled entry and should not be modified.
9310 * @param obj The scrolled entry object
9311 * @return the right widget inside the scroller
9313 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9315 * Unset the endmost widget of the scrolled entry, unparenting and
9318 * @param obj The scrolled entry object
9319 * @return the previously set icon sub-object of this entry, on
9322 * @see elm_entry_icon_set()
9324 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9326 * Sets the visibility of the end widget of the scrolled entry, set by
9327 * elm_entry_end_set().
9329 * @param obj The scrolled entry object
9330 * @param setting EINA_TRUE if the object should be displayed,
9331 * EINA_FALSE if not.
9333 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9335 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9338 * Setting an entry to single-line mode with elm_entry_single_line_set()
9339 * will automatically disable the display of scrollbars when the entry
9340 * moves inside its scroller.
9342 * @param obj The scrolled entry object
9343 * @param h The horizontal scrollbar policy to apply
9344 * @param v The vertical scrollbar policy to apply
9346 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9348 * This enables/disables bouncing within the entry.
9350 * This function sets whether the entry will bounce when scrolling reaches
9351 * the end of the contained entry.
9353 * @param obj The scrolled entry object
9354 * @param h The horizontal bounce state
9355 * @param v The vertical bounce state
9357 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9359 * Get the bounce mode
9361 * @param obj The Entry object
9362 * @param h_bounce Allow bounce horizontally
9363 * @param v_bounce Allow bounce vertically
9365 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9367 /* pre-made filters for entries */
9369 * @typedef Elm_Entry_Filter_Limit_Size
9371 * Data for the elm_entry_filter_limit_size() entry filter.
9373 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9375 * @struct _Elm_Entry_Filter_Limit_Size
9377 * Data for the elm_entry_filter_limit_size() entry filter.
9379 struct _Elm_Entry_Filter_Limit_Size
9381 int max_char_count; /**< The maximum number of characters allowed. */
9382 int max_byte_count; /**< The maximum number of bytes allowed*/
9385 * Filter inserted text based on user defined character and byte limits
9387 * Add this filter to an entry to limit the characters that it will accept
9388 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9389 * The funtion works on the UTF-8 representation of the string, converting
9390 * it from the set markup, thus not accounting for any format in it.
9392 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9393 * it as data when setting the filter. In it, it's possible to set limits
9394 * by character count or bytes (any of them is disabled if 0), and both can
9395 * be set at the same time. In that case, it first checks for characters,
9398 * The function will cut the inserted text in order to allow only the first
9399 * number of characters that are still allowed. The cut is made in
9400 * characters, even when limiting by bytes, in order to always contain
9401 * valid ones and avoid half unicode characters making it in.
9403 * This filter, like any others, does not apply when setting the entry text
9404 * directly with elm_object_text_set() (or the deprecated
9405 * elm_entry_entry_set()).
9407 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9409 * @typedef Elm_Entry_Filter_Accept_Set
9411 * Data for the elm_entry_filter_accept_set() entry filter.
9413 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9415 * @struct _Elm_Entry_Filter_Accept_Set
9417 * Data for the elm_entry_filter_accept_set() entry filter.
9419 struct _Elm_Entry_Filter_Accept_Set
9421 const char *accepted; /**< Set of characters accepted in the entry. */
9422 const char *rejected; /**< Set of characters rejected from the entry. */
9425 * Filter inserted text based on accepted or rejected sets of characters
9427 * Add this filter to an entry to restrict the set of accepted characters
9428 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9429 * This structure contains both accepted and rejected sets, but they are
9430 * mutually exclusive.
9432 * The @c accepted set takes preference, so if it is set, the filter will
9433 * only work based on the accepted characters, ignoring anything in the
9434 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9436 * In both cases, the function filters by matching utf8 characters to the
9437 * raw markup text, so it can be used to remove formatting tags.
9439 * This filter, like any others, does not apply when setting the entry text
9440 * directly with elm_object_text_set() (or the deprecated
9441 * elm_entry_entry_set()).
9443 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9448 /* composite widgets - these basically put together basic widgets above
9449 * in convenient packages that do more than basic stuff */
9453 * @defgroup Anchorview Anchorview
9455 * @image html img/widget/anchorview/preview-00.png
9456 * @image latex img/widget/anchorview/preview-00.eps
9458 * Anchorview is for displaying text that contains markup with anchors
9459 * like <c>\<a href=1234\>something\</\></c> in it.
9461 * Besides being styled differently, the anchorview widget provides the
9462 * necessary functionality so that clicking on these anchors brings up a
9463 * popup with user defined content such as "call", "add to contacts" or
9464 * "open web page". This popup is provided using the @ref Hover widget.
9466 * This widget is very similar to @ref Anchorblock, so refer to that
9467 * widget for an example. The only difference Anchorview has is that the
9468 * widget is already provided with scrolling functionality, so if the
9469 * text set to it is too large to fit in the given space, it will scroll,
9470 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9471 * text can be displayed.
9473 * This widget emits the following signals:
9474 * @li "anchor,clicked": will be called when an anchor is clicked. The
9475 * @p event_info parameter on the callback will be a pointer of type
9476 * ::Elm_Entry_Anchorview_Info.
9478 * See @ref Anchorblock for an example on how to use both of them.
9487 * @typedef Elm_Entry_Anchorview_Info
9489 * The info sent in the callback for "anchor,clicked" signals emitted by
9490 * the Anchorview widget.
9492 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9494 * @struct _Elm_Entry_Anchorview_Info
9496 * The info sent in the callback for "anchor,clicked" signals emitted by
9497 * the Anchorview widget.
9499 struct _Elm_Entry_Anchorview_Info
9501 const char *name; /**< Name of the anchor, as indicated in its href
9503 int button; /**< The mouse button used to click on it */
9504 Evas_Object *hover; /**< The hover object to use for the popup */
9506 Evas_Coord x, y, w, h;
9507 } anchor, /**< Geometry selection of text used as anchor */
9508 hover_parent; /**< Geometry of the object used as parent by the
9510 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9511 for content on the left side of
9512 the hover. Before calling the
9513 callback, the widget will make the
9514 necessary calculations to check
9515 which sides are fit to be set with
9516 content, based on the position the
9517 hover is activated and its distance
9518 to the edges of its parent object
9520 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9521 the right side of the hover.
9522 See @ref hover_left */
9523 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9524 of the hover. See @ref hover_left */
9525 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9526 below the hover. See @ref
9530 * Add a new Anchorview object
9532 * @param parent The parent object
9533 * @return The new object or NULL if it cannot be created
9535 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9537 * Set the text to show in the anchorview
9539 * Sets the text of the anchorview to @p text. This text can include markup
9540 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9541 * text that will be specially styled and react to click events, ended with
9542 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9543 * "anchor,clicked" signal that you can attach a callback to with
9544 * evas_object_smart_callback_add(). The name of the anchor given in the
9545 * event info struct will be the one set in the href attribute, in this
9548 * Other markup can be used to style the text in different ways, but it's
9549 * up to the style defined in the theme which tags do what.
9550 * @deprecated use elm_object_text_set() instead.
9552 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9554 * Get the markup text set for the anchorview
9556 * Retrieves the text set on the anchorview, with markup tags included.
9558 * @param obj The anchorview object
9559 * @return The markup text set or @c NULL if nothing was set or an error
9561 * @deprecated use elm_object_text_set() instead.
9563 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9565 * Set the parent of the hover popup
9567 * Sets the parent object to use by the hover created by the anchorview
9568 * when an anchor is clicked. See @ref Hover for more details on this.
9569 * If no parent is set, the same anchorview object will be used.
9571 * @param obj The anchorview object
9572 * @param parent The object to use as parent for the hover
9574 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9576 * Get the parent of the hover popup
9578 * Get the object used as parent for the hover created by the anchorview
9579 * widget. See @ref Hover for more details on this.
9581 * @param obj The anchorview object
9582 * @return The object used as parent for the hover, NULL if none is set.
9584 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9586 * Set the style that the hover should use
9588 * When creating the popup hover, anchorview will request that it's
9589 * themed according to @p style.
9591 * @param obj The anchorview object
9592 * @param style The style to use for the underlying hover
9594 * @see elm_object_style_set()
9596 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9598 * Get the style that the hover should use
9600 * Get the style the hover created by anchorview will use.
9602 * @param obj The anchorview object
9603 * @return The style to use by the hover. NULL means the default is used.
9605 * @see elm_object_style_set()
9607 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9609 * Ends the hover popup in the anchorview
9611 * When an anchor is clicked, the anchorview widget will create a hover
9612 * object to use as a popup with user provided content. This function
9613 * terminates this popup, returning the anchorview to its normal state.
9615 * @param obj The anchorview object
9617 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9619 * Set bouncing behaviour when the scrolled content reaches an edge
9621 * Tell the internal scroller object whether it should bounce or not
9622 * when it reaches the respective edges for each axis.
9624 * @param obj The anchorview object
9625 * @param h_bounce Whether to bounce or not in the horizontal axis
9626 * @param v_bounce Whether to bounce or not in the vertical axis
9628 * @see elm_scroller_bounce_set()
9630 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9632 * Get the set bouncing behaviour of the internal scroller
9634 * Get whether the internal scroller should bounce when the edge of each
9635 * axis is reached scrolling.
9637 * @param obj The anchorview object
9638 * @param h_bounce Pointer where to store the bounce state of the horizontal
9640 * @param v_bounce Pointer where to store the bounce state of the vertical
9643 * @see elm_scroller_bounce_get()
9645 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9647 * Appends a custom item provider to the given anchorview
9649 * Appends the given function to the list of items providers. This list is
9650 * called, one function at a time, with the given @p data pointer, the
9651 * anchorview object and, in the @p item parameter, the item name as
9652 * referenced in its href string. Following functions in the list will be
9653 * called in order until one of them returns something different to NULL,
9654 * which should be an Evas_Object which will be used in place of the item
9657 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9658 * href=item/name\>\</item\>
9660 * @param obj The anchorview object
9661 * @param func The function to add to the list of providers
9662 * @param data User data that will be passed to the callback function
9664 * @see elm_entry_item_provider_append()
9666 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);
9668 * Prepend a custom item provider to the given anchorview
9670 * Like elm_anchorview_item_provider_append(), but it adds the function
9671 * @p func to the beginning of the list, instead of the end.
9673 * @param obj The anchorview object
9674 * @param func The function to add to the list of providers
9675 * @param data User data that will be passed to the callback function
9677 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);
9679 * Remove a custom item provider from the list of the given anchorview
9681 * Removes the function and data pairing that matches @p func and @p data.
9682 * That is, unless the same function and same user data are given, the
9683 * function will not be removed from the list. This allows us to add the
9684 * same callback several times, with different @p data pointers and be
9685 * able to remove them later without conflicts.
9687 * @param obj The anchorview object
9688 * @param func The function to remove from the list
9689 * @param data The data matching the function to remove from the list
9691 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);
9698 * @defgroup Anchorblock Anchorblock
9700 * @image html img/widget/anchorblock/preview-00.png
9701 * @image latex img/widget/anchorblock/preview-00.eps
9703 * Anchorblock is for displaying text that contains markup with anchors
9704 * like <c>\<a href=1234\>something\</\></c> in it.
9706 * Besides being styled differently, the anchorblock widget provides the
9707 * necessary functionality so that clicking on these anchors brings up a
9708 * popup with user defined content such as "call", "add to contacts" or
9709 * "open web page". This popup is provided using the @ref Hover widget.
9711 * This widget emits the following signals:
9712 * @li "anchor,clicked": will be called when an anchor is clicked. The
9713 * @p event_info parameter on the callback will be a pointer of type
9714 * ::Elm_Entry_Anchorblock_Info.
9720 * Since examples are usually better than plain words, we might as well
9721 * try @ref tutorial_anchorblock_example "one".
9724 * @addtogroup Anchorblock
9728 * @typedef Elm_Entry_Anchorblock_Info
9730 * The info sent in the callback for "anchor,clicked" signals emitted by
9731 * the Anchorblock widget.
9733 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9735 * @struct _Elm_Entry_Anchorblock_Info
9737 * The info sent in the callback for "anchor,clicked" signals emitted by
9738 * the Anchorblock widget.
9740 struct _Elm_Entry_Anchorblock_Info
9742 const char *name; /**< Name of the anchor, as indicated in its href
9744 int button; /**< The mouse button used to click on it */
9745 Evas_Object *hover; /**< The hover object to use for the popup */
9747 Evas_Coord x, y, w, h;
9748 } anchor, /**< Geometry selection of text used as anchor */
9749 hover_parent; /**< Geometry of the object used as parent by the
9751 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9752 for content on the left side of
9753 the hover. Before calling the
9754 callback, the widget will make the
9755 necessary calculations to check
9756 which sides are fit to be set with
9757 content, based on the position the
9758 hover is activated and its distance
9759 to the edges of its parent object
9761 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9762 the right side of the hover.
9763 See @ref hover_left */
9764 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9765 of the hover. See @ref hover_left */
9766 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9767 below the hover. See @ref
9771 * Add a new Anchorblock object
9773 * @param parent The parent object
9774 * @return The new object or NULL if it cannot be created
9776 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9778 * Set the text to show in the anchorblock
9780 * Sets the text of the anchorblock to @p text. This text can include markup
9781 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9782 * of text that will be specially styled and react to click events, ended
9783 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9784 * "anchor,clicked" signal that you can attach a callback to with
9785 * evas_object_smart_callback_add(). The name of the anchor given in the
9786 * event info struct will be the one set in the href attribute, in this
9789 * Other markup can be used to style the text in different ways, but it's
9790 * up to the style defined in the theme which tags do what.
9791 * @deprecated use elm_object_text_set() instead.
9793 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9795 * Get the markup text set for the anchorblock
9797 * Retrieves the text set on the anchorblock, with markup tags included.
9799 * @param obj The anchorblock object
9800 * @return The markup text set or @c NULL if nothing was set or an error
9802 * @deprecated use elm_object_text_set() instead.
9804 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9806 * Set the parent of the hover popup
9808 * Sets the parent object to use by the hover created by the anchorblock
9809 * when an anchor is clicked. See @ref Hover for more details on this.
9811 * @param obj The anchorblock object
9812 * @param parent The object to use as parent for the hover
9814 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9816 * Get the parent of the hover popup
9818 * Get the object used as parent for the hover created by the anchorblock
9819 * widget. See @ref Hover for more details on this.
9820 * If no parent is set, the same anchorblock object will be used.
9822 * @param obj The anchorblock object
9823 * @return The object used as parent for the hover, NULL if none is set.
9825 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9827 * Set the style that the hover should use
9829 * When creating the popup hover, anchorblock will request that it's
9830 * themed according to @p style.
9832 * @param obj The anchorblock object
9833 * @param style The style to use for the underlying hover
9835 * @see elm_object_style_set()
9837 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9839 * Get the style that the hover should use
9841 * Get the style the hover created by anchorblock will use.
9843 * @param obj The anchorblock object
9844 * @return The style to use by the hover. NULL means the default is used.
9846 * @see elm_object_style_set()
9848 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9850 * Ends the hover popup in the anchorblock
9852 * When an anchor is clicked, the anchorblock widget will create a hover
9853 * object to use as a popup with user provided content. This function
9854 * terminates this popup, returning the anchorblock to its normal state.
9856 * @param obj The anchorblock object
9858 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9860 * Appends a custom item provider to the given anchorblock
9862 * Appends the given function to the list of items providers. This list is
9863 * called, one function at a time, with the given @p data pointer, the
9864 * anchorblock object and, in the @p item parameter, the item name as
9865 * referenced in its href string. Following functions in the list will be
9866 * called in order until one of them returns something different to NULL,
9867 * which should be an Evas_Object which will be used in place of the item
9870 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9871 * href=item/name\>\</item\>
9873 * @param obj The anchorblock object
9874 * @param func The function to add to the list of providers
9875 * @param data User data that will be passed to the callback function
9877 * @see elm_entry_item_provider_append()
9879 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);
9881 * Prepend a custom item provider to the given anchorblock
9883 * Like elm_anchorblock_item_provider_append(), but it adds the function
9884 * @p func to the beginning of the list, instead of the end.
9886 * @param obj The anchorblock object
9887 * @param func The function to add to the list of providers
9888 * @param data User data that will be passed to the callback function
9890 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);
9892 * Remove a custom item provider from the list of the given anchorblock
9894 * Removes the function and data pairing that matches @p func and @p data.
9895 * That is, unless the same function and same user data are given, the
9896 * function will not be removed from the list. This allows us to add the
9897 * same callback several times, with different @p data pointers and be
9898 * able to remove them later without conflicts.
9900 * @param obj The anchorblock object
9901 * @param func The function to remove from the list
9902 * @param data The data matching the function to remove from the list
9904 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);
9910 * @defgroup Bubble Bubble
9912 * @image html img/widget/bubble/preview-00.png
9913 * @image latex img/widget/bubble/preview-00.eps
9914 * @image html img/widget/bubble/preview-01.png
9915 * @image latex img/widget/bubble/preview-01.eps
9916 * @image html img/widget/bubble/preview-02.png
9917 * @image latex img/widget/bubble/preview-02.eps
9919 * @brief The Bubble is a widget to show text similarly to how speech is
9920 * represented in comics.
9922 * The bubble widget contains 5 important visual elements:
9923 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9924 * @li The @p icon is an image to which the frame's arrow points to.
9925 * @li The @p label is a text which appears to the right of the icon if the
9926 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9928 * @li The @p info is a text which appears to the right of the label. Info's
9929 * font is of a ligther color than label.
9930 * @li The @p content is an evas object that is shown inside the frame.
9932 * The position of the arrow, icon, label and info depends on which corner is
9933 * selected. The four available corners are:
9934 * @li "top_left" - Default
9937 * @li "bottom_right"
9939 * Signals that you can add callbacks for are:
9940 * @li "clicked" - This is called when a user has clicked the bubble.
9942 * For an example of using a buble see @ref bubble_01_example_page "this".
9947 * Add a new bubble to the parent
9949 * @param parent The parent object
9950 * @return The new object or NULL if it cannot be created
9952 * This function adds a text bubble to the given parent evas object.
9954 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9956 * Set the label of the bubble
9958 * @param obj The bubble object
9959 * @param label The string to set in the label
9961 * This function sets the title of the bubble. Where this appears depends on
9962 * the selected corner.
9963 * @deprecated use elm_object_text_set() instead.
9965 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9967 * Get the label of the bubble
9969 * @param obj The bubble object
9970 * @return The string of set in the label
9972 * This function gets the title of the bubble.
9973 * @deprecated use elm_object_text_get() instead.
9975 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9977 * Set the info of the bubble
9979 * @param obj The bubble object
9980 * @param info The given info about the bubble
9982 * This function sets the info of the bubble. Where this appears depends on
9983 * the selected corner.
9984 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
9986 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9988 * Get the info of the bubble
9990 * @param obj The bubble object
9992 * @return The "info" string of the bubble
9994 * This function gets the info text.
9995 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
9997 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9999 * Set the content to be shown in the bubble
10001 * Once the content object is set, a previously set one will be deleted.
10002 * If you want to keep the old content object, use the
10003 * elm_bubble_content_unset() function.
10005 * @param obj The bubble object
10006 * @param content The given content of the bubble
10008 * This function sets the content shown on the middle of the bubble.
10010 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10012 * Get the content shown in the bubble
10014 * Return the content object which is set for this widget.
10016 * @param obj The bubble object
10017 * @return The content that is being used
10019 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10021 * Unset the content shown in the bubble
10023 * Unparent and return the content object which was set for this widget.
10025 * @param obj The bubble object
10026 * @return The content that was being used
10028 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10030 * Set the icon of the bubble
10032 * Once the icon object is set, a previously set one will be deleted.
10033 * If you want to keep the old content object, use the
10034 * elm_icon_content_unset() function.
10036 * @param obj The bubble object
10037 * @param icon The given icon for the bubble
10039 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10041 * Get the icon of the bubble
10043 * @param obj The bubble object
10044 * @return The icon for the bubble
10046 * This function gets the icon shown on the top left of bubble.
10048 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10050 * Unset the icon of the bubble
10052 * Unparent and return the icon object which was set for this widget.
10054 * @param obj The bubble object
10055 * @return The icon that was being used
10057 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10059 * Set the corner of the bubble
10061 * @param obj The bubble object.
10062 * @param corner The given corner for the bubble.
10064 * This function sets the corner of the bubble. The corner will be used to
10065 * determine where the arrow in the frame points to and where label, icon and
10068 * Possible values for corner are:
10069 * @li "top_left" - Default
10071 * @li "bottom_left"
10072 * @li "bottom_right"
10074 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
10076 * Get the corner of the bubble
10078 * @param obj The bubble object.
10079 * @return The given corner for the bubble.
10081 * This function gets the selected corner of the bubble.
10083 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10089 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10090 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
10091 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
10092 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
10093 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
10094 /* smart callbacks called:
10095 * "clicked" - the user clicked the icon
10096 * "drag,start" - Someone started dragging the image out of the object
10097 * "drag,end" - Dragged item was dropped (somewhere)
10100 /* gesture layer */
10102 * @defgroup Elm_Gesture_Layer Gesture Layer
10103 * Gesture Layer Usage:
10105 * Use Gesture Layer to detect gestures.
10106 * The advantage is that you don't have to implement
10107 * gesture detection, just set callbacks of gesture state.
10108 * By using gesture layer we make standard interface.
10110 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
10111 * with a parent object parameter.
10112 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
10113 * call. Usually with same object as target (2nd parameter).
10115 * Now you need to tell gesture layer what gestures you follow.
10116 * This is done with @ref elm_gesture_layer_cb_set call.
10117 * By setting the callback you actually saying to gesture layer:
10118 * I would like to know when the gesture @ref Elm_Gesture_Types
10119 * switches to state @ref Elm_Gesture_State.
10121 * Next, you need to implement the actual action that follows the input
10122 * in your callback.
10124 * Note that if you like to stop being reported about a gesture, just set
10125 * all callbacks referring this gesture to NULL.
10126 * (again with @ref elm_gesture_layer_cb_set)
10128 * The information reported by gesture layer to your callback is depending
10129 * on @ref Elm_Gesture_Types:
10130 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
10131 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
10132 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
10134 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
10135 * @ref ELM_GESTURE_MOMENTUM.
10137 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
10138 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
10139 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
10140 * Note that we consider a flick as a line-gesture that should be completed
10141 * in flick-time-limit as defined in @ref Config.
10143 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
10145 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
10149 * @enum _Elm_Gesture_Types
10150 * Enum of supported gesture types.
10151 * @ingroup Elm_Gesture_Layer
10153 enum _Elm_Gesture_Types
10155 ELM_GESTURE_FIRST = 0,
10157 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
10158 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
10159 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
10160 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
10162 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
10164 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
10165 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
10167 ELM_GESTURE_ZOOM, /**< Zoom */
10168 ELM_GESTURE_ROTATE, /**< Rotate */
10174 * @typedef Elm_Gesture_Types
10175 * gesture types enum
10176 * @ingroup Elm_Gesture_Layer
10178 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
10181 * @enum _Elm_Gesture_State
10182 * Enum of gesture states.
10183 * @ingroup Elm_Gesture_Layer
10185 enum _Elm_Gesture_State
10187 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
10188 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
10189 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
10190 ELM_GESTURE_STATE_END, /**< Gesture completed */
10191 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
10195 * @typedef Elm_Gesture_State
10196 * gesture states enum
10197 * @ingroup Elm_Gesture_Layer
10199 typedef enum _Elm_Gesture_State Elm_Gesture_State;
10202 * @struct _Elm_Gesture_Taps_Info
10203 * Struct holds taps info for user
10204 * @ingroup Elm_Gesture_Layer
10206 struct _Elm_Gesture_Taps_Info
10208 Evas_Coord x, y; /**< Holds center point between fingers */
10209 unsigned int n; /**< Number of fingers tapped */
10210 unsigned int timestamp; /**< event timestamp */
10214 * @typedef Elm_Gesture_Taps_Info
10215 * holds taps info for user
10216 * @ingroup Elm_Gesture_Layer
10218 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10221 * @struct _Elm_Gesture_Momentum_Info
10222 * Struct holds momentum info for user
10223 * x1 and y1 are not necessarily in sync
10224 * x1 holds x value of x direction starting point
10225 * and same holds for y1.
10226 * This is noticeable when doing V-shape movement
10227 * @ingroup Elm_Gesture_Layer
10229 struct _Elm_Gesture_Momentum_Info
10230 { /* Report line ends, timestamps, and momentum computed */
10231 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10232 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10233 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10234 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10236 unsigned int tx; /**< Timestamp of start of final x-swipe */
10237 unsigned int ty; /**< Timestamp of start of final y-swipe */
10239 Evas_Coord mx; /**< Momentum on X */
10240 Evas_Coord my; /**< Momentum on Y */
10244 * @typedef Elm_Gesture_Momentum_Info
10245 * holds momentum info for user
10246 * @ingroup Elm_Gesture_Layer
10248 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10251 * @struct _Elm_Gesture_Line_Info
10252 * Struct holds line info for user
10253 * @ingroup Elm_Gesture_Layer
10255 struct _Elm_Gesture_Line_Info
10256 { /* Report line ends, timestamps, and momentum computed */
10257 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10258 unsigned int n; /**< Number of fingers (lines) */
10259 /* FIXME should be radians, bot degrees */
10260 double angle; /**< Angle (direction) of lines */
10264 * @typedef Elm_Gesture_Line_Info
10265 * Holds line info for user
10266 * @ingroup Elm_Gesture_Layer
10268 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10271 * @struct _Elm_Gesture_Zoom_Info
10272 * Struct holds zoom info for user
10273 * @ingroup Elm_Gesture_Layer
10275 struct _Elm_Gesture_Zoom_Info
10277 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10278 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10279 double zoom; /**< Zoom value: 1.0 means no zoom */
10280 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10284 * @typedef Elm_Gesture_Zoom_Info
10285 * Holds zoom info for user
10286 * @ingroup Elm_Gesture_Layer
10288 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10291 * @struct _Elm_Gesture_Rotate_Info
10292 * Struct holds rotation info for user
10293 * @ingroup Elm_Gesture_Layer
10295 struct _Elm_Gesture_Rotate_Info
10297 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10298 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10299 double base_angle; /**< Holds start-angle */
10300 double angle; /**< Rotation value: 0.0 means no rotation */
10301 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10305 * @typedef Elm_Gesture_Rotate_Info
10306 * Holds rotation info for user
10307 * @ingroup Elm_Gesture_Layer
10309 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10312 * @typedef Elm_Gesture_Event_Cb
10313 * User callback used to stream gesture info from gesture layer
10314 * @param data user data
10315 * @param event_info gesture report info
10316 * Returns a flag field to be applied on the causing event.
10317 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10318 * upon the event, in an irreversible way.
10320 * @ingroup Elm_Gesture_Layer
10322 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10325 * Use function to set callbacks to be notified about
10326 * change of state of gesture.
10327 * When a user registers a callback with this function
10328 * this means this gesture has to be tested.
10330 * When ALL callbacks for a gesture are set to NULL
10331 * it means user isn't interested in gesture-state
10332 * and it will not be tested.
10334 * @param obj Pointer to gesture-layer.
10335 * @param idx The gesture you would like to track its state.
10336 * @param cb callback function pointer.
10337 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10338 * @param data user info to be sent to callback (usually, Smart Data)
10340 * @ingroup Elm_Gesture_Layer
10342 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);
10345 * Call this function to get repeat-events settings.
10347 * @param obj Pointer to gesture-layer.
10349 * @return repeat events settings.
10350 * @see elm_gesture_layer_hold_events_set()
10351 * @ingroup Elm_Gesture_Layer
10353 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10356 * This function called in order to make gesture-layer repeat events.
10357 * Set this of you like to get the raw events only if gestures were not detected.
10358 * Clear this if you like gesture layer to fwd events as testing gestures.
10360 * @param obj Pointer to gesture-layer.
10361 * @param r Repeat: TRUE/FALSE
10363 * @ingroup Elm_Gesture_Layer
10365 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10368 * This function sets step-value for zoom action.
10369 * Set step to any positive value.
10370 * Cancel step setting by setting to 0.0
10372 * @param obj Pointer to gesture-layer.
10373 * @param s new zoom step value.
10375 * @ingroup Elm_Gesture_Layer
10377 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10380 * This function sets step-value for rotate action.
10381 * Set step to any positive value.
10382 * Cancel step setting by setting to 0.0
10384 * @param obj Pointer to gesture-layer.
10385 * @param s new roatate step value.
10387 * @ingroup Elm_Gesture_Layer
10389 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10392 * This function called to attach gesture-layer to an Evas_Object.
10393 * @param obj Pointer to gesture-layer.
10394 * @param t Pointer to underlying object (AKA Target)
10396 * @return TRUE, FALSE on success, failure.
10398 * @ingroup Elm_Gesture_Layer
10400 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10403 * Call this function to construct a new gesture-layer object.
10404 * This does not activate the gesture layer. You have to
10405 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10407 * @param parent the parent object.
10409 * @return Pointer to new gesture-layer object.
10411 * @ingroup Elm_Gesture_Layer
10413 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10416 * @defgroup Thumb Thumb
10418 * @image html img/widget/thumb/preview-00.png
10419 * @image latex img/widget/thumb/preview-00.eps
10421 * A thumb object is used for displaying the thumbnail of an image or video.
10422 * You must have compiled Elementary with Ethumb_Client support and the DBus
10423 * service must be present and auto-activated in order to have thumbnails to
10426 * Once the thumbnail object becomes visible, it will check if there is a
10427 * previously generated thumbnail image for the file set on it. If not, it
10428 * will start generating this thumbnail.
10430 * Different config settings will cause different thumbnails to be generated
10431 * even on the same file.
10433 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10434 * Ethumb documentation to change this path, and to see other configuration
10437 * Signals that you can add callbacks for are:
10439 * - "clicked" - This is called when a user has clicked the thumb without dragging
10441 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10442 * - "press" - This is called when a user has pressed down the thumb.
10443 * - "generate,start" - The thumbnail generation started.
10444 * - "generate,stop" - The generation process stopped.
10445 * - "generate,error" - The generation failed.
10446 * - "load,error" - The thumbnail image loading failed.
10448 * available styles:
10452 * An example of use of thumbnail:
10454 * - @ref thumb_example_01
10458 * @addtogroup Thumb
10463 * @enum _Elm_Thumb_Animation_Setting
10464 * @typedef Elm_Thumb_Animation_Setting
10466 * Used to set if a video thumbnail is animating or not.
10470 typedef enum _Elm_Thumb_Animation_Setting
10472 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10473 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10474 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10475 ELM_THUMB_ANIMATION_LAST
10476 } Elm_Thumb_Animation_Setting;
10479 * Add a new thumb object to the parent.
10481 * @param parent The parent object.
10482 * @return The new object or NULL if it cannot be created.
10484 * @see elm_thumb_file_set()
10485 * @see elm_thumb_ethumb_client_get()
10489 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10491 * Reload thumbnail if it was generated before.
10493 * @param obj The thumb object to reload
10495 * This is useful if the ethumb client configuration changed, like its
10496 * size, aspect or any other property one set in the handle returned
10497 * by elm_thumb_ethumb_client_get().
10499 * If the options didn't change, the thumbnail won't be generated again, but
10500 * the old one will still be used.
10502 * @see elm_thumb_file_set()
10506 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10508 * Set the file that will be used as thumbnail.
10510 * @param obj The thumb object.
10511 * @param file The path to file that will be used as thumb.
10512 * @param key The key used in case of an EET file.
10514 * The file can be an image or a video (in that case, acceptable extensions are:
10515 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10516 * function elm_thumb_animate().
10518 * @see elm_thumb_file_get()
10519 * @see elm_thumb_reload()
10520 * @see elm_thumb_animate()
10524 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10526 * Get the image or video path and key used to generate the thumbnail.
10528 * @param obj The thumb object.
10529 * @param file Pointer to filename.
10530 * @param key Pointer to key.
10532 * @see elm_thumb_file_set()
10533 * @see elm_thumb_path_get()
10537 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10539 * Get the path and key to the image or video generated by ethumb.
10541 * One just need to make sure that the thumbnail was generated before getting
10542 * its path; otherwise, the path will be NULL. One way to do that is by asking
10543 * for the path when/after the "generate,stop" smart callback is called.
10545 * @param obj The thumb object.
10546 * @param file Pointer to thumb path.
10547 * @param key Pointer to thumb key.
10549 * @see elm_thumb_file_get()
10553 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10555 * Set the animation state for the thumb object. If its content is an animated
10556 * video, you may start/stop the animation or tell it to play continuously and
10559 * @param obj The thumb object.
10560 * @param setting The animation setting.
10562 * @see elm_thumb_file_set()
10566 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10568 * Get the animation state for the thumb object.
10570 * @param obj The thumb object.
10571 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10574 * @see elm_thumb_animate_set()
10578 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10580 * Get the ethumb_client handle so custom configuration can be made.
10582 * @return Ethumb_Client instance or NULL.
10584 * This must be called before the objects are created to be sure no object is
10585 * visible and no generation started.
10587 * Example of usage:
10590 * #include <Elementary.h>
10591 * #ifndef ELM_LIB_QUICKLAUNCH
10593 * elm_main(int argc, char **argv)
10595 * Ethumb_Client *client;
10597 * elm_need_ethumb();
10601 * client = elm_thumb_ethumb_client_get();
10604 * ERR("could not get ethumb_client");
10607 * ethumb_client_size_set(client, 100, 100);
10608 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10611 * // Create elm_thumb objects here
10621 * @note There's only one client handle for Ethumb, so once a configuration
10622 * change is done to it, any other request for thumbnails (for any thumbnail
10623 * object) will use that configuration. Thus, this configuration is global.
10627 EAPI void *elm_thumb_ethumb_client_get(void);
10629 * Get the ethumb_client connection state.
10631 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10634 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10636 * Make the thumbnail 'editable'.
10638 * @param obj Thumb object.
10639 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10641 * This means the thumbnail is a valid drag target for drag and drop, and can be
10642 * cut or pasted too.
10644 * @see elm_thumb_editable_get()
10648 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10650 * Make the thumbnail 'editable'.
10652 * @param obj Thumb object.
10653 * @return Editability.
10655 * This means the thumbnail is a valid drag target for drag and drop, and can be
10656 * cut or pasted too.
10658 * @see elm_thumb_editable_set()
10662 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10669 * @defgroup Hoversel Hoversel
10671 * @image html img/widget/hoversel/preview-00.png
10672 * @image latex img/widget/hoversel/preview-00.eps
10674 * A hoversel is a button that pops up a list of items (automatically
10675 * choosing the direction to display) that have a label and, optionally, an
10676 * icon to select from. It is a convenience widget to avoid the need to do
10677 * all the piecing together yourself. It is intended for a small number of
10678 * items in the hoversel menu (no more than 8), though is capable of many
10681 * Signals that you can add callbacks for are:
10682 * "clicked" - the user clicked the hoversel button and popped up the sel
10683 * "selected" - an item in the hoversel list is selected. event_info is the item
10684 * "dismissed" - the hover is dismissed
10686 * See @ref tutorial_hoversel for an example.
10689 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10691 * @brief Add a new Hoversel object
10693 * @param parent The parent object
10694 * @return The new object or NULL if it cannot be created
10696 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10698 * @brief This sets the hoversel to expand horizontally.
10700 * @param obj The hoversel object
10701 * @param horizontal If true, the hover will expand horizontally to the
10704 * @note The initial button will display horizontally regardless of this
10707 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10709 * @brief This returns whether the hoversel is set to expand horizontally.
10711 * @param obj The hoversel object
10712 * @return If true, the hover will expand horizontally to the right.
10714 * @see elm_hoversel_horizontal_set()
10716 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10718 * @brief Set the Hover parent
10720 * @param obj The hoversel object
10721 * @param parent The parent to use
10723 * Sets the hover parent object, the area that will be darkened when the
10724 * hoversel is clicked. Should probably be the window that the hoversel is
10725 * in. See @ref Hover objects for more information.
10727 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10729 * @brief Get the Hover parent
10731 * @param obj The hoversel object
10732 * @return The used parent
10734 * Gets the hover parent object.
10736 * @see elm_hoversel_hover_parent_set()
10738 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10740 * @brief Set the hoversel button label
10742 * @param obj The hoversel object
10743 * @param label The label text.
10745 * This sets the label of the button that is always visible (before it is
10746 * clicked and expanded).
10748 * @deprecated elm_object_text_set()
10750 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10752 * @brief Get the hoversel button label
10754 * @param obj The hoversel object
10755 * @return The label text.
10757 * @deprecated elm_object_text_get()
10759 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10761 * @brief Set the icon of the hoversel button
10763 * @param obj The hoversel object
10764 * @param icon The icon object
10766 * Sets the icon of the button that is always visible (before it is clicked
10767 * and expanded). Once the icon object is set, a previously set one will be
10768 * deleted, if you want to keep that old content object, use the
10769 * elm_hoversel_icon_unset() function.
10771 * @see elm_button_icon_set()
10773 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10775 * @brief Get the icon of the hoversel button
10777 * @param obj The hoversel object
10778 * @return The icon object
10780 * Get the icon of the button that is always visible (before it is clicked
10781 * and expanded). Also see elm_button_icon_get().
10783 * @see elm_hoversel_icon_set()
10785 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10787 * @brief Get and unparent the icon of the hoversel button
10789 * @param obj The hoversel object
10790 * @return The icon object that was being used
10792 * Unparent and return the icon of the button that is always visible
10793 * (before it is clicked and expanded).
10795 * @see elm_hoversel_icon_set()
10796 * @see elm_button_icon_unset()
10798 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10800 * @brief This triggers the hoversel popup from code, the same as if the user
10801 * had clicked the button.
10803 * @param obj The hoversel object
10805 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10807 * @brief This dismisses the hoversel popup as if the user had clicked
10808 * outside the hover.
10810 * @param obj The hoversel object
10812 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10814 * @brief Returns whether the hoversel is expanded.
10816 * @param obj The hoversel object
10817 * @return This will return EINA_TRUE if the hoversel is expanded or
10818 * EINA_FALSE if it is not expanded.
10820 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10822 * @brief This will remove all the children items from the hoversel.
10824 * @param obj The hoversel object
10826 * @warning Should @b not be called while the hoversel is active; use
10827 * elm_hoversel_expanded_get() to check first.
10829 * @see elm_hoversel_item_del_cb_set()
10830 * @see elm_hoversel_item_del()
10832 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10834 * @brief Get the list of items within the given hoversel.
10836 * @param obj The hoversel object
10837 * @return Returns a list of Elm_Hoversel_Item*
10839 * @see elm_hoversel_item_add()
10841 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10843 * @brief Add an item to the hoversel button
10845 * @param obj The hoversel object
10846 * @param label The text label to use for the item (NULL if not desired)
10847 * @param icon_file An image file path on disk to use for the icon or standard
10848 * icon name (NULL if not desired)
10849 * @param icon_type The icon type if relevant
10850 * @param func Convenience function to call when this item is selected
10851 * @param data Data to pass to item-related functions
10852 * @return A handle to the item added.
10854 * This adds an item to the hoversel to show when it is clicked. Note: if you
10855 * need to use an icon from an edje file then use
10856 * elm_hoversel_item_icon_set() right after the this function, and set
10857 * icon_file to NULL here.
10859 * For more information on what @p icon_file and @p icon_type are see the
10860 * @ref Icon "icon documentation".
10862 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);
10864 * @brief Delete an item from the hoversel
10866 * @param item The item to delete
10868 * This deletes the item from the hoversel (should not be called while the
10869 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10871 * @see elm_hoversel_item_add()
10872 * @see elm_hoversel_item_del_cb_set()
10874 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10876 * @brief Set the function to be called when an item from the hoversel is
10879 * @param item The item to set the callback on
10880 * @param func The function called
10882 * That function will receive these parameters:
10883 * @li void *item_data
10884 * @li Evas_Object *the_item_object
10885 * @li Elm_Hoversel_Item *the_object_struct
10887 * @see elm_hoversel_item_add()
10889 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10891 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10892 * that will be passed to associated function callbacks.
10894 * @param item The item to get the data from
10895 * @return The data pointer set with elm_hoversel_item_add()
10897 * @see elm_hoversel_item_add()
10899 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10901 * @brief This returns the label text of the given hoversel item.
10903 * @param item The item to get the label
10904 * @return The label text of the hoversel item
10906 * @see elm_hoversel_item_add()
10908 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10910 * @brief This sets the icon for the given hoversel item.
10912 * @param item The item to set the icon
10913 * @param icon_file An image file path on disk to use for the icon or standard
10915 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10916 * to NULL if the icon is not an edje file
10917 * @param icon_type The icon type
10919 * The icon can be loaded from the standard set, from an image file, or from
10922 * @see elm_hoversel_item_add()
10924 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);
10926 * @brief Get the icon object of the hoversel item
10928 * @param item The item to get the icon from
10929 * @param icon_file The image file path on disk used for the icon or standard
10931 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10932 * if the icon is not an edje file
10933 * @param icon_type The icon type
10935 * @see elm_hoversel_item_icon_set()
10936 * @see elm_hoversel_item_add()
10938 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);
10944 * @defgroup Toolbar Toolbar
10945 * @ingroup Elementary
10947 * @image html img/widget/toolbar/preview-00.png
10948 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10950 * @image html img/toolbar.png
10951 * @image latex img/toolbar.eps width=\textwidth
10953 * A toolbar is a widget that displays a list of items inside
10954 * a box. It can be scrollable, show a menu with items that don't fit
10955 * to toolbar size or even crop them.
10957 * Only one item can be selected at a time.
10959 * Items can have multiple states, or show menus when selected by the user.
10961 * Smart callbacks one can listen to:
10962 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10964 * Available styles for it:
10966 * - @c "transparent" - no background or shadow, just show the content
10968 * List of examples:
10969 * @li @ref toolbar_example_01
10970 * @li @ref toolbar_example_02
10971 * @li @ref toolbar_example_03
10975 * @addtogroup Toolbar
10980 * @enum _Elm_Toolbar_Shrink_Mode
10981 * @typedef Elm_Toolbar_Shrink_Mode
10983 * Set toolbar's items display behavior, it can be scrollabel,
10984 * show a menu with exceeding items, or simply hide them.
10986 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10989 * Values <b> don't </b> work as bitmask, only one can be choosen.
10991 * @see elm_toolbar_mode_shrink_set()
10992 * @see elm_toolbar_mode_shrink_get()
10996 typedef enum _Elm_Toolbar_Shrink_Mode
10998 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10999 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
11000 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
11001 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
11002 } Elm_Toolbar_Shrink_Mode;
11004 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(). */
11006 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(). */
11009 * Add a new toolbar widget to the given parent Elementary
11010 * (container) object.
11012 * @param parent The parent object.
11013 * @return a new toolbar widget handle or @c NULL, on errors.
11015 * This function inserts a new toolbar widget on the canvas.
11019 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11022 * Set the icon size, in pixels, to be used by toolbar items.
11024 * @param obj The toolbar object
11025 * @param icon_size The icon size in pixels
11027 * @note Default value is @c 32. It reads value from elm config.
11029 * @see elm_toolbar_icon_size_get()
11033 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
11036 * Get the icon size, in pixels, to be used by toolbar items.
11038 * @param obj The toolbar object.
11039 * @return The icon size in pixels.
11041 * @see elm_toolbar_icon_size_set() for details.
11045 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11048 * Sets icon lookup order, for toolbar items' icons.
11050 * @param obj The toolbar object.
11051 * @param order The icon lookup order.
11053 * Icons added before calling this function will not be affected.
11054 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
11056 * @see elm_toolbar_icon_order_lookup_get()
11060 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
11063 * Gets the icon lookup order.
11065 * @param obj The toolbar object.
11066 * @return The icon lookup order.
11068 * @see elm_toolbar_icon_order_lookup_set() for details.
11072 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11075 * Set whether the toolbar items' should be selected by the user or not.
11077 * @param obj The toolbar object.
11078 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
11081 * This will turn off the ability to select items entirely and they will
11082 * neither appear selected nor emit selected signals. The clicked
11083 * callback function will still be called.
11085 * Selection is enabled by default.
11087 * @see elm_toolbar_no_select_mode_get().
11091 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
11094 * Set whether the toolbar items' should be selected by the user or not.
11096 * @param obj The toolbar object.
11097 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
11098 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
11100 * @see elm_toolbar_no_select_mode_set() for details.
11104 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11107 * Append item to the toolbar.
11109 * @param obj The toolbar object.
11110 * @param icon A string with icon name or the absolute path of an image file.
11111 * @param label The label of the item.
11112 * @param func The function to call when the item is clicked.
11113 * @param data The data to associate with the item for related callbacks.
11114 * @return The created item or @c NULL upon failure.
11116 * A new item will be created and appended to the toolbar, i.e., will
11117 * be set as @b last item.
11119 * Items created with this method can be deleted with
11120 * elm_toolbar_item_del().
11122 * Associated @p data can be properly freed when item is deleted if a
11123 * callback function is set with elm_toolbar_item_del_cb_set().
11125 * If a function is passed as argument, it will be called everytime this item
11126 * is selected, i.e., the user clicks over an unselected item.
11127 * If such function isn't needed, just passing
11128 * @c NULL as @p func is enough. The same should be done for @p data.
11130 * Toolbar will load icon image from fdo or current theme.
11131 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11132 * If an absolute path is provided it will load it direct from a file.
11134 * @see elm_toolbar_item_icon_set()
11135 * @see elm_toolbar_item_del()
11136 * @see elm_toolbar_item_del_cb_set()
11140 EAPI Elm_Toolbar_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
11143 * Prepend item to the toolbar.
11145 * @param obj The toolbar object.
11146 * @param icon A string with icon name or the absolute path of an image file.
11147 * @param label The label of the item.
11148 * @param func The function to call when the item is clicked.
11149 * @param data The data to associate with the item for related callbacks.
11150 * @return The created item or @c NULL upon failure.
11152 * A new item will be created and prepended to the toolbar, i.e., will
11153 * be set as @b first item.
11155 * Items created with this method can be deleted with
11156 * elm_toolbar_item_del().
11158 * Associated @p data can be properly freed when item is deleted if a
11159 * callback function is set with elm_toolbar_item_del_cb_set().
11161 * If a function is passed as argument, it will be called everytime this item
11162 * is selected, i.e., the user clicks over an unselected item.
11163 * If such function isn't needed, just passing
11164 * @c NULL as @p func is enough. The same should be done for @p data.
11166 * Toolbar will load icon image from fdo or current theme.
11167 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11168 * If an absolute path is provided it will load it direct from a file.
11170 * @see elm_toolbar_item_icon_set()
11171 * @see elm_toolbar_item_del()
11172 * @see elm_toolbar_item_del_cb_set()
11176 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);
11179 * Insert a new item into the toolbar object before item @p before.
11181 * @param obj The toolbar object.
11182 * @param before The toolbar item to insert before.
11183 * @param icon A string with icon name or the absolute path of an image file.
11184 * @param label The label of the item.
11185 * @param func The function to call when the item is clicked.
11186 * @param data The data to associate with the item for related callbacks.
11187 * @return The created item or @c NULL upon failure.
11189 * A new item will be created and added to the toolbar. Its position in
11190 * this toolbar will be just before item @p before.
11192 * Items created with this method can be deleted with
11193 * elm_toolbar_item_del().
11195 * Associated @p data can be properly freed when item is deleted if a
11196 * callback function is set with elm_toolbar_item_del_cb_set().
11198 * If a function is passed as argument, it will be called everytime this item
11199 * is selected, i.e., the user clicks over an unselected item.
11200 * If such function isn't needed, just passing
11201 * @c NULL as @p func is enough. The same should be done for @p data.
11203 * Toolbar will load icon image from fdo or current theme.
11204 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11205 * If an absolute path is provided it will load it direct from a file.
11207 * @see elm_toolbar_item_icon_set()
11208 * @see elm_toolbar_item_del()
11209 * @see elm_toolbar_item_del_cb_set()
11213 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);
11216 * Insert a new item into the toolbar object after item @p after.
11218 * @param obj The toolbar object.
11219 * @param before The toolbar item to insert before.
11220 * @param icon A string with icon name or the absolute path of an image file.
11221 * @param label The label of the item.
11222 * @param func The function to call when the item is clicked.
11223 * @param data The data to associate with the item for related callbacks.
11224 * @return The created item or @c NULL upon failure.
11226 * A new item will be created and added to the toolbar. Its position in
11227 * this toolbar will be just after item @p after.
11229 * Items created with this method can be deleted with
11230 * elm_toolbar_item_del().
11232 * Associated @p data can be properly freed when item is deleted if a
11233 * callback function is set with elm_toolbar_item_del_cb_set().
11235 * If a function is passed as argument, it will be called everytime this item
11236 * is selected, i.e., the user clicks over an unselected item.
11237 * If such function isn't needed, just passing
11238 * @c NULL as @p func is enough. The same should be done for @p data.
11240 * Toolbar will load icon image from fdo or current theme.
11241 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11242 * If an absolute path is provided it will load it direct from a file.
11244 * @see elm_toolbar_item_icon_set()
11245 * @see elm_toolbar_item_del()
11246 * @see elm_toolbar_item_del_cb_set()
11250 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);
11253 * Get the first item in the given toolbar widget's list of
11256 * @param obj The toolbar object
11257 * @return The first item or @c NULL, if it has no items (and on
11260 * @see elm_toolbar_item_append()
11261 * @see elm_toolbar_last_item_get()
11265 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11268 * Get the last item in the given toolbar widget's list of
11271 * @param obj The toolbar object
11272 * @return The last item or @c NULL, if it has no items (and on
11275 * @see elm_toolbar_item_prepend()
11276 * @see elm_toolbar_first_item_get()
11280 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11283 * Get the item after @p item in toolbar.
11285 * @param item The toolbar item.
11286 * @return The item after @p item, or @c NULL if none or on failure.
11288 * @note If it is the last item, @c NULL will be returned.
11290 * @see elm_toolbar_item_append()
11294 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11297 * Get the item before @p item in toolbar.
11299 * @param item The toolbar item.
11300 * @return The item before @p item, or @c NULL if none or on failure.
11302 * @note If it is the first item, @c NULL will be returned.
11304 * @see elm_toolbar_item_prepend()
11308 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11311 * Get the toolbar object from an item.
11313 * @param item The item.
11314 * @return The toolbar object.
11316 * This returns the toolbar object itself that an item belongs to.
11320 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11323 * Set the priority of a toolbar item.
11325 * @param item The toolbar item.
11326 * @param priority The item priority. The default is zero.
11328 * This is used only when the toolbar shrink mode is set to
11329 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11330 * When space is less than required, items with low priority
11331 * will be removed from the toolbar and added to a dynamically-created menu,
11332 * while items with higher priority will remain on the toolbar,
11333 * with the same order they were added.
11335 * @see elm_toolbar_item_priority_get()
11339 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11342 * Get the priority of a toolbar item.
11344 * @param item The toolbar item.
11345 * @return The @p item priority, or @c 0 on failure.
11347 * @see elm_toolbar_item_priority_set() for details.
11351 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11354 * Get the label of item.
11356 * @param item The item of toolbar.
11357 * @return The label of item.
11359 * The return value is a pointer to the label associated to @p item when
11360 * it was created, with function elm_toolbar_item_append() or similar,
11362 * with function elm_toolbar_item_label_set. If no label
11363 * was passed as argument, it will return @c NULL.
11365 * @see elm_toolbar_item_label_set() for more details.
11366 * @see elm_toolbar_item_append()
11370 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11373 * Set the label of item.
11375 * @param item The item of toolbar.
11376 * @param text The label of item.
11378 * The label to be displayed by the item.
11379 * Label will be placed at icons bottom (if set).
11381 * If a label was passed as argument on item creation, with function
11382 * elm_toolbar_item_append() or similar, it will be already
11383 * displayed by the item.
11385 * @see elm_toolbar_item_label_get()
11386 * @see elm_toolbar_item_append()
11390 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11393 * Return the data associated with a given toolbar widget item.
11395 * @param item The toolbar widget item handle.
11396 * @return The data associated with @p item.
11398 * @see elm_toolbar_item_data_set()
11402 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11405 * Set the data associated with a given toolbar widget item.
11407 * @param item The toolbar widget item handle.
11408 * @param data The new data pointer to set to @p item.
11410 * This sets new item data on @p item.
11412 * @warning The old data pointer won't be touched by this function, so
11413 * the user had better to free that old data himself/herself.
11417 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11420 * Returns a pointer to a toolbar item by its label.
11422 * @param obj The toolbar object.
11423 * @param label The label of the item to find.
11425 * @return The pointer to the toolbar item matching @p label or @c NULL
11430 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11433 * Get whether the @p item is selected or not.
11435 * @param item The toolbar item.
11436 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11437 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11439 * @see elm_toolbar_selected_item_set() for details.
11440 * @see elm_toolbar_item_selected_get()
11444 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11447 * Set the selected state of an item.
11449 * @param item The toolbar item
11450 * @param selected The selected state
11452 * This sets the selected state of the given item @p it.
11453 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11455 * If a new item is selected the previosly selected will be unselected.
11456 * Previoulsy selected item can be get with function
11457 * elm_toolbar_selected_item_get().
11459 * Selected items will be highlighted.
11461 * @see elm_toolbar_item_selected_get()
11462 * @see elm_toolbar_selected_item_get()
11466 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11469 * Get the selected item.
11471 * @param obj The toolbar object.
11472 * @return The selected toolbar item.
11474 * The selected item can be unselected with function
11475 * elm_toolbar_item_selected_set().
11477 * The selected item always will be highlighted on toolbar.
11479 * @see elm_toolbar_selected_items_get()
11483 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11486 * Set the icon associated with @p item.
11488 * @param obj The parent of this item.
11489 * @param item The toolbar item.
11490 * @param icon A string with icon name or the absolute path of an image file.
11492 * Toolbar will load icon image from fdo or current theme.
11493 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11494 * If an absolute path is provided it will load it direct from a file.
11496 * @see elm_toolbar_icon_order_lookup_set()
11497 * @see elm_toolbar_icon_order_lookup_get()
11501 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11504 * Get the string used to set the icon of @p item.
11506 * @param item The toolbar item.
11507 * @return The string associated with the icon object.
11509 * @see elm_toolbar_item_icon_set() for details.
11513 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11516 * Delete them item from the toolbar.
11518 * @param item The item of toolbar to be deleted.
11520 * @see elm_toolbar_item_append()
11521 * @see elm_toolbar_item_del_cb_set()
11525 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11528 * Set the function called when a toolbar item is freed.
11530 * @param item The item to set the callback on.
11531 * @param func The function called.
11533 * If there is a @p func, then it will be called prior item's memory release.
11534 * That will be called with the following arguments:
11536 * @li item's Evas object;
11539 * This way, a data associated to a toolbar item could be properly freed.
11543 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11546 * Get a value whether toolbar item is disabled or not.
11548 * @param item The item.
11549 * @return The disabled state.
11551 * @see elm_toolbar_item_disabled_set() for more details.
11555 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11558 * Sets the disabled/enabled state of a toolbar item.
11560 * @param item The item.
11561 * @param disabled The disabled state.
11563 * A disabled item cannot be selected or unselected. It will also
11564 * change its appearance (generally greyed out). This sets the
11565 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11570 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11573 * Set or unset item as a separator.
11575 * @param item The toolbar item.
11576 * @param setting @c EINA_TRUE to set item @p item as separator or
11577 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11579 * Items aren't set as separator by default.
11581 * If set as separator it will display separator theme, so won't display
11584 * @see elm_toolbar_item_separator_get()
11588 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11591 * Get a value whether item is a separator or not.
11593 * @param item The toolbar item.
11594 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11595 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11597 * @see elm_toolbar_item_separator_set() for details.
11601 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11604 * Set the shrink state of toolbar @p obj.
11606 * @param obj The toolbar object.
11607 * @param shrink_mode Toolbar's items display behavior.
11609 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11610 * but will enforce a minimun size so all the items will fit, won't scroll
11611 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11612 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11613 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11617 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11620 * Get the shrink mode of toolbar @p obj.
11622 * @param obj The toolbar object.
11623 * @return Toolbar's items display behavior.
11625 * @see elm_toolbar_mode_shrink_set() for details.
11629 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11632 * Enable/disable homogenous mode.
11634 * @param obj The toolbar object
11635 * @param homogeneous Assume the items within the toolbar are of the
11636 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11638 * This will enable the homogeneous mode where items are of the same size.
11639 * @see elm_toolbar_homogeneous_get()
11643 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11646 * Get whether the homogenous mode is enabled.
11648 * @param obj The toolbar object.
11649 * @return Assume the items within the toolbar are of the same height
11650 * and width (EINA_TRUE = on, EINA_FALSE = off).
11652 * @see elm_toolbar_homogeneous_set()
11656 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11659 * Enable/disable homogenous mode.
11661 * @param obj The toolbar object
11662 * @param homogeneous Assume the items within the toolbar are of the
11663 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11665 * This will enable the homogeneous mode where items are of the same size.
11666 * @see elm_toolbar_homogeneous_get()
11668 * @deprecated use elm_toolbar_homogeneous_set() instead.
11672 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11675 * Get whether the homogenous mode is enabled.
11677 * @param obj The toolbar object.
11678 * @return Assume the items within the toolbar are of the same height
11679 * and width (EINA_TRUE = on, EINA_FALSE = off).
11681 * @see elm_toolbar_homogeneous_set()
11682 * @deprecated use elm_toolbar_homogeneous_get() instead.
11686 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11689 * Set the parent object of the toolbar items' menus.
11691 * @param obj The toolbar object.
11692 * @param parent The parent of the menu objects.
11694 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11696 * For more details about setting the parent for toolbar menus, see
11697 * elm_menu_parent_set().
11699 * @see elm_menu_parent_set() for details.
11700 * @see elm_toolbar_item_menu_set() for details.
11704 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11707 * Get the parent object of the toolbar items' menus.
11709 * @param obj The toolbar object.
11710 * @return The parent of the menu objects.
11712 * @see elm_toolbar_menu_parent_set() for details.
11716 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11719 * Set the alignment of the items.
11721 * @param obj The toolbar object.
11722 * @param align The new alignment, a float between <tt> 0.0 </tt>
11723 * and <tt> 1.0 </tt>.
11725 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11726 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11729 * Centered items by default.
11731 * @see elm_toolbar_align_get()
11735 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11738 * Get the alignment of the items.
11740 * @param obj The toolbar object.
11741 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11744 * @see elm_toolbar_align_set() for details.
11748 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11751 * Set whether the toolbar item opens a menu.
11753 * @param item The toolbar item.
11754 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11756 * A toolbar item can be set to be a menu, using this function.
11758 * Once it is set to be a menu, it can be manipulated through the
11759 * menu-like function elm_toolbar_menu_parent_set() and the other
11760 * elm_menu functions, using the Evas_Object @c menu returned by
11761 * elm_toolbar_item_menu_get().
11763 * So, items to be displayed in this item's menu should be added with
11764 * elm_menu_item_add().
11766 * The following code exemplifies the most basic usage:
11768 * tb = elm_toolbar_add(win)
11769 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11770 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11771 * elm_toolbar_menu_parent_set(tb, win);
11772 * menu = elm_toolbar_item_menu_get(item);
11773 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11774 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11778 * @see elm_toolbar_item_menu_get()
11782 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11785 * Get toolbar item's menu.
11787 * @param item The toolbar item.
11788 * @return Item's menu object or @c NULL on failure.
11790 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11791 * this function will set it.
11793 * @see elm_toolbar_item_menu_set() for details.
11797 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11800 * Add a new state to @p item.
11802 * @param item The item.
11803 * @param icon A string with icon name or the absolute path of an image file.
11804 * @param label The label of the new state.
11805 * @param func The function to call when the item is clicked when this
11806 * state is selected.
11807 * @param data The data to associate with the state.
11808 * @return The toolbar item state, or @c NULL upon failure.
11810 * Toolbar will load icon image from fdo or current theme.
11811 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11812 * If an absolute path is provided it will load it direct from a file.
11814 * States created with this function can be removed with
11815 * elm_toolbar_item_state_del().
11817 * @see elm_toolbar_item_state_del()
11818 * @see elm_toolbar_item_state_sel()
11819 * @see elm_toolbar_item_state_get()
11823 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);
11826 * Delete a previoulsy added state to @p item.
11828 * @param item The toolbar item.
11829 * @param state The state to be deleted.
11830 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11832 * @see elm_toolbar_item_state_add()
11834 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11837 * Set @p state as the current state of @p it.
11839 * @param it The item.
11840 * @param state The state to use.
11841 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11843 * If @p state is @c NULL, it won't select any state and the default item's
11844 * icon and label will be used. It's the same behaviour than
11845 * elm_toolbar_item_state_unser().
11847 * @see elm_toolbar_item_state_unset()
11851 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11854 * Unset the state of @p it.
11856 * @param it The item.
11858 * The default icon and label from this item will be displayed.
11860 * @see elm_toolbar_item_state_set() for more details.
11864 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11867 * Get the current state of @p it.
11869 * @param item The item.
11870 * @return The selected state or @c NULL if none is selected or on failure.
11872 * @see elm_toolbar_item_state_set() for details.
11873 * @see elm_toolbar_item_state_unset()
11874 * @see elm_toolbar_item_state_add()
11878 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11881 * Get the state after selected state in toolbar's @p item.
11883 * @param it The toolbar item to change state.
11884 * @return The state after current state, or @c NULL on failure.
11886 * If last state is selected, this function will return first state.
11888 * @see elm_toolbar_item_state_set()
11889 * @see elm_toolbar_item_state_add()
11893 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11896 * Get the state before selected state in toolbar's @p item.
11898 * @param it The toolbar item to change state.
11899 * @return The state before current state, or @c NULL on failure.
11901 * If first state is selected, this function will return last state.
11903 * @see elm_toolbar_item_state_set()
11904 * @see elm_toolbar_item_state_add()
11908 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11911 * Set the text to be shown in a given toolbar item's tooltips.
11913 * @param item Target item.
11914 * @param text The text to set in the content.
11916 * Setup the text as tooltip to object. The item can have only one tooltip,
11917 * so any previous tooltip data - set with this function or
11918 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11920 * @see elm_object_tooltip_text_set() for more details.
11924 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11927 * Set the content to be shown in the tooltip item.
11929 * Setup the tooltip to item. The item can have only one tooltip,
11930 * so any previous tooltip data is removed. @p func(with @p data) will
11931 * be called every time that need show the tooltip and it should
11932 * return a valid Evas_Object. This object is then managed fully by
11933 * tooltip system and is deleted when the tooltip is gone.
11935 * @param item the toolbar item being attached a tooltip.
11936 * @param func the function used to create the tooltip contents.
11937 * @param data what to provide to @a func as callback data/context.
11938 * @param del_cb called when data is not needed anymore, either when
11939 * another callback replaces @a func, the tooltip is unset with
11940 * elm_toolbar_item_tooltip_unset() or the owner @a item
11941 * dies. This callback receives as the first parameter the
11942 * given @a data, and @c event_info is the item.
11944 * @see elm_object_tooltip_content_cb_set() for more details.
11948 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);
11951 * Unset tooltip from item.
11953 * @param item toolbar item to remove previously set tooltip.
11955 * Remove tooltip from item. The callback provided as del_cb to
11956 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11957 * it is not used anymore.
11959 * @see elm_object_tooltip_unset() for more details.
11960 * @see elm_toolbar_item_tooltip_content_cb_set()
11964 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11967 * Sets a different style for this item tooltip.
11969 * @note before you set a style you should define a tooltip with
11970 * elm_toolbar_item_tooltip_content_cb_set() or
11971 * elm_toolbar_item_tooltip_text_set()
11973 * @param item toolbar item with tooltip already set.
11974 * @param style the theme style to use (default, transparent, ...)
11976 * @see elm_object_tooltip_style_set() for more details.
11980 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11983 * Get the style for this item tooltip.
11985 * @param item toolbar item with tooltip already set.
11986 * @return style the theme style in use, defaults to "default". If the
11987 * object does not have a tooltip set, then NULL is returned.
11989 * @see elm_object_tooltip_style_get() for more details.
11990 * @see elm_toolbar_item_tooltip_style_set()
11994 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11997 * Set the type of mouse pointer/cursor decoration to be shown,
11998 * when the mouse pointer is over the given toolbar widget item
12000 * @param item toolbar item to customize cursor on
12001 * @param cursor the cursor type's name
12003 * This function works analogously as elm_object_cursor_set(), but
12004 * here the cursor's changing area is restricted to the item's
12005 * area, and not the whole widget's. Note that that item cursors
12006 * have precedence over widget cursors, so that a mouse over an
12007 * item with custom cursor set will always show @b that cursor.
12009 * If this function is called twice for an object, a previously set
12010 * cursor will be unset on the second call.
12012 * @see elm_object_cursor_set()
12013 * @see elm_toolbar_item_cursor_get()
12014 * @see elm_toolbar_item_cursor_unset()
12018 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12021 * Get the type of mouse pointer/cursor decoration set to be shown,
12022 * when the mouse pointer is over the given toolbar widget item
12024 * @param item toolbar item with custom cursor set
12025 * @return the cursor type's name or @c NULL, if no custom cursors
12026 * were set to @p item (and on errors)
12028 * @see elm_object_cursor_get()
12029 * @see elm_toolbar_item_cursor_set()
12030 * @see elm_toolbar_item_cursor_unset()
12034 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12037 * Unset any custom mouse pointer/cursor decoration set to be
12038 * shown, when the mouse pointer is over the given toolbar widget
12039 * item, thus making it show the @b default cursor again.
12041 * @param item a toolbar item
12043 * Use this call to undo any custom settings on this item's cursor
12044 * decoration, bringing it back to defaults (no custom style set).
12046 * @see elm_object_cursor_unset()
12047 * @see elm_toolbar_item_cursor_set()
12051 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12054 * Set a different @b style for a given custom cursor set for a
12057 * @param item toolbar item with custom cursor set
12058 * @param style the <b>theme style</b> to use (e.g. @c "default",
12059 * @c "transparent", etc)
12061 * This function only makes sense when one is using custom mouse
12062 * cursor decorations <b>defined in a theme file</b>, which can have,
12063 * given a cursor name/type, <b>alternate styles</b> on it. It
12064 * works analogously as elm_object_cursor_style_set(), but here
12065 * applyed only to toolbar item objects.
12067 * @warning Before you set a cursor style you should have definen a
12068 * custom cursor previously on the item, with
12069 * elm_toolbar_item_cursor_set()
12071 * @see elm_toolbar_item_cursor_engine_only_set()
12072 * @see elm_toolbar_item_cursor_style_get()
12076 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12079 * Get the current @b style set for a given toolbar item's custom
12082 * @param item toolbar item with custom cursor set.
12083 * @return style the cursor style in use. If the object does not
12084 * have a cursor set, then @c NULL is returned.
12086 * @see elm_toolbar_item_cursor_style_set() for more details
12090 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12093 * Set if the (custom)cursor for a given toolbar item should be
12094 * searched in its theme, also, or should only rely on the
12095 * rendering engine.
12097 * @param item item with custom (custom) cursor already set on
12098 * @param engine_only Use @c EINA_TRUE to have cursors looked for
12099 * only on those provided by the rendering engine, @c EINA_FALSE to
12100 * have them searched on the widget's theme, as well.
12102 * @note This call is of use only if you've set a custom cursor
12103 * for toolbar items, with elm_toolbar_item_cursor_set().
12105 * @note By default, cursors will only be looked for between those
12106 * provided by the rendering engine.
12110 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12113 * Get if the (custom) cursor for a given toolbar item is being
12114 * searched in its theme, also, or is only relying on the rendering
12117 * @param item a toolbar item
12118 * @return @c EINA_TRUE, if cursors are being looked for only on
12119 * those provided by the rendering engine, @c EINA_FALSE if they
12120 * are being searched on the widget's theme, as well.
12122 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
12126 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12129 * Change a toolbar's orientation
12130 * @param obj The toolbar object
12131 * @param vertical If @c EINA_TRUE, the toolbar is vertical
12132 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
12135 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
12138 * Get a toolbar's orientation
12139 * @param obj The toolbar object
12140 * @return If @c EINA_TRUE, the toolbar is vertical
12141 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
12144 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12151 EAPI double elm_tooltip_delay_get(void);
12152 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
12153 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12154 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12155 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12156 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);
12157 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12158 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12159 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12160 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12161 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12162 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12163 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12164 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12166 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12167 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
12168 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
12171 EAPI int elm_cursor_engine_only_get(void);
12172 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
12175 * @defgroup Menu Menu
12177 * @image html img/widget/menu/preview-00.png
12178 * @image latex img/widget/menu/preview-00.eps
12180 * A menu is a list of items displayed above its parent. When the menu is
12181 * showing its parent is darkened. Each item can have a sub-menu. The menu
12182 * object can be used to display a menu on a right click event, in a toolbar,
12185 * Signals that you can add callbacks for are:
12186 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
12187 * event_info is NULL.
12189 * @see @ref tutorial_menu
12192 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12194 * @brief Add a new menu to the parent
12196 * @param parent The parent object.
12197 * @return The new object or NULL if it cannot be created.
12199 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12201 * @brief Set the parent for the given menu widget
12203 * @param obj The menu object.
12204 * @param parent The new parent.
12206 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12208 * @brief Get the parent for the given menu widget
12210 * @param obj The menu object.
12211 * @return The parent.
12213 * @see elm_menu_parent_set()
12215 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12217 * @brief Move the menu to a new position
12219 * @param obj The menu object.
12220 * @param x The new position.
12221 * @param y The new position.
12223 * Sets the top-left position of the menu to (@p x,@p y).
12225 * @note @p x and @p y coordinates are relative to parent.
12227 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12229 * @brief Close a opened menu
12231 * @param obj the menu object
12234 * Hides the menu and all it's sub-menus.
12236 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12238 * @brief Returns a list of @p item's items.
12240 * @param obj The menu object
12241 * @return An Eina_List* of @p item's items
12243 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12245 * @brief Get the Evas_Object of an Elm_Menu_Item
12247 * @param item The menu item object.
12248 * @return The edje object containing the swallowed content
12250 * @warning Don't manipulate this object!
12252 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12254 * @brief Add an item at the end of the given menu widget
12256 * @param obj The menu object.
12257 * @param parent The parent menu item (optional)
12258 * @param icon A icon display on the item. The icon will be destryed by the menu.
12259 * @param label The label of the item.
12260 * @param func Function called when the user select the item.
12261 * @param data Data sent by the callback.
12262 * @return Returns the new item.
12264 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);
12266 * @brief Add an object swallowed in an item at the end of the given menu
12269 * @param obj The menu object.
12270 * @param parent The parent menu item (optional)
12271 * @param subobj The object to swallow
12272 * @param func Function called when the user select the item.
12273 * @param data Data sent by the callback.
12274 * @return Returns the new item.
12276 * Add an evas object as an item to the menu.
12278 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);
12280 * @brief Set the label of a menu item
12282 * @param item The menu item object.
12283 * @param label The label to set for @p item
12285 * @warning Don't use this funcion on items created with
12286 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12288 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12290 * @brief Get the label of a menu item
12292 * @param item The menu item object.
12293 * @return The label of @p item
12295 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12297 * @brief Set the icon of a menu item to the standard icon with name @p icon
12299 * @param item The menu item object.
12300 * @param icon The icon object to set for the content of @p item
12302 * Once this icon is set, any previously set icon will be deleted.
12304 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12306 * @brief Get the string representation from the icon of a menu item
12308 * @param item The menu item object.
12309 * @return The string representation of @p item's icon or NULL
12311 * @see elm_menu_item_object_icon_name_set()
12313 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12315 * @brief Set the content object of a menu item
12317 * @param item The menu item object
12318 * @param The content object or NULL
12319 * @return EINA_TRUE on success, else EINA_FALSE
12321 * Use this function to change the object swallowed by a menu item, deleting
12322 * any previously swallowed object.
12324 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12326 * @brief Get the content object of a menu item
12328 * @param item The menu item object
12329 * @return The content object or NULL
12330 * @note If @p item was added with elm_menu_item_add_object, this
12331 * function will return the object passed, else it will return the
12334 * @see elm_menu_item_object_content_set()
12336 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12338 * @brief Set the selected state of @p item.
12340 * @param item The menu item object.
12341 * @param selected The selected/unselected state of the item
12343 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12345 * @brief Get the selected state of @p item.
12347 * @param item The menu item object.
12348 * @return The selected/unselected state of the item
12350 * @see elm_menu_item_selected_set()
12352 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12354 * @brief Set the disabled state of @p item.
12356 * @param item The menu item object.
12357 * @param disabled The enabled/disabled state of the item
12359 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12361 * @brief Get the disabled state of @p item.
12363 * @param item The menu item object.
12364 * @return The enabled/disabled state of the item
12366 * @see elm_menu_item_disabled_set()
12368 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12370 * @brief Add a separator item to menu @p obj under @p parent.
12372 * @param obj The menu object
12373 * @param parent The item to add the separator under
12374 * @return The created item or NULL on failure
12376 * This is item is a @ref Separator.
12378 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12380 * @brief Returns whether @p item is a separator.
12382 * @param item The item to check
12383 * @return If true, @p item is a separator
12385 * @see elm_menu_item_separator_add()
12387 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12389 * @brief Deletes an item from the menu.
12391 * @param item The item to delete.
12393 * @see elm_menu_item_add()
12395 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12397 * @brief Set the function called when a menu item is deleted.
12399 * @param item The item to set the callback on
12400 * @param func The function called
12402 * @see elm_menu_item_add()
12403 * @see elm_menu_item_del()
12405 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12407 * @brief Returns the data associated with menu item @p item.
12409 * @param item The item
12410 * @return The data associated with @p item or NULL if none was set.
12412 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12414 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12416 * @brief Sets the data to be associated with menu item @p item.
12418 * @param item The item
12419 * @param data The data to be associated with @p item
12421 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12423 * @brief Returns a list of @p item's subitems.
12425 * @param item The item
12426 * @return An Eina_List* of @p item's subitems
12428 * @see elm_menu_add()
12430 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12432 * @brief Get the position of a menu item
12434 * @param item The menu item
12435 * @return The item's index
12437 * This function returns the index position of a menu item in a menu.
12438 * For a sub-menu, this number is relative to the first item in the sub-menu.
12440 * @note Index values begin with 0
12442 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12444 * @brief @brief Return a menu item's owner menu
12446 * @param item The menu item
12447 * @return The menu object owning @p item, or NULL on failure
12449 * Use this function to get the menu object owning an item.
12451 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12453 * @brief Get the selected item in the menu
12455 * @param obj The menu object
12456 * @return The selected item, or NULL if none
12458 * @see elm_menu_item_selected_get()
12459 * @see elm_menu_item_selected_set()
12461 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12463 * @brief Get the last item in the menu
12465 * @param obj The menu object
12466 * @return The last item, or NULL if none
12468 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12470 * @brief Get the first item in the menu
12472 * @param obj The menu object
12473 * @return The first item, or NULL if none
12475 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12477 * @brief Get the next item in the menu.
12479 * @param item The menu item object.
12480 * @return The item after it, or NULL if none
12482 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12484 * @brief Get the previous item in the menu.
12486 * @param item The menu item object.
12487 * @return The item before it, or NULL if none
12489 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12495 * @defgroup List List
12496 * @ingroup Elementary
12498 * @image html img/widget/list/preview-00.png
12499 * @image latex img/widget/list/preview-00.eps width=\textwidth
12501 * @image html img/list.png
12502 * @image latex img/list.eps width=\textwidth
12504 * A list widget is a container whose children are displayed vertically or
12505 * horizontally, in order, and can be selected.
12506 * The list can accept only one or multiple items selection. Also has many
12507 * modes of items displaying.
12509 * A list is a very simple type of list widget. For more robust
12510 * lists, @ref Genlist should probably be used.
12512 * Smart callbacks one can listen to:
12513 * - @c "activated" - The user has double-clicked or pressed
12514 * (enter|return|spacebar) on an item. The @c event_info parameter
12515 * is the item that was activated.
12516 * - @c "clicked,double" - The user has double-clicked an item.
12517 * The @c event_info parameter is the item that was double-clicked.
12518 * - "selected" - when the user selected an item
12519 * - "unselected" - when the user unselected an item
12520 * - "longpressed" - an item in the list is long-pressed
12521 * - "scroll,edge,top" - the list is scrolled until the top edge
12522 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12523 * - "scroll,edge,left" - the list is scrolled until the left edge
12524 * - "scroll,edge,right" - the list is scrolled until the right edge
12526 * Available styles for it:
12529 * List of examples:
12530 * @li @ref list_example_01
12531 * @li @ref list_example_02
12532 * @li @ref list_example_03
12541 * @enum _Elm_List_Mode
12542 * @typedef Elm_List_Mode
12544 * Set list's resize behavior, transverse axis scroll and
12545 * items cropping. See each mode's description for more details.
12547 * @note Default value is #ELM_LIST_SCROLL.
12549 * Values <b> don't </b> work as bitmask, only one can be choosen.
12551 * @see elm_list_mode_set()
12552 * @see elm_list_mode_get()
12556 typedef enum _Elm_List_Mode
12558 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. */
12559 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). */
12560 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. */
12561 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. */
12562 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12565 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(). */
12568 * Add a new list widget to the given parent Elementary
12569 * (container) object.
12571 * @param parent The parent object.
12572 * @return a new list widget handle or @c NULL, on errors.
12574 * This function inserts a new list widget on the canvas.
12578 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12583 * @param obj The list object
12585 * @note Call before running show() on the list object.
12586 * @warning If not called, it won't display the list properly.
12589 * li = elm_list_add(win);
12590 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12591 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12593 * evas_object_show(li);
12598 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12601 * Enable or disable multiple items selection on the list object.
12603 * @param obj The list object
12604 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12607 * Disabled by default. If disabled, the user can select a single item of
12608 * the list each time. Selected items are highlighted on list.
12609 * If enabled, many items can be selected.
12611 * If a selected item is selected again, it will be unselected.
12613 * @see elm_list_multi_select_get()
12617 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12620 * Get a value whether multiple items selection is enabled or not.
12622 * @see elm_list_multi_select_set() for details.
12624 * @param obj The list object.
12625 * @return @c EINA_TRUE means multiple items selection is enabled.
12626 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12627 * @c EINA_FALSE is returned.
12631 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12634 * Set which mode to use for the list object.
12636 * @param obj The list object
12637 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12638 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12640 * Set list's resize behavior, transverse axis scroll and
12641 * items cropping. See each mode's description for more details.
12643 * @note Default value is #ELM_LIST_SCROLL.
12645 * Only one can be set, if a previous one was set, it will be changed
12646 * by the new mode set. Bitmask won't work as well.
12648 * @see elm_list_mode_get()
12652 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12655 * Get the mode the list is at.
12657 * @param obj The list object
12658 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12659 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12661 * @note see elm_list_mode_set() for more information.
12665 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12668 * Enable or disable horizontal mode on the list object.
12670 * @param obj The list object.
12671 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12672 * disable it, i.e., to enable vertical mode.
12674 * @note Vertical mode is set by default.
12676 * On horizontal mode items are displayed on list from left to right,
12677 * instead of from top to bottom. Also, the list will scroll horizontally.
12678 * Each item will presents left icon on top and right icon, or end, at
12681 * @see elm_list_horizontal_get()
12685 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12688 * Get a value whether horizontal mode is enabled or not.
12690 * @param obj The list object.
12691 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12692 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12693 * @c EINA_FALSE is returned.
12695 * @see elm_list_horizontal_set() for details.
12699 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12702 * Enable or disable always select mode on the list object.
12704 * @param obj The list object
12705 * @param always_select @c EINA_TRUE to enable always select mode or
12706 * @c EINA_FALSE to disable it.
12708 * @note Always select mode is disabled by default.
12710 * Default behavior of list items is to only call its callback function
12711 * the first time it's pressed, i.e., when it is selected. If a selected
12712 * item is pressed again, and multi-select is disabled, it won't call
12713 * this function (if multi-select is enabled it will unselect the item).
12715 * If always select is enabled, it will call the callback function
12716 * everytime a item is pressed, so it will call when the item is selected,
12717 * and again when a selected item is pressed.
12719 * @see elm_list_always_select_mode_get()
12720 * @see elm_list_multi_select_set()
12724 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12727 * Get a value whether always select mode is enabled or not, meaning that
12728 * an item will always call its callback function, even if already selected.
12730 * @param obj The list object
12731 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12732 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12733 * @c EINA_FALSE is returned.
12735 * @see elm_list_always_select_mode_set() for details.
12739 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12742 * Set bouncing behaviour when the scrolled content reaches an edge.
12744 * Tell the internal scroller object whether it should bounce or not
12745 * when it reaches the respective edges for each axis.
12747 * @param obj The list object
12748 * @param h_bounce Whether to bounce or not in the horizontal axis.
12749 * @param v_bounce Whether to bounce or not in the vertical axis.
12751 * @see elm_scroller_bounce_set()
12755 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12758 * Get the bouncing behaviour of the internal scroller.
12760 * Get whether the internal scroller should bounce when the edge of each
12761 * axis is reached scrolling.
12763 * @param obj The list object.
12764 * @param h_bounce Pointer where to store the bounce state of the horizontal
12766 * @param v_bounce Pointer where to store the bounce state of the vertical
12769 * @see elm_scroller_bounce_get()
12770 * @see elm_list_bounce_set()
12774 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12777 * Set the scrollbar policy.
12779 * @param obj The list object
12780 * @param policy_h Horizontal scrollbar policy.
12781 * @param policy_v Vertical scrollbar policy.
12783 * This sets the scrollbar visibility policy for the given scroller.
12784 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12785 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12786 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12787 * This applies respectively for the horizontal and vertical scrollbars.
12789 * The both are disabled by default, i.e., are set to
12790 * #ELM_SCROLLER_POLICY_OFF.
12794 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12797 * Get the scrollbar policy.
12799 * @see elm_list_scroller_policy_get() for details.
12801 * @param obj The list object.
12802 * @param policy_h Pointer where to store horizontal scrollbar policy.
12803 * @param policy_v Pointer where to store vertical scrollbar policy.
12807 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);
12810 * Append a new item to the list object.
12812 * @param obj The list object.
12813 * @param label The label of the list item.
12814 * @param icon The icon object to use for the left side of the item. An
12815 * icon can be any Evas object, but usually it is an icon created
12816 * with elm_icon_add().
12817 * @param end The icon object to use for the right side of the item. An
12818 * icon can be any Evas object.
12819 * @param func The function to call when the item is clicked.
12820 * @param data The data to associate with the item for related callbacks.
12822 * @return The created item or @c NULL upon failure.
12824 * A new item will be created and appended to the list, i.e., will
12825 * be set as @b last item.
12827 * Items created with this method can be deleted with
12828 * elm_list_item_del().
12830 * Associated @p data can be properly freed when item is deleted if a
12831 * callback function is set with elm_list_item_del_cb_set().
12833 * If a function is passed as argument, it will be called everytime this item
12834 * is selected, i.e., the user clicks over an unselected item.
12835 * If always select is enabled it will call this function every time
12836 * user clicks over an item (already selected or not).
12837 * If such function isn't needed, just passing
12838 * @c NULL as @p func is enough. The same should be done for @p data.
12840 * Simple example (with no function callback or data associated):
12842 * li = elm_list_add(win);
12843 * ic = elm_icon_add(win);
12844 * elm_icon_file_set(ic, "path/to/image", NULL);
12845 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12846 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12848 * evas_object_show(li);
12851 * @see elm_list_always_select_mode_set()
12852 * @see elm_list_item_del()
12853 * @see elm_list_item_del_cb_set()
12854 * @see elm_list_clear()
12855 * @see elm_icon_add()
12859 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);
12862 * Prepend a new item to the list object.
12864 * @param obj The list object.
12865 * @param label The label of the list item.
12866 * @param icon The icon object to use for the left side of the item. An
12867 * icon can be any Evas object, but usually it is an icon created
12868 * with elm_icon_add().
12869 * @param end The icon object to use for the right side of the item. An
12870 * icon can be any Evas object.
12871 * @param func The function to call when the item is clicked.
12872 * @param data The data to associate with the item for related callbacks.
12874 * @return The created item or @c NULL upon failure.
12876 * A new item will be created and prepended to the list, i.e., will
12877 * be set as @b first item.
12879 * Items created with this method can be deleted with
12880 * elm_list_item_del().
12882 * Associated @p data can be properly freed when item is deleted if a
12883 * callback function is set with elm_list_item_del_cb_set().
12885 * If a function is passed as argument, it will be called everytime this item
12886 * is selected, i.e., the user clicks over an unselected item.
12887 * If always select is enabled it will call this function every time
12888 * user clicks over an item (already selected or not).
12889 * If such function isn't needed, just passing
12890 * @c NULL as @p func is enough. The same should be done for @p data.
12892 * @see elm_list_item_append() for a simple code example.
12893 * @see elm_list_always_select_mode_set()
12894 * @see elm_list_item_del()
12895 * @see elm_list_item_del_cb_set()
12896 * @see elm_list_clear()
12897 * @see elm_icon_add()
12901 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);
12904 * Insert a new item into the list object before item @p before.
12906 * @param obj The list object.
12907 * @param before The list item to insert before.
12908 * @param label The label of the list item.
12909 * @param icon The icon object to use for the left side of the item. An
12910 * icon can be any Evas object, but usually it is an icon created
12911 * with elm_icon_add().
12912 * @param end The icon object to use for the right side of the item. An
12913 * icon can be any Evas object.
12914 * @param func The function to call when the item is clicked.
12915 * @param data The data to associate with the item for related callbacks.
12917 * @return The created item or @c NULL upon failure.
12919 * A new item will be created and added to the list. Its position in
12920 * this list will be just before item @p before.
12922 * Items created with this method can be deleted with
12923 * elm_list_item_del().
12925 * Associated @p data can be properly freed when item is deleted if a
12926 * callback function is set with elm_list_item_del_cb_set().
12928 * If a function is passed as argument, it will be called everytime this item
12929 * is selected, i.e., the user clicks over an unselected item.
12930 * If always select is enabled it will call this function every time
12931 * user clicks over an item (already selected or not).
12932 * If such function isn't needed, just passing
12933 * @c NULL as @p func is enough. The same should be done for @p data.
12935 * @see elm_list_item_append() for a simple code example.
12936 * @see elm_list_always_select_mode_set()
12937 * @see elm_list_item_del()
12938 * @see elm_list_item_del_cb_set()
12939 * @see elm_list_clear()
12940 * @see elm_icon_add()
12944 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);
12947 * Insert a new item into the list object after item @p after.
12949 * @param obj The list object.
12950 * @param after The list item to insert after.
12951 * @param label The label of the list item.
12952 * @param icon The icon object to use for the left side of the item. An
12953 * icon can be any Evas object, but usually it is an icon created
12954 * with elm_icon_add().
12955 * @param end The icon object to use for the right side of the item. An
12956 * icon can be any Evas object.
12957 * @param func The function to call when the item is clicked.
12958 * @param data The data to associate with the item for related callbacks.
12960 * @return The created item or @c NULL upon failure.
12962 * A new item will be created and added to the list. Its position in
12963 * this list will be just after item @p after.
12965 * Items created with this method can be deleted with
12966 * elm_list_item_del().
12968 * Associated @p data can be properly freed when item is deleted if a
12969 * callback function is set with elm_list_item_del_cb_set().
12971 * If a function is passed as argument, it will be called everytime this item
12972 * is selected, i.e., the user clicks over an unselected item.
12973 * If always select is enabled it will call this function every time
12974 * user clicks over an item (already selected or not).
12975 * If such function isn't needed, just passing
12976 * @c NULL as @p func is enough. The same should be done for @p data.
12978 * @see elm_list_item_append() for a simple code example.
12979 * @see elm_list_always_select_mode_set()
12980 * @see elm_list_item_del()
12981 * @see elm_list_item_del_cb_set()
12982 * @see elm_list_clear()
12983 * @see elm_icon_add()
12987 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);
12990 * Insert a new item into the sorted list object.
12992 * @param obj The list object.
12993 * @param label The label of the list item.
12994 * @param icon The icon object to use for the left side of the item. An
12995 * icon can be any Evas object, but usually it is an icon created
12996 * with elm_icon_add().
12997 * @param end The icon object to use for the right side of the item. An
12998 * icon can be any Evas object.
12999 * @param func The function to call when the item is clicked.
13000 * @param data The data to associate with the item for related callbacks.
13001 * @param cmp_func The comparing function to be used to sort list
13002 * items <b>by #Elm_List_Item item handles</b>. This function will
13003 * receive two items and compare them, returning a non-negative integer
13004 * if the second item should be place after the first, or negative value
13005 * if should be placed before.
13007 * @return The created item or @c NULL upon failure.
13009 * @note This function inserts values into a list object assuming it was
13010 * sorted and the result will be sorted.
13012 * A new item will be created and added to the list. Its position in
13013 * this list will be found comparing the new item with previously inserted
13014 * items using function @p cmp_func.
13016 * Items created with this method can be deleted with
13017 * elm_list_item_del().
13019 * Associated @p data can be properly freed when item is deleted if a
13020 * callback function is set with elm_list_item_del_cb_set().
13022 * If a function is passed as argument, it will be called everytime this item
13023 * is selected, i.e., the user clicks over an unselected item.
13024 * If always select is enabled it will call this function every time
13025 * user clicks over an item (already selected or not).
13026 * If such function isn't needed, just passing
13027 * @c NULL as @p func is enough. The same should be done for @p data.
13029 * @see elm_list_item_append() for a simple code example.
13030 * @see elm_list_always_select_mode_set()
13031 * @see elm_list_item_del()
13032 * @see elm_list_item_del_cb_set()
13033 * @see elm_list_clear()
13034 * @see elm_icon_add()
13038 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);
13041 * Remove all list's items.
13043 * @param obj The list object
13045 * @see elm_list_item_del()
13046 * @see elm_list_item_append()
13050 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13053 * Get a list of all the list items.
13055 * @param obj The list object
13056 * @return An @c Eina_List of list items, #Elm_List_Item,
13057 * or @c NULL on failure.
13059 * @see elm_list_item_append()
13060 * @see elm_list_item_del()
13061 * @see elm_list_clear()
13065 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13068 * Get the selected item.
13070 * @param obj The list object.
13071 * @return The selected list item.
13073 * The selected item can be unselected with function
13074 * elm_list_item_selected_set().
13076 * The selected item always will be highlighted on list.
13078 * @see elm_list_selected_items_get()
13082 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13085 * Return a list of the currently selected list items.
13087 * @param obj The list object.
13088 * @return An @c Eina_List of list items, #Elm_List_Item,
13089 * or @c NULL on failure.
13091 * Multiple items can be selected if multi select is enabled. It can be
13092 * done with elm_list_multi_select_set().
13094 * @see elm_list_selected_item_get()
13095 * @see elm_list_multi_select_set()
13099 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13102 * Set the selected state of an item.
13104 * @param item The list item
13105 * @param selected The selected state
13107 * This sets the selected state of the given item @p it.
13108 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13110 * If a new item is selected the previosly selected will be unselected,
13111 * unless multiple selection is enabled with elm_list_multi_select_set().
13112 * Previoulsy selected item can be get with function
13113 * elm_list_selected_item_get().
13115 * Selected items will be highlighted.
13117 * @see elm_list_item_selected_get()
13118 * @see elm_list_selected_item_get()
13119 * @see elm_list_multi_select_set()
13123 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13126 * Get whether the @p item is selected or not.
13128 * @param item The list item.
13129 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13130 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13132 * @see elm_list_selected_item_set() for details.
13133 * @see elm_list_item_selected_get()
13137 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13140 * Set or unset item as a separator.
13142 * @param it The list item.
13143 * @param setting @c EINA_TRUE to set item @p it as separator or
13144 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13146 * Items aren't set as separator by default.
13148 * If set as separator it will display separator theme, so won't display
13151 * @see elm_list_item_separator_get()
13155 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
13158 * Get a value whether item is a separator or not.
13160 * @see elm_list_item_separator_set() for details.
13162 * @param it The list item.
13163 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13164 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13168 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13171 * Show @p item in the list view.
13173 * @param item The list item to be shown.
13175 * It won't animate list until item is visible. If such behavior is wanted,
13176 * use elm_list_bring_in() intead.
13180 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13183 * Bring in the given item to list view.
13185 * @param item The item.
13187 * This causes list to jump to the given item @p item and show it
13188 * (by scrolling), if it is not fully visible.
13190 * This may use animation to do so and take a period of time.
13192 * If animation isn't wanted, elm_list_item_show() can be used.
13196 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13199 * Delete them item from the list.
13201 * @param item The item of list to be deleted.
13203 * If deleting all list items is required, elm_list_clear()
13204 * should be used instead of getting items list and deleting each one.
13206 * @see elm_list_clear()
13207 * @see elm_list_item_append()
13208 * @see elm_list_item_del_cb_set()
13212 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13215 * Set the function called when a list item is freed.
13217 * @param item The item to set the callback on
13218 * @param func The function called
13220 * If there is a @p func, then it will be called prior item's memory release.
13221 * That will be called with the following arguments:
13223 * @li item's Evas object;
13226 * This way, a data associated to a list item could be properly freed.
13230 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13233 * Get the data associated to the item.
13235 * @param item The list item
13236 * @return The data associated to @p item
13238 * The return value is a pointer to data associated to @p item when it was
13239 * created, with function elm_list_item_append() or similar. If no data
13240 * was passed as argument, it will return @c NULL.
13242 * @see elm_list_item_append()
13246 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13249 * Get the left side icon associated to the item.
13251 * @param item The list item
13252 * @return The left side icon associated to @p item
13254 * The return value is a pointer to the icon associated to @p item when
13256 * created, with function elm_list_item_append() or similar, or later
13257 * with function elm_list_item_icon_set(). If no icon
13258 * was passed as argument, it will return @c NULL.
13260 * @see elm_list_item_append()
13261 * @see elm_list_item_icon_set()
13265 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13268 * Set the left side icon associated to the item.
13270 * @param item The list item
13271 * @param icon The left side icon object to associate with @p item
13273 * The icon object to use at left side of the item. An
13274 * icon can be any Evas object, but usually it is an icon created
13275 * with elm_icon_add().
13277 * Once the icon object is set, a previously set one will be deleted.
13278 * @warning Setting the same icon for two items will cause the icon to
13279 * dissapear from the first item.
13281 * If an icon was passed as argument on item creation, with function
13282 * elm_list_item_append() or similar, it will be already
13283 * associated to the item.
13285 * @see elm_list_item_append()
13286 * @see elm_list_item_icon_get()
13290 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13293 * Get the right side icon associated to the item.
13295 * @param item The list item
13296 * @return The right side icon associated to @p item
13298 * The return value is a pointer to the icon associated to @p item when
13300 * created, with function elm_list_item_append() or similar, or later
13301 * with function elm_list_item_icon_set(). If no icon
13302 * was passed as argument, it will return @c NULL.
13304 * @see elm_list_item_append()
13305 * @see elm_list_item_icon_set()
13309 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13312 * Set the right side icon associated to the item.
13314 * @param item The list item
13315 * @param end The right side icon object to associate with @p item
13317 * The icon object to use at right side of the item. An
13318 * icon can be any Evas object, but usually it is an icon created
13319 * with elm_icon_add().
13321 * Once the icon object is set, a previously set one will be deleted.
13322 * @warning Setting the same icon for two items will cause the icon to
13323 * dissapear from the first item.
13325 * If an icon was passed as argument on item creation, with function
13326 * elm_list_item_append() or similar, it will be already
13327 * associated to the item.
13329 * @see elm_list_item_append()
13330 * @see elm_list_item_end_get()
13334 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13337 * Gets the base object of the item.
13339 * @param item The list item
13340 * @return The base object associated with @p item
13342 * Base object is the @c Evas_Object that represents that item.
13346 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13349 * Get the label of item.
13351 * @param item The item of list.
13352 * @return The label of item.
13354 * The return value is a pointer to the label associated to @p item when
13355 * it was created, with function elm_list_item_append(), or later
13356 * with function elm_list_item_label_set. If no label
13357 * was passed as argument, it will return @c NULL.
13359 * @see elm_list_item_label_set() for more details.
13360 * @see elm_list_item_append()
13364 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13367 * Set the label of item.
13369 * @param item The item of list.
13370 * @param text The label of item.
13372 * The label to be displayed by the item.
13373 * Label will be placed between left and right side icons (if set).
13375 * If a label was passed as argument on item creation, with function
13376 * elm_list_item_append() or similar, it will be already
13377 * displayed by the item.
13379 * @see elm_list_item_label_get()
13380 * @see elm_list_item_append()
13384 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13388 * Get the item before @p it in list.
13390 * @param it The list item.
13391 * @return The item before @p it, or @c NULL if none or on failure.
13393 * @note If it is the first item, @c NULL will be returned.
13395 * @see elm_list_item_append()
13396 * @see elm_list_items_get()
13400 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13403 * Get the item after @p it in list.
13405 * @param it The list item.
13406 * @return The item after @p it, or @c NULL if none or on failure.
13408 * @note If it is the last item, @c NULL will be returned.
13410 * @see elm_list_item_append()
13411 * @see elm_list_items_get()
13415 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13418 * Sets the disabled/enabled state of a list item.
13420 * @param it The item.
13421 * @param disabled The disabled state.
13423 * A disabled item cannot be selected or unselected. It will also
13424 * change its appearance (generally greyed out). This sets the
13425 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13430 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13433 * Get a value whether list item is disabled or not.
13435 * @param it The item.
13436 * @return The disabled state.
13438 * @see elm_list_item_disabled_set() for more details.
13442 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13445 * Set the text to be shown in a given list item's tooltips.
13447 * @param item Target item.
13448 * @param text The text to set in the content.
13450 * Setup the text as tooltip to object. The item can have only one tooltip,
13451 * so any previous tooltip data - set with this function or
13452 * elm_list_item_tooltip_content_cb_set() - is removed.
13454 * @see elm_object_tooltip_text_set() for more details.
13458 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13462 * @brief Disable size restrictions on an object's tooltip
13463 * @param item The tooltip's anchor object
13464 * @param disable If EINA_TRUE, size restrictions are disabled
13465 * @return EINA_FALSE on failure, EINA_TRUE on success
13467 * This function allows a tooltip to expand beyond its parant window's canvas.
13468 * It will instead be limited only by the size of the display.
13470 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13472 * @brief Retrieve size restriction state of an object's tooltip
13473 * @param obj The tooltip's anchor object
13474 * @return If EINA_TRUE, size restrictions are disabled
13476 * This function returns whether a tooltip is allowed to expand beyond
13477 * its parant window's canvas.
13478 * It will instead be limited only by the size of the display.
13480 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13483 * Set the content to be shown in the tooltip item.
13485 * Setup the tooltip to item. The item can have only one tooltip,
13486 * so any previous tooltip data is removed. @p func(with @p data) will
13487 * be called every time that need show the tooltip and it should
13488 * return a valid Evas_Object. This object is then managed fully by
13489 * tooltip system and is deleted when the tooltip is gone.
13491 * @param item the list item being attached a tooltip.
13492 * @param func the function used to create the tooltip contents.
13493 * @param data what to provide to @a func as callback data/context.
13494 * @param del_cb called when data is not needed anymore, either when
13495 * another callback replaces @a func, the tooltip is unset with
13496 * elm_list_item_tooltip_unset() or the owner @a item
13497 * dies. This callback receives as the first parameter the
13498 * given @a data, and @c event_info is the item.
13500 * @see elm_object_tooltip_content_cb_set() for more details.
13504 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);
13507 * Unset tooltip from item.
13509 * @param item list item to remove previously set tooltip.
13511 * Remove tooltip from item. The callback provided as del_cb to
13512 * elm_list_item_tooltip_content_cb_set() will be called to notify
13513 * it is not used anymore.
13515 * @see elm_object_tooltip_unset() for more details.
13516 * @see elm_list_item_tooltip_content_cb_set()
13520 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13523 * Sets a different style for this item tooltip.
13525 * @note before you set a style you should define a tooltip with
13526 * elm_list_item_tooltip_content_cb_set() or
13527 * elm_list_item_tooltip_text_set()
13529 * @param item list item with tooltip already set.
13530 * @param style the theme style to use (default, transparent, ...)
13532 * @see elm_object_tooltip_style_set() for more details.
13536 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13539 * Get the style for this item tooltip.
13541 * @param item list item with tooltip already set.
13542 * @return style the theme style in use, defaults to "default". If the
13543 * object does not have a tooltip set, then NULL is returned.
13545 * @see elm_object_tooltip_style_get() for more details.
13546 * @see elm_list_item_tooltip_style_set()
13550 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13553 * Set the type of mouse pointer/cursor decoration to be shown,
13554 * when the mouse pointer is over the given list widget item
13556 * @param item list item to customize cursor on
13557 * @param cursor the cursor type's name
13559 * This function works analogously as elm_object_cursor_set(), but
13560 * here the cursor's changing area is restricted to the item's
13561 * area, and not the whole widget's. Note that that item cursors
13562 * have precedence over widget cursors, so that a mouse over an
13563 * item with custom cursor set will always show @b that cursor.
13565 * If this function is called twice for an object, a previously set
13566 * cursor will be unset on the second call.
13568 * @see elm_object_cursor_set()
13569 * @see elm_list_item_cursor_get()
13570 * @see elm_list_item_cursor_unset()
13574 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13577 * Get the type of mouse pointer/cursor decoration set to be shown,
13578 * when the mouse pointer is over the given list widget item
13580 * @param item list item with custom cursor set
13581 * @return the cursor type's name or @c NULL, if no custom cursors
13582 * were set to @p item (and on errors)
13584 * @see elm_object_cursor_get()
13585 * @see elm_list_item_cursor_set()
13586 * @see elm_list_item_cursor_unset()
13590 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13593 * Unset any custom mouse pointer/cursor decoration set to be
13594 * shown, when the mouse pointer is over the given list widget
13595 * item, thus making it show the @b default cursor again.
13597 * @param item a list item
13599 * Use this call to undo any custom settings on this item's cursor
13600 * decoration, bringing it back to defaults (no custom style set).
13602 * @see elm_object_cursor_unset()
13603 * @see elm_list_item_cursor_set()
13607 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13610 * Set a different @b style for a given custom cursor set for a
13613 * @param item list item with custom cursor set
13614 * @param style the <b>theme style</b> to use (e.g. @c "default",
13615 * @c "transparent", etc)
13617 * This function only makes sense when one is using custom mouse
13618 * cursor decorations <b>defined in a theme file</b>, which can have,
13619 * given a cursor name/type, <b>alternate styles</b> on it. It
13620 * works analogously as elm_object_cursor_style_set(), but here
13621 * applyed only to list item objects.
13623 * @warning Before you set a cursor style you should have definen a
13624 * custom cursor previously on the item, with
13625 * elm_list_item_cursor_set()
13627 * @see elm_list_item_cursor_engine_only_set()
13628 * @see elm_list_item_cursor_style_get()
13632 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13635 * Get the current @b style set for a given list item's custom
13638 * @param item list item with custom cursor set.
13639 * @return style the cursor style in use. If the object does not
13640 * have a cursor set, then @c NULL is returned.
13642 * @see elm_list_item_cursor_style_set() for more details
13646 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13649 * Set if the (custom)cursor for a given list item should be
13650 * searched in its theme, also, or should only rely on the
13651 * rendering engine.
13653 * @param item item with custom (custom) cursor already set on
13654 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13655 * only on those provided by the rendering engine, @c EINA_FALSE to
13656 * have them searched on the widget's theme, as well.
13658 * @note This call is of use only if you've set a custom cursor
13659 * for list items, with elm_list_item_cursor_set().
13661 * @note By default, cursors will only be looked for between those
13662 * provided by the rendering engine.
13666 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13669 * Get if the (custom) cursor for a given list item is being
13670 * searched in its theme, also, or is only relying on the rendering
13673 * @param item a list item
13674 * @return @c EINA_TRUE, if cursors are being looked for only on
13675 * those provided by the rendering engine, @c EINA_FALSE if they
13676 * are being searched on the widget's theme, as well.
13678 * @see elm_list_item_cursor_engine_only_set(), for more details
13682 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13689 * @defgroup Slider Slider
13690 * @ingroup Elementary
13692 * @image html img/widget/slider/preview-00.png
13693 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13695 * The slider adds a dragable “slider” widget for selecting the value of
13696 * something within a range.
13698 * A slider can be horizontal or vertical. It can contain an Icon and has a
13699 * primary label as well as a units label (that is formatted with floating
13700 * point values and thus accepts a printf-style format string, like
13701 * “%1.2f units”. There is also an indicator string that may be somewhere
13702 * else (like on the slider itself) that also accepts a format string like
13703 * units. Label, Icon Unit and Indicator strings/objects are optional.
13705 * A slider may be inverted which means values invert, with high vales being
13706 * on the left or top and low values on the right or bottom (as opposed to
13707 * normally being low on the left or top and high on the bottom and right).
13709 * The slider should have its minimum and maximum values set by the
13710 * application with elm_slider_min_max_set() and value should also be set by
13711 * the application before use with elm_slider_value_set(). The span of the
13712 * slider is its length (horizontally or vertically). This will be scaled by
13713 * the object or applications scaling factor. At any point code can query the
13714 * slider for its value with elm_slider_value_get().
13716 * Smart callbacks one can listen to:
13717 * - "changed" - Whenever the slider value is changed by the user.
13718 * - "slider,drag,start" - dragging the slider indicator around has started.
13719 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13720 * - "delay,changed" - A short time after the value is changed by the user.
13721 * This will be called only when the user stops dragging for
13722 * a very short period or when they release their
13723 * finger/mouse, so it avoids possibly expensive reactions to
13724 * the value change.
13726 * Available styles for it:
13729 * Here is an example on its usage:
13730 * @li @ref slider_example
13734 * @addtogroup Slider
13739 * Add a new slider widget to the given parent Elementary
13740 * (container) object.
13742 * @param parent The parent object.
13743 * @return a new slider widget handle or @c NULL, on errors.
13745 * This function inserts a new slider widget on the canvas.
13749 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13752 * Set the label of a given slider widget
13754 * @param obj The progress bar object
13755 * @param label The text label string, in UTF-8
13758 * @deprecated use elm_object_text_set() instead.
13760 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13763 * Get the label of a given slider widget
13765 * @param obj The progressbar object
13766 * @return The text label string, in UTF-8
13769 * @deprecated use elm_object_text_get() instead.
13771 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13774 * Set the icon object of the slider object.
13776 * @param obj The slider object.
13777 * @param icon The icon object.
13779 * On horizontal mode, icon is placed at left, and on vertical mode,
13782 * @note Once the icon object is set, a previously set one will be deleted.
13783 * If you want to keep that old content object, use the
13784 * elm_slider_icon_unset() function.
13786 * @warning If the object being set does not have minimum size hints set,
13787 * it won't get properly displayed.
13791 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13794 * Unset an icon set on a given slider widget.
13796 * @param obj The slider object.
13797 * @return The icon object that was being used, if any was set, or
13798 * @c NULL, otherwise (and on errors).
13800 * On horizontal mode, icon is placed at left, and on vertical mode,
13803 * This call will unparent and return the icon object which was set
13804 * for this widget, previously, on success.
13806 * @see elm_slider_icon_set() for more details
13807 * @see elm_slider_icon_get()
13811 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13814 * Retrieve the icon object set for a given slider widget.
13816 * @param obj The slider object.
13817 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13818 * otherwise (and on errors).
13820 * On horizontal mode, icon is placed at left, and on vertical mode,
13823 * @see elm_slider_icon_set() for more details
13824 * @see elm_slider_icon_unset()
13828 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13831 * Set the end object of the slider object.
13833 * @param obj The slider object.
13834 * @param end The end object.
13836 * On horizontal mode, end is placed at left, and on vertical mode,
13837 * placed at bottom.
13839 * @note Once the icon object is set, a previously set one will be deleted.
13840 * If you want to keep that old content object, use the
13841 * elm_slider_end_unset() function.
13843 * @warning If the object being set does not have minimum size hints set,
13844 * it won't get properly displayed.
13848 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13851 * Unset an end object set on a given slider widget.
13853 * @param obj The slider object.
13854 * @return The end object that was being used, if any was set, or
13855 * @c NULL, otherwise (and on errors).
13857 * On horizontal mode, end is placed at left, and on vertical mode,
13858 * placed at bottom.
13860 * This call will unparent and return the icon object which was set
13861 * for this widget, previously, on success.
13863 * @see elm_slider_end_set() for more details.
13864 * @see elm_slider_end_get()
13868 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13871 * Retrieve the end object set for a given slider widget.
13873 * @param obj The slider object.
13874 * @return The end object's handle, if @p obj had one set, or @c NULL,
13875 * otherwise (and on errors).
13877 * On horizontal mode, icon is placed at right, and on vertical mode,
13878 * placed at bottom.
13880 * @see elm_slider_end_set() for more details.
13881 * @see elm_slider_end_unset()
13885 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13888 * Set the (exact) length of the bar region of a given slider widget.
13890 * @param obj The slider object.
13891 * @param size The length of the slider's bar region.
13893 * This sets the minimum width (when in horizontal mode) or height
13894 * (when in vertical mode) of the actual bar area of the slider
13895 * @p obj. This in turn affects the object's minimum size. Use
13896 * this when you're not setting other size hints expanding on the
13897 * given direction (like weight and alignment hints) and you would
13898 * like it to have a specific size.
13900 * @note Icon, end, label, indicator and unit text around @p obj
13901 * will require their
13902 * own space, which will make @p obj to require more the @p size,
13905 * @see elm_slider_span_size_get()
13909 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13912 * Get the length set for the bar region of a given slider widget
13914 * @param obj The slider object.
13915 * @return The length of the slider's bar region.
13917 * If that size was not set previously, with
13918 * elm_slider_span_size_set(), this call will return @c 0.
13922 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13925 * Set the format string for the unit label.
13927 * @param obj The slider object.
13928 * @param format The format string for the unit display.
13930 * Unit label is displayed all the time, if set, after slider's bar.
13931 * In horizontal mode, at right and in vertical mode, at bottom.
13933 * If @c NULL, unit label won't be visible. If not it sets the format
13934 * string for the label text. To the label text is provided a floating point
13935 * value, so the label text can display up to 1 floating point value.
13936 * Note that this is optional.
13938 * Use a format string such as "%1.2f meters" for example, and it will
13939 * display values like: "3.14 meters" for a value equal to 3.14159.
13941 * Default is unit label disabled.
13943 * @see elm_slider_indicator_format_get()
13947 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13950 * Get the unit label format of the slider.
13952 * @param obj The slider object.
13953 * @return The unit label format string in UTF-8.
13955 * Unit label is displayed all the time, if set, after slider's bar.
13956 * In horizontal mode, at right and in vertical mode, at bottom.
13958 * @see elm_slider_unit_format_set() for more
13959 * information on how this works.
13963 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13966 * Set the format string for the indicator label.
13968 * @param obj The slider object.
13969 * @param indicator The format string for the indicator display.
13971 * The slider may display its value somewhere else then unit label,
13972 * for example, above the slider knob that is dragged around. This function
13973 * sets the format string used for this.
13975 * If @c NULL, indicator label won't be visible. If not it sets the format
13976 * string for the label text. To the label text is provided a floating point
13977 * value, so the label text can display up to 1 floating point value.
13978 * Note that this is optional.
13980 * Use a format string such as "%1.2f meters" for example, and it will
13981 * display values like: "3.14 meters" for a value equal to 3.14159.
13983 * Default is indicator label disabled.
13985 * @see elm_slider_indicator_format_get()
13989 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13992 * Get the indicator label format of the slider.
13994 * @param obj The slider object.
13995 * @return The indicator label format string in UTF-8.
13997 * The slider may display its value somewhere else then unit label,
13998 * for example, above the slider knob that is dragged around. This function
13999 * gets the format string used for this.
14001 * @see elm_slider_indicator_format_set() for more
14002 * information on how this works.
14006 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14009 * Set the format function pointer for the indicator label
14011 * @param obj The slider object.
14012 * @param func The indicator format function.
14013 * @param free_func The freeing function for the format string.
14015 * Set the callback function to format the indicator string.
14017 * @see elm_slider_indicator_format_set() for more info on how this works.
14021 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);
14024 * Set the format function pointer for the units label
14026 * @param obj The slider object.
14027 * @param func The units format function.
14028 * @param free_func The freeing function for the format string.
14030 * Set the callback function to format the indicator string.
14032 * @see elm_slider_units_format_set() for more info on how this works.
14036 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);
14039 * Set the orientation of a given slider widget.
14041 * @param obj The slider object.
14042 * @param horizontal Use @c EINA_TRUE to make @p obj to be
14043 * @b horizontal, @c EINA_FALSE to make it @b vertical.
14045 * Use this function to change how your slider is to be
14046 * disposed: vertically or horizontally.
14048 * By default it's displayed horizontally.
14050 * @see elm_slider_horizontal_get()
14054 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14057 * Retrieve the orientation of a given slider widget
14059 * @param obj The slider object.
14060 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
14061 * @c EINA_FALSE if it's @b vertical (and on errors).
14063 * @see elm_slider_horizontal_set() for more details.
14067 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14070 * Set the minimum and maximum values for the slider.
14072 * @param obj The slider object.
14073 * @param min The minimum value.
14074 * @param max The maximum value.
14076 * Define the allowed range of values to be selected by the user.
14078 * If actual value is less than @p min, it will be updated to @p min. If it
14079 * is bigger then @p max, will be updated to @p max. Actual value can be
14080 * get with elm_slider_value_get().
14082 * By default, min is equal to 0.0, and max is equal to 1.0.
14084 * @warning Maximum must be greater than minimum, otherwise behavior
14087 * @see elm_slider_min_max_get()
14091 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
14094 * Get the minimum and maximum values of the slider.
14096 * @param obj The slider object.
14097 * @param min Pointer where to store the minimum value.
14098 * @param max Pointer where to store the maximum value.
14100 * @note If only one value is needed, the other pointer can be passed
14103 * @see elm_slider_min_max_set() for details.
14107 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
14110 * Set the value the slider displays.
14112 * @param obj The slider object.
14113 * @param val The value to be displayed.
14115 * Value will be presented on the unit label following format specified with
14116 * elm_slider_unit_format_set() and on indicator with
14117 * elm_slider_indicator_format_set().
14119 * @warning The value must to be between min and max values. This values
14120 * are set by elm_slider_min_max_set().
14122 * @see elm_slider_value_get()
14123 * @see elm_slider_unit_format_set()
14124 * @see elm_slider_indicator_format_set()
14125 * @see elm_slider_min_max_set()
14129 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14132 * Get the value displayed by the spinner.
14134 * @param obj The spinner object.
14135 * @return The value displayed.
14137 * @see elm_spinner_value_set() for details.
14141 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14144 * Invert a given slider widget's displaying values order
14146 * @param obj The slider object.
14147 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14148 * @c EINA_FALSE to bring it back to default, non-inverted values.
14150 * A slider may be @b inverted, in which state it gets its
14151 * values inverted, with high vales being on the left or top and
14152 * low values on the right or bottom, as opposed to normally have
14153 * the low values on the former and high values on the latter,
14154 * respectively, for horizontal and vertical modes.
14156 * @see elm_slider_inverted_get()
14160 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14163 * Get whether a given slider widget's displaying values are
14166 * @param obj The slider object.
14167 * @return @c EINA_TRUE, if @p obj has inverted values,
14168 * @c EINA_FALSE otherwise (and on errors).
14170 * @see elm_slider_inverted_set() for more details.
14174 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14177 * Set whether to enlarge slider indicator (augmented knob) or not.
14179 * @param obj The slider object.
14180 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
14181 * let the knob always at default size.
14183 * By default, indicator will be bigger while dragged by the user.
14185 * @warning It won't display values set with
14186 * elm_slider_indicator_format_set() if you disable indicator.
14190 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
14193 * Get whether a given slider widget's enlarging indicator or not.
14195 * @param obj The slider object.
14196 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
14197 * @c EINA_FALSE otherwise (and on errors).
14199 * @see elm_slider_indicator_show_set() for details.
14203 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14210 * @addtogroup Actionslider Actionslider
14212 * @image html img/widget/actionslider/preview-00.png
14213 * @image latex img/widget/actionslider/preview-00.eps
14215 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14216 * properties. The indicator is the element the user drags to choose a label.
14217 * When the position is set with magnet, when released the indicator will be
14218 * moved to it if it's nearest the magnetized position.
14220 * @note By default all positions are set as enabled.
14222 * Signals that you can add callbacks for are:
14224 * "selected" - when user selects an enabled position (the label is passed
14227 * "pos_changed" - when the indicator reaches any of the positions("left",
14228 * "right" or "center").
14230 * See an example of actionslider usage @ref actionslider_example_page "here"
14233 typedef enum _Elm_Actionslider_Pos
14235 ELM_ACTIONSLIDER_NONE = 0,
14236 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14237 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14238 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14239 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14240 } Elm_Actionslider_Pos;
14243 * Add a new actionslider to the parent.
14245 * @param parent The parent object
14246 * @return The new actionslider object or NULL if it cannot be created
14248 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14250 * Set actionslider labels.
14252 * @param obj The actionslider object
14253 * @param left_label The label to be set on the left.
14254 * @param center_label The label to be set on the center.
14255 * @param right_label The label to be set on the right.
14256 * @deprecated use elm_object_text_set() instead.
14258 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);
14260 * Get actionslider labels.
14262 * @param obj The actionslider object
14263 * @param left_label A char** to place the left_label of @p obj into.
14264 * @param center_label A char** to place the center_label of @p obj into.
14265 * @param right_label A char** to place the right_label of @p obj into.
14266 * @deprecated use elm_object_text_set() instead.
14268 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);
14270 * Get actionslider selected label.
14272 * @param obj The actionslider object
14273 * @return The selected label
14275 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14277 * Set actionslider indicator position.
14279 * @param obj The actionslider object.
14280 * @param pos The position of the indicator.
14282 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14284 * Get actionslider indicator position.
14286 * @param obj The actionslider object.
14287 * @return The position of the indicator.
14289 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14291 * Set actionslider magnet position. To make multiple positions magnets @c or
14292 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14294 * @param obj The actionslider object.
14295 * @param pos Bit mask indicating the magnet positions.
14297 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14299 * Get actionslider magnet position.
14301 * @param obj The actionslider object.
14302 * @return The positions with magnet property.
14304 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14306 * Set actionslider enabled position. To set multiple positions as enabled @c or
14307 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14309 * @note All the positions are enabled by default.
14311 * @param obj The actionslider object.
14312 * @param pos Bit mask indicating the enabled positions.
14314 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14316 * Get actionslider enabled position.
14318 * @param obj The actionslider object.
14319 * @return The enabled positions.
14321 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14323 * Set the label used on the indicator.
14325 * @param obj The actionslider object
14326 * @param label The label to be set on the indicator.
14327 * @deprecated use elm_object_text_set() instead.
14329 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14331 * Get the label used on the indicator object.
14333 * @param obj The actionslider object
14334 * @return The indicator label
14335 * @deprecated use elm_object_text_get() instead.
14337 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14343 * @defgroup Genlist Genlist
14345 * @image html img/widget/genlist/preview-00.png
14346 * @image latex img/widget/genlist/preview-00.eps
14347 * @image html img/genlist.png
14348 * @image latex img/genlist.eps
14350 * This widget aims to have more expansive list than the simple list in
14351 * Elementary that could have more flexible items and allow many more entries
14352 * while still being fast and low on memory usage. At the same time it was
14353 * also made to be able to do tree structures. But the price to pay is more
14354 * complexity when it comes to usage. If all you want is a simple list with
14355 * icons and a single label, use the normal @ref List object.
14357 * Genlist has a fairly large API, mostly because it's relatively complex,
14358 * trying to be both expansive, powerful and efficient. First we will begin
14359 * an overview on the theory behind genlist.
14361 * @section Genlist_Item_Class Genlist item classes - creating items
14363 * In order to have the ability to add and delete items on the fly, genlist
14364 * implements a class (callback) system where the application provides a
14365 * structure with information about that type of item (genlist may contain
14366 * multiple different items with different classes, states and styles).
14367 * Genlist will call the functions in this struct (methods) when an item is
14368 * "realized" (i.e., created dynamically, while the user is scrolling the
14369 * grid). All objects will simply be deleted when no longer needed with
14370 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14371 * following members:
14372 * - @c item_style - This is a constant string and simply defines the name
14373 * of the item style. It @b must be specified and the default should be @c
14375 * - @c mode_item_style - This is a constant string and simply defines the
14376 * name of the style that will be used for mode animations. It can be left
14377 * as @c NULL if you don't plan to use Genlist mode. See
14378 * elm_genlist_item_mode_set() for more info.
14380 * - @c func - A struct with pointers to functions that will be called when
14381 * an item is going to be actually created. All of them receive a @c data
14382 * parameter that will point to the same data passed to
14383 * elm_genlist_item_append() and related item creation functions, and a @c
14384 * obj parameter that points to the genlist object itself.
14386 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14387 * state_get and @c del. The 3 first functions also receive a @c part
14388 * parameter described below. A brief description of these functions follows:
14390 * - @c label_get - The @c part parameter is the name string of one of the
14391 * existing text parts in the Edje group implementing the item's theme.
14392 * This function @b must return a strdup'()ed string, as the caller will
14393 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
14394 * - @c icon_get - The @c part parameter is the name string of one of the
14395 * existing (icon) swallow parts in the Edje group implementing the item's
14396 * theme. It must return @c NULL, when no icon is desired, or a valid
14397 * object handle, otherwise. The object will be deleted by the genlist on
14398 * its deletion or when the item is "unrealized". See
14399 * #Elm_Genlist_Item_Icon_Get_Cb.
14400 * - @c func.state_get - The @c part parameter is the name string of one of
14401 * the state parts in the Edje group implementing the item's theme. Return
14402 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14403 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14404 * and @c "elm" as "emission" and "source" arguments, respectively, when
14405 * the state is true (the default is false), where @c XXX is the name of
14406 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
14407 * - @c func.del - This is intended for use when genlist items are deleted,
14408 * so any data attached to the item (e.g. its data parameter on creation)
14409 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
14411 * available item styles:
14413 * - default_style - The text part is a textblock
14415 * @image html img/widget/genlist/preview-04.png
14416 * @image latex img/widget/genlist/preview-04.eps
14420 * @image html img/widget/genlist/preview-01.png
14421 * @image latex img/widget/genlist/preview-01.eps
14423 * - icon_top_text_bottom
14425 * @image html img/widget/genlist/preview-02.png
14426 * @image latex img/widget/genlist/preview-02.eps
14430 * @image html img/widget/genlist/preview-03.png
14431 * @image latex img/widget/genlist/preview-03.eps
14433 * @section Genlist_Items Structure of items
14435 * An item in a genlist can have 0 or more text labels (they can be regular
14436 * text or textblock Evas objects - that's up to the style to determine), 0
14437 * or more icons (which are simply objects swallowed into the genlist item's
14438 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14439 * behavior left to the user to define. The Edje part names for each of
14440 * these properties will be looked up, in the theme file for the genlist,
14441 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14442 * "states", respectively. For each of those properties, if more than one
14443 * part is provided, they must have names listed separated by spaces in the
14444 * data fields. For the default genlist item theme, we have @b one label
14445 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14446 * "elm.swallow.end") and @b no state parts.
14448 * A genlist item may be at one of several styles. Elementary provides one
14449 * by default - "default", but this can be extended by system or application
14450 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14453 * @section Genlist_Manipulation Editing and Navigating
14455 * Items can be added by several calls. All of them return a @ref
14456 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14457 * They all take a data parameter that is meant to be used for a handle to
14458 * the applications internal data (eg the struct with the original item
14459 * data). The parent parameter is the parent genlist item this belongs to if
14460 * it is a tree or an indexed group, and NULL if there is no parent. The
14461 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14462 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14463 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14464 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14465 * is set then this item is group index item that is displayed at the top
14466 * until the next group comes. The func parameter is a convenience callback
14467 * that is called when the item is selected and the data parameter will be
14468 * the func_data parameter, obj be the genlist object and event_info will be
14469 * the genlist item.
14471 * elm_genlist_item_append() adds an item to the end of the list, or if
14472 * there is a parent, to the end of all the child items of the parent.
14473 * elm_genlist_item_prepend() is the same but adds to the beginning of
14474 * the list or children list. elm_genlist_item_insert_before() inserts at
14475 * item before another item and elm_genlist_item_insert_after() inserts after
14476 * the indicated item.
14478 * The application can clear the list with elm_genlist_clear() which deletes
14479 * all the items in the list and elm_genlist_item_del() will delete a specific
14480 * item. elm_genlist_item_subitems_clear() will clear all items that are
14481 * children of the indicated parent item.
14483 * To help inspect list items you can jump to the item at the top of the list
14484 * with elm_genlist_first_item_get() which will return the item pointer, and
14485 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14486 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14487 * and previous items respectively relative to the indicated item. Using
14488 * these calls you can walk the entire item list/tree. Note that as a tree
14489 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14490 * let you know which item is the parent (and thus know how to skip them if
14493 * @section Genlist_Muti_Selection Multi-selection
14495 * If the application wants multiple items to be able to be selected,
14496 * elm_genlist_multi_select_set() can enable this. If the list is
14497 * single-selection only (the default), then elm_genlist_selected_item_get()
14498 * will return the selected item, if any, or NULL I none is selected. If the
14499 * list is multi-select then elm_genlist_selected_items_get() will return a
14500 * list (that is only valid as long as no items are modified (added, deleted,
14501 * selected or unselected)).
14503 * @section Genlist_Usage_Hints Usage hints
14505 * There are also convenience functions. elm_genlist_item_genlist_get() will
14506 * return the genlist object the item belongs to. elm_genlist_item_show()
14507 * will make the scroller scroll to show that specific item so its visible.
14508 * elm_genlist_item_data_get() returns the data pointer set by the item
14509 * creation functions.
14511 * If an item changes (state of boolean changes, label or icons change),
14512 * then use elm_genlist_item_update() to have genlist update the item with
14513 * the new state. Genlist will re-realize the item thus call the functions
14514 * in the _Elm_Genlist_Item_Class for that item.
14516 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14517 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14518 * to expand/contract an item and get its expanded state, use
14519 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14520 * again to make an item disabled (unable to be selected and appear
14521 * differently) use elm_genlist_item_disabled_set() to set this and
14522 * elm_genlist_item_disabled_get() to get the disabled state.
14524 * In general to indicate how the genlist should expand items horizontally to
14525 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14526 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14527 * mode means that if items are too wide to fit, the scroller will scroll
14528 * horizontally. Otherwise items are expanded to fill the width of the
14529 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14530 * to the viewport width and limited to that size. This can be combined with
14531 * a different style that uses edjes' ellipsis feature (cutting text off like
14534 * Items will only call their selection func and callback when first becoming
14535 * selected. Any further clicks will do nothing, unless you enable always
14536 * select with elm_genlist_always_select_mode_set(). This means even if
14537 * selected, every click will make the selected callbacks be called.
14538 * elm_genlist_no_select_mode_set() will turn off the ability to select
14539 * items entirely and they will neither appear selected nor call selected
14540 * callback functions.
14542 * Remember that you can create new styles and add your own theme augmentation
14543 * per application with elm_theme_extension_add(). If you absolutely must
14544 * have a specific style that overrides any theme the user or system sets up
14545 * you can use elm_theme_overlay_add() to add such a file.
14547 * @section Genlist_Implementation Implementation
14549 * Evas tracks every object you create. Every time it processes an event
14550 * (mouse move, down, up etc.) it needs to walk through objects and find out
14551 * what event that affects. Even worse every time it renders display updates,
14552 * in order to just calculate what to re-draw, it needs to walk through many
14553 * many many objects. Thus, the more objects you keep active, the more
14554 * overhead Evas has in just doing its work. It is advisable to keep your
14555 * active objects to the minimum working set you need. Also remember that
14556 * object creation and deletion carries an overhead, so there is a
14557 * middle-ground, which is not easily determined. But don't keep massive lists
14558 * of objects you can't see or use. Genlist does this with list objects. It
14559 * creates and destroys them dynamically as you scroll around. It groups them
14560 * into blocks so it can determine the visibility etc. of a whole block at
14561 * once as opposed to having to walk the whole list. This 2-level list allows
14562 * for very large numbers of items to be in the list (tests have used up to
14563 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14564 * may be different sizes, every item added needs to be calculated as to its
14565 * size and thus this presents a lot of overhead on populating the list, this
14566 * genlist employs a queue. Any item added is queued and spooled off over
14567 * time, actually appearing some time later, so if your list has many members
14568 * you may find it takes a while for them to all appear, with your process
14569 * consuming a lot of CPU while it is busy spooling.
14571 * Genlist also implements a tree structure, but it does so with callbacks to
14572 * the application, with the application filling in tree structures when
14573 * requested (allowing for efficient building of a very deep tree that could
14574 * even be used for file-management). See the above smart signal callbacks for
14577 * @section Genlist_Smart_Events Genlist smart events
14579 * Signals that you can add callbacks for are:
14580 * - @c "activated" - The user has double-clicked or pressed
14581 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14582 * item that was activated.
14583 * - @c "clicked,double" - The user has double-clicked an item. The @c
14584 * event_info parameter is the item that was double-clicked.
14585 * - @c "selected" - This is called when a user has made an item selected.
14586 * The event_info parameter is the genlist item that was selected.
14587 * - @c "unselected" - This is called when a user has made an item
14588 * unselected. The event_info parameter is the genlist item that was
14590 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14591 * called and the item is now meant to be expanded. The event_info
14592 * parameter is the genlist item that was indicated to expand. It is the
14593 * job of this callback to then fill in the child items.
14594 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14595 * called and the item is now meant to be contracted. The event_info
14596 * parameter is the genlist item that was indicated to contract. It is the
14597 * job of this callback to then delete the child items.
14598 * - @c "expand,request" - This is called when a user has indicated they want
14599 * to expand a tree branch item. The callback should decide if the item can
14600 * expand (has any children) and then call elm_genlist_item_expanded_set()
14601 * appropriately to set the state. The event_info parameter is the genlist
14602 * item that was indicated to expand.
14603 * - @c "contract,request" - This is called when a user has indicated they
14604 * want to contract a tree branch item. The callback should decide if the
14605 * item can contract (has any children) and then call
14606 * elm_genlist_item_expanded_set() appropriately to set the state. The
14607 * event_info parameter is the genlist item that was indicated to contract.
14608 * - @c "realized" - This is called when the item in the list is created as a
14609 * real evas object. event_info parameter is the genlist item that was
14610 * created. The object may be deleted at any time, so it is up to the
14611 * caller to not use the object pointer from elm_genlist_item_object_get()
14612 * in a way where it may point to freed objects.
14613 * - @c "unrealized" - This is called just before an item is unrealized.
14614 * After this call icon objects provided will be deleted and the item
14615 * object itself delete or be put into a floating cache.
14616 * - @c "drag,start,up" - This is called when the item in the list has been
14617 * dragged (not scrolled) up.
14618 * - @c "drag,start,down" - This is called when the item in the list has been
14619 * dragged (not scrolled) down.
14620 * - @c "drag,start,left" - This is called when the item in the list has been
14621 * dragged (not scrolled) left.
14622 * - @c "drag,start,right" - This is called when the item in the list has
14623 * been dragged (not scrolled) right.
14624 * - @c "drag,stop" - This is called when the item in the list has stopped
14626 * - @c "drag" - This is called when the item in the list is being dragged.
14627 * - @c "longpressed" - This is called when the item is pressed for a certain
14628 * amount of time. By default it's 1 second.
14629 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14631 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14632 * until the bottom edge.
14633 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14634 * until the left edge.
14635 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14636 * until the right edge.
14637 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14639 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14641 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14643 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14645 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14646 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14647 * multi-touch pinched in.
14648 * - @c "swipe" - This is called when the genlist is swiped.
14650 * @section Genlist_Examples Examples
14652 * Here is a list of examples that use the genlist, trying to show some of
14653 * its capabilities:
14654 * - @ref genlist_example_01
14655 * - @ref genlist_example_02
14656 * - @ref genlist_example_03
14657 * - @ref genlist_example_04
14658 * - @ref genlist_example_05
14662 * @addtogroup Genlist
14667 * @enum _Elm_Genlist_Item_Flags
14668 * @typedef Elm_Genlist_Item_Flags
14670 * Defines if the item is of any special type (has subitems or it's the
14671 * index of a group), or is just a simple item.
14675 typedef enum _Elm_Genlist_Item_Flags
14677 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14678 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14679 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14680 } Elm_Genlist_Item_Flags;
14681 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14682 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14683 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14684 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14685 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. */
14686 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. */
14687 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14688 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
14690 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
14691 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
14692 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
14693 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
14696 * @struct _Elm_Genlist_Item_Class
14698 * Genlist item class definition structs.
14700 * This struct contains the style and fetching functions that will define the
14701 * contents of each item.
14703 * @see @ref Genlist_Item_Class
14705 struct _Elm_Genlist_Item_Class
14707 const char *item_style; /**< style of this class. */
14710 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
14711 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
14712 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
14713 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
14714 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14716 const char *mode_item_style;
14720 * Add a new genlist widget to the given parent Elementary
14721 * (container) object
14723 * @param parent The parent object
14724 * @return a new genlist widget handle or @c NULL, on errors
14726 * This function inserts a new genlist widget on the canvas.
14728 * @see elm_genlist_item_append()
14729 * @see elm_genlist_item_del()
14730 * @see elm_genlist_clear()
14734 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14736 * Remove all items from a given genlist widget.
14738 * @param obj The genlist object
14740 * This removes (and deletes) all items in @p obj, leaving it empty.
14742 * @see elm_genlist_item_del(), to remove just one item.
14746 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14748 * Enable or disable multi-selection in the genlist
14750 * @param obj The genlist object
14751 * @param multi Multi-select enable/disable. Default is disabled.
14753 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14754 * the list. This allows more than 1 item to be selected. To retrieve the list
14755 * of selected items, use elm_genlist_selected_items_get().
14757 * @see elm_genlist_selected_items_get()
14758 * @see elm_genlist_multi_select_get()
14762 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14764 * Gets if multi-selection in genlist is enabled or disabled.
14766 * @param obj The genlist object
14767 * @return Multi-select enabled/disabled
14768 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14770 * @see elm_genlist_multi_select_set()
14774 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14776 * This sets the horizontal stretching mode.
14778 * @param obj The genlist object
14779 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14781 * This sets the mode used for sizing items horizontally. Valid modes
14782 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14783 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14784 * the scroller will scroll horizontally. Otherwise items are expanded
14785 * to fill the width of the viewport of the scroller. If it is
14786 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14787 * limited to that size.
14789 * @see elm_genlist_horizontal_get()
14793 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14794 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14796 * Gets the horizontal stretching mode.
14798 * @param obj The genlist object
14799 * @return The mode to use
14800 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14802 * @see elm_genlist_horizontal_set()
14806 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14807 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14809 * Set the always select mode.
14811 * @param obj The genlist object
14812 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14813 * EINA_FALSE = off). Default is @c EINA_FALSE.
14815 * Items will only call their selection func and callback when first
14816 * becoming selected. Any further clicks will do nothing, unless you
14817 * enable always select with elm_genlist_always_select_mode_set().
14818 * This means that, even if selected, every click will make the selected
14819 * callbacks be called.
14821 * @see elm_genlist_always_select_mode_get()
14825 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14827 * Get the always select mode.
14829 * @param obj The genlist object
14830 * @return The always select mode
14831 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14833 * @see elm_genlist_always_select_mode_set()
14837 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14839 * Enable/disable the no select mode.
14841 * @param obj The genlist object
14842 * @param no_select The no select mode
14843 * (EINA_TRUE = on, EINA_FALSE = off)
14845 * This will turn off the ability to select items entirely and they
14846 * will neither appear selected nor call selected callback functions.
14848 * @see elm_genlist_no_select_mode_get()
14852 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14854 * Gets whether the no select mode is enabled.
14856 * @param obj The genlist object
14857 * @return The no select mode
14858 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14860 * @see elm_genlist_no_select_mode_set()
14864 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14866 * Enable/disable compress mode.
14868 * @param obj The genlist object
14869 * @param compress The compress mode
14870 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14872 * This will enable the compress mode where items are "compressed"
14873 * horizontally to fit the genlist scrollable viewport width. This is
14874 * special for genlist. Do not rely on
14875 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14876 * work as genlist needs to handle it specially.
14878 * @see elm_genlist_compress_mode_get()
14882 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14884 * Get whether the compress mode is enabled.
14886 * @param obj The genlist object
14887 * @return The compress mode
14888 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14890 * @see elm_genlist_compress_mode_set()
14894 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14896 * Enable/disable height-for-width mode.
14898 * @param obj The genlist object
14899 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14900 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14902 * With height-for-width mode the item width will be fixed (restricted
14903 * to a minimum of) to the list width when calculating its size in
14904 * order to allow the height to be calculated based on it. This allows,
14905 * for instance, text block to wrap lines if the Edje part is
14906 * configured with "text.min: 0 1".
14908 * @note This mode will make list resize slower as it will have to
14909 * recalculate every item height again whenever the list width
14912 * @note When height-for-width mode is enabled, it also enables
14913 * compress mode (see elm_genlist_compress_mode_set()) and
14914 * disables homogeneous (see elm_genlist_homogeneous_set()).
14918 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14920 * Get whether the height-for-width mode is enabled.
14922 * @param obj The genlist object
14923 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14928 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14930 * Enable/disable horizontal and vertical bouncing effect.
14932 * @param obj The genlist object
14933 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14934 * EINA_FALSE = off). Default is @c EINA_FALSE.
14935 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14936 * EINA_FALSE = off). Default is @c EINA_TRUE.
14938 * This will enable or disable the scroller bouncing effect for the
14939 * genlist. See elm_scroller_bounce_set() for details.
14941 * @see elm_scroller_bounce_set()
14942 * @see elm_genlist_bounce_get()
14946 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14948 * Get whether the horizontal and vertical bouncing effect is enabled.
14950 * @param obj The genlist object
14951 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14953 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14956 * @see elm_genlist_bounce_set()
14960 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14962 * Enable/disable homogenous mode.
14964 * @param obj The genlist object
14965 * @param homogeneous Assume the items within the genlist are of the
14966 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14969 * This will enable the homogeneous mode where items are of the same
14970 * height and width so that genlist may do the lazy-loading at its
14971 * maximum (which increases the performance for scrolling the list). This
14972 * implies 'compressed' mode.
14974 * @see elm_genlist_compress_mode_set()
14975 * @see elm_genlist_homogeneous_get()
14979 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14981 * Get whether the homogenous mode is enabled.
14983 * @param obj The genlist object
14984 * @return Assume the items within the genlist are of the same height
14985 * and width (EINA_TRUE = on, EINA_FALSE = off)
14987 * @see elm_genlist_homogeneous_set()
14991 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14993 * Set the maximum number of items within an item block
14995 * @param obj The genlist object
14996 * @param n Maximum number of items within an item block. Default is 32.
14998 * This will configure the block count to tune to the target with
14999 * particular performance matrix.
15001 * A block of objects will be used to reduce the number of operations due to
15002 * many objects in the screen. It can determine the visibility, or if the
15003 * object has changed, it theme needs to be updated, etc. doing this kind of
15004 * calculation to the entire block, instead of per object.
15006 * The default value for the block count is enough for most lists, so unless
15007 * you know you will have a lot of objects visible in the screen at the same
15008 * time, don't try to change this.
15010 * @see elm_genlist_block_count_get()
15011 * @see @ref Genlist_Implementation
15015 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
15017 * Get the maximum number of items within an item block
15019 * @param obj The genlist object
15020 * @return Maximum number of items within an item block
15022 * @see elm_genlist_block_count_set()
15026 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15028 * Set the timeout in seconds for the longpress event.
15030 * @param obj The genlist object
15031 * @param timeout timeout in seconds. Default is 1.
15033 * This option will change how long it takes to send an event "longpressed"
15034 * after the mouse down signal is sent to the list. If this event occurs, no
15035 * "clicked" event will be sent.
15037 * @see elm_genlist_longpress_timeout_set()
15041 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
15043 * Get the timeout in seconds for the longpress event.
15045 * @param obj The genlist object
15046 * @return timeout in seconds
15048 * @see elm_genlist_longpress_timeout_get()
15052 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15054 * Append a new item in a given genlist widget.
15056 * @param obj The genlist object
15057 * @param itc The item class for the item
15058 * @param data The item data
15059 * @param parent The parent item, or NULL if none
15060 * @param flags Item flags
15061 * @param func Convenience function called when the item is selected
15062 * @param func_data Data passed to @p func above.
15063 * @return A handle to the item added or @c NULL if not possible
15065 * This adds the given item to the end of the list or the end of
15066 * the children list if the @p parent is given.
15068 * @see elm_genlist_item_prepend()
15069 * @see elm_genlist_item_insert_before()
15070 * @see elm_genlist_item_insert_after()
15071 * @see elm_genlist_item_del()
15075 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);
15077 * Prepend a new item in a given genlist widget.
15079 * @param obj The genlist object
15080 * @param itc The item class for the item
15081 * @param data The item data
15082 * @param parent The parent item, or NULL if none
15083 * @param flags Item flags
15084 * @param func Convenience function called when the item is selected
15085 * @param func_data Data passed to @p func above.
15086 * @return A handle to the item added or NULL if not possible
15088 * This adds an item to the beginning of the list or beginning of the
15089 * children of the parent if given.
15091 * @see elm_genlist_item_append()
15092 * @see elm_genlist_item_insert_before()
15093 * @see elm_genlist_item_insert_after()
15094 * @see elm_genlist_item_del()
15098 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);
15100 * Insert an item before another in a genlist widget
15102 * @param obj The genlist object
15103 * @param itc The item class for the item
15104 * @param data The item data
15105 * @param before The item to place this new one before.
15106 * @param flags Item flags
15107 * @param func Convenience function called when the item is selected
15108 * @param func_data Data passed to @p func above.
15109 * @return A handle to the item added or @c NULL if not possible
15111 * This inserts an item before another in the list. It will be in the
15112 * same tree level or group as the item it is inserted before.
15114 * @see elm_genlist_item_append()
15115 * @see elm_genlist_item_prepend()
15116 * @see elm_genlist_item_insert_after()
15117 * @see elm_genlist_item_del()
15121 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);
15123 * Insert an item after another in a genlist widget
15125 * @param obj The genlist object
15126 * @param itc The item class for the item
15127 * @param data The item data
15128 * @param after The item to place this new one after.
15129 * @param flags Item flags
15130 * @param func Convenience function called when the item is selected
15131 * @param func_data Data passed to @p func above.
15132 * @return A handle to the item added or @c NULL if not possible
15134 * This inserts an item after another in the list. It will be in the
15135 * same tree level or group as the item it is inserted after.
15137 * @see elm_genlist_item_append()
15138 * @see elm_genlist_item_prepend()
15139 * @see elm_genlist_item_insert_before()
15140 * @see elm_genlist_item_del()
15144 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);
15146 * Insert a new item into the sorted genlist object
15148 * @param obj The genlist object
15149 * @param itc The item class for the item
15150 * @param data The item data
15151 * @param parent The parent item, or NULL if none
15152 * @param flags Item flags
15153 * @param comp The function called for the sort
15154 * @param func Convenience function called when item selected
15155 * @param func_data Data passed to @p func above.
15156 * @return A handle to the item added or NULL if not possible
15160 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);
15161 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);
15162 /* operations to retrieve existing items */
15164 * Get the selectd item in the genlist.
15166 * @param obj The genlist object
15167 * @return The selected item, or NULL if none is selected.
15169 * This gets the selected item in the list (if multi-selection is enabled, only
15170 * the item that was first selected in the list is returned - which is not very
15171 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
15174 * If no item is selected, NULL is returned.
15176 * @see elm_genlist_selected_items_get()
15180 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15182 * Get a list of selected items in the genlist.
15184 * @param obj The genlist object
15185 * @return The list of selected items, or NULL if none are selected.
15187 * It returns a list of the selected items. This list pointer is only valid so
15188 * long as the selection doesn't change (no items are selected or unselected, or
15189 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
15190 * pointers. The order of the items in this list is the order which they were
15191 * selected, i.e. the first item in this list is the first item that was
15192 * selected, and so on.
15194 * @note If not in multi-select mode, consider using function
15195 * elm_genlist_selected_item_get() instead.
15197 * @see elm_genlist_multi_select_set()
15198 * @see elm_genlist_selected_item_get()
15202 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15204 * Get a list of realized items in genlist
15206 * @param obj The genlist object
15207 * @return The list of realized items, nor NULL if none are realized.
15209 * This returns a list of the realized items in the genlist. The list
15210 * contains Elm_Genlist_Item pointers. The list must be freed by the
15211 * caller when done with eina_list_free(). The item pointers in the
15212 * list are only valid so long as those items are not deleted or the
15213 * genlist is not deleted.
15215 * @see elm_genlist_realized_items_update()
15219 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15221 * Get the item that is at the x, y canvas coords.
15223 * @param obj The gelinst object.
15224 * @param x The input x coordinate
15225 * @param y The input y coordinate
15226 * @param posret The position relative to the item returned here
15227 * @return The item at the coordinates or NULL if none
15229 * This returns the item at the given coordinates (which are canvas
15230 * relative, not object-relative). If an item is at that coordinate,
15231 * that item handle is returned, and if @p posret is not NULL, the
15232 * integer pointed to is set to a value of -1, 0 or 1, depending if
15233 * the coordinate is on the upper portion of that item (-1), on the
15234 * middle section (0) or on the lower part (1). If NULL is returned as
15235 * an item (no item found there), then posret may indicate -1 or 1
15236 * based if the coordinate is above or below all items respectively in
15241 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);
15243 * Get the first item in the genlist
15245 * This returns the first item in the list.
15247 * @param obj The genlist object
15248 * @return The first item, or NULL if none
15252 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15254 * Get the last item in the genlist
15256 * This returns the last item in the list.
15258 * @return The last item, or NULL if none
15262 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15264 * Set the scrollbar policy
15266 * @param obj The genlist object
15267 * @param policy_h Horizontal scrollbar policy.
15268 * @param policy_v Vertical scrollbar policy.
15270 * This sets the scrollbar visibility policy for the given genlist
15271 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15272 * made visible if it is needed, and otherwise kept hidden.
15273 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15274 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15275 * respectively for the horizontal and vertical scrollbars. Default is
15276 * #ELM_SMART_SCROLLER_POLICY_AUTO
15278 * @see elm_genlist_scroller_policy_get()
15282 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15284 * Get the scrollbar policy
15286 * @param obj The genlist object
15287 * @param policy_h Pointer to store the horizontal scrollbar policy.
15288 * @param policy_v Pointer to store the vertical scrollbar policy.
15290 * @see elm_genlist_scroller_policy_set()
15294 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);
15296 * Get the @b next item in a genlist widget's internal list of items,
15297 * given a handle to one of those items.
15299 * @param item The genlist item to fetch next from
15300 * @return The item after @p item, or @c NULL if there's none (and
15303 * This returns the item placed after the @p item, on the container
15306 * @see elm_genlist_item_prev_get()
15310 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15312 * Get the @b previous item in a genlist widget's internal list of items,
15313 * given a handle to one of those items.
15315 * @param item The genlist item to fetch previous from
15316 * @return The item before @p item, or @c NULL if there's none (and
15319 * This returns the item placed before the @p item, on the container
15322 * @see elm_genlist_item_next_get()
15326 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15328 * Get the genlist object's handle which contains a given genlist
15331 * @param item The item to fetch the container from
15332 * @return The genlist (parent) object
15334 * This returns the genlist object itself that an item belongs to.
15338 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15340 * Get the parent item of the given item
15342 * @param it The item
15343 * @return The parent of the item or @c NULL if it has no parent.
15345 * This returns the item that was specified as parent of the item @p it on
15346 * elm_genlist_item_append() and insertion related functions.
15350 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15352 * Remove all sub-items (children) of the given item
15354 * @param it The item
15356 * This removes all items that are children (and their descendants) of the
15357 * given item @p it.
15359 * @see elm_genlist_clear()
15360 * @see elm_genlist_item_del()
15364 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15366 * Set whether a given genlist item is selected or not
15368 * @param it The item
15369 * @param selected Use @c EINA_TRUE, to make it selected, @c
15370 * EINA_FALSE to make it unselected
15372 * This sets the selected state of an item. If multi selection is
15373 * not enabled on the containing genlist and @p selected is @c
15374 * EINA_TRUE, any other previously selected items will get
15375 * unselected in favor of this new one.
15377 * @see elm_genlist_item_selected_get()
15381 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15383 * Get whether a given genlist item is selected or not
15385 * @param it The item
15386 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15388 * @see elm_genlist_item_selected_set() for more details
15392 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15394 * Sets the expanded state of an item.
15396 * @param it The item
15397 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15399 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15402 * The theme will respond to this change visually, and a signal "expanded" or
15403 * "contracted" will be sent from the genlist with a pointer to the item that
15404 * has been expanded/contracted.
15406 * Calling this function won't show or hide any child of this item (if it is
15407 * a parent). You must manually delete and create them on the callbacks fo
15408 * the "expanded" or "contracted" signals.
15410 * @see elm_genlist_item_expanded_get()
15414 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15416 * Get the expanded state of an item
15418 * @param it The item
15419 * @return The expanded state
15421 * This gets the expanded state of an item.
15423 * @see elm_genlist_item_expanded_set()
15427 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15429 * Get the depth of expanded item
15431 * @param it The genlist item object
15432 * @return The depth of expanded item
15436 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15438 * Set whether a given genlist item is disabled or not.
15440 * @param it The item
15441 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15442 * to enable it back.
15444 * A disabled item cannot be selected or unselected. It will also
15445 * change its appearance, to signal the user it's disabled.
15447 * @see elm_genlist_item_disabled_get()
15451 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15453 * Get whether a given genlist item is disabled or not.
15455 * @param it The item
15456 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15459 * @see elm_genlist_item_disabled_set() for more details
15463 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15465 * Sets the display only state of an item.
15467 * @param it The item
15468 * @param display_only @c EINA_TRUE if the item is display only, @c
15469 * EINA_FALSE otherwise.
15471 * A display only item cannot be selected or unselected. It is for
15472 * display only and not selecting or otherwise clicking, dragging
15473 * etc. by the user, thus finger size rules will not be applied to
15476 * It's good to set group index items to display only state.
15478 * @see elm_genlist_item_display_only_get()
15482 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15484 * Get the display only state of an item
15486 * @param it The item
15487 * @return @c EINA_TRUE if the item is display only, @c
15488 * EINA_FALSE otherwise.
15490 * @see elm_genlist_item_display_only_set()
15494 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15496 * Show the portion of a genlist's internal list containing a given
15497 * item, immediately.
15499 * @param it The item to display
15501 * This causes genlist to jump to the given item @p it and show it (by
15502 * immediately scrolling to that position), if it is not fully visible.
15504 * @see elm_genlist_item_bring_in()
15505 * @see elm_genlist_item_top_show()
15506 * @see elm_genlist_item_middle_show()
15510 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15512 * Animatedly bring in, to the visible are of a genlist, a given
15515 * @param it The item to display
15517 * This causes genlist to jump to the given item @p it and show it (by
15518 * animatedly scrolling), if it is not fully visible. This may use animation
15519 * to do so and take a period of time
15521 * @see elm_genlist_item_show()
15522 * @see elm_genlist_item_top_bring_in()
15523 * @see elm_genlist_item_middle_bring_in()
15527 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15529 * Show the portion of a genlist's internal list containing a given
15530 * item, immediately.
15532 * @param it The item to display
15534 * This causes genlist to jump to the given item @p it and show it (by
15535 * immediately scrolling to that position), if it is not fully visible.
15537 * The item will be positioned at the top of the genlist viewport.
15539 * @see elm_genlist_item_show()
15540 * @see elm_genlist_item_top_bring_in()
15544 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15546 * Animatedly bring in, to the visible are of a genlist, a given
15549 * @param it The item
15551 * This causes genlist to jump to the given item @p it and show it (by
15552 * animatedly scrolling), if it is not fully visible. This may use animation
15553 * to do so and take a period of time
15555 * The item will be positioned at the top of the genlist viewport.
15557 * @see elm_genlist_item_bring_in()
15558 * @see elm_genlist_item_top_show()
15562 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15564 * Show the portion of a genlist's internal list containing a given
15565 * item, immediately.
15567 * @param it The item to display
15569 * This causes genlist to jump to the given item @p it and show it (by
15570 * immediately scrolling to that position), if it is not fully visible.
15572 * The item will be positioned at the middle of the genlist viewport.
15574 * @see elm_genlist_item_show()
15575 * @see elm_genlist_item_middle_bring_in()
15579 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15581 * Animatedly bring in, to the visible are of a genlist, a given
15584 * @param it The item
15586 * This causes genlist to jump to the given item @p it and show it (by
15587 * animatedly scrolling), if it is not fully visible. This may use animation
15588 * to do so and take a period of time
15590 * The item will be positioned at the middle of the genlist viewport.
15592 * @see elm_genlist_item_bring_in()
15593 * @see elm_genlist_item_middle_show()
15597 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15599 * Remove a genlist item from the its parent, deleting it.
15601 * @param item The item to be removed.
15602 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15604 * @see elm_genlist_clear(), to remove all items in a genlist at
15609 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15611 * Return the data associated to a given genlist item
15613 * @param item The genlist item.
15614 * @return the data associated to this item.
15616 * This returns the @c data value passed on the
15617 * elm_genlist_item_append() and related item addition calls.
15619 * @see elm_genlist_item_append()
15620 * @see elm_genlist_item_data_set()
15624 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15626 * Set the data associated to a given genlist item
15628 * @param item The genlist item
15629 * @param data The new data pointer to set on it
15631 * This @b overrides the @c data value passed on the
15632 * elm_genlist_item_append() and related item addition calls. This
15633 * function @b won't call elm_genlist_item_update() automatically,
15634 * so you'd issue it afterwards if you want to hove the item
15635 * updated to reflect the that new data.
15637 * @see elm_genlist_item_data_get()
15641 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15643 * Tells genlist to "orphan" icons fetchs by the item class
15645 * @param it The item
15647 * This instructs genlist to release references to icons in the item,
15648 * meaning that they will no longer be managed by genlist and are
15649 * floating "orphans" that can be re-used elsewhere if the user wants
15654 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15656 * Get the real Evas object created to implement the view of a
15657 * given genlist item
15659 * @param item The genlist item.
15660 * @return the Evas object implementing this item's view.
15662 * This returns the actual Evas object used to implement the
15663 * specified genlist item's view. This may be @c NULL, as it may
15664 * not have been created or may have been deleted, at any time, by
15665 * the genlist. <b>Do not modify this object</b> (move, resize,
15666 * show, hide, etc.), as the genlist is controlling it. This
15667 * function is for querying, emitting custom signals or hooking
15668 * lower level callbacks for events on that object. Do not delete
15669 * this object under any circumstances.
15671 * @see elm_genlist_item_data_get()
15675 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15677 * Update the contents of an item
15679 * @param it The item
15681 * This updates an item by calling all the item class functions again
15682 * to get the icons, labels and states. Use this when the original
15683 * item data has changed and the changes are desired to be reflected.
15685 * Use elm_genlist_realized_items_update() to update all already realized
15688 * @see elm_genlist_realized_items_update()
15692 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15694 * Update the item class of an item
15696 * @param it The item
15697 * @param itc The item class for the item
15699 * This sets another class fo the item, changing the way that it is
15700 * displayed. After changing the item class, elm_genlist_item_update() is
15701 * called on the item @p it.
15705 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15706 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15708 * Set the text to be shown in a given genlist item's tooltips.
15710 * @param item The genlist item
15711 * @param text The text to set in the content
15713 * This call will setup the text to be used as tooltip to that item
15714 * (analogous to elm_object_tooltip_text_set(), but being item
15715 * tooltips with higher precedence than object tooltips). It can
15716 * have only one tooltip at a time, so any previous tooltip data
15717 * will get removed.
15719 * In order to set an icon or something else as a tooltip, look at
15720 * elm_genlist_item_tooltip_content_cb_set().
15724 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15726 * Set the content to be shown in a given genlist item's tooltips
15728 * @param item The genlist item.
15729 * @param func The function returning the tooltip contents.
15730 * @param data What to provide to @a func as callback data/context.
15731 * @param del_cb Called when data is not needed anymore, either when
15732 * another callback replaces @p func, the tooltip is unset with
15733 * elm_genlist_item_tooltip_unset() or the owner @p item
15734 * dies. This callback receives as its first parameter the
15735 * given @p data, being @c event_info the item handle.
15737 * This call will setup the tooltip's contents to @p item
15738 * (analogous to elm_object_tooltip_content_cb_set(), but being
15739 * item tooltips with higher precedence than object tooltips). It
15740 * can have only one tooltip at a time, so any previous tooltip
15741 * content will get removed. @p func (with @p data) will be called
15742 * every time Elementary needs to show the tooltip and it should
15743 * return a valid Evas object, which will be fully managed by the
15744 * tooltip system, getting deleted when the tooltip is gone.
15746 * In order to set just a text as a tooltip, look at
15747 * elm_genlist_item_tooltip_text_set().
15751 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);
15753 * Unset a tooltip from a given genlist item
15755 * @param item genlist item to remove a previously set tooltip from.
15757 * This call removes any tooltip set on @p item. The callback
15758 * provided as @c del_cb to
15759 * elm_genlist_item_tooltip_content_cb_set() will be called to
15760 * notify it is not used anymore (and have resources cleaned, if
15763 * @see elm_genlist_item_tooltip_content_cb_set()
15767 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15769 * Set a different @b style for a given genlist item's tooltip.
15771 * @param item genlist item with tooltip set
15772 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15773 * "default", @c "transparent", etc)
15775 * Tooltips can have <b>alternate styles</b> to be displayed on,
15776 * which are defined by the theme set on Elementary. This function
15777 * works analogously as elm_object_tooltip_style_set(), but here
15778 * applied only to genlist item objects. The default style for
15779 * tooltips is @c "default".
15781 * @note before you set a style you should define a tooltip with
15782 * elm_genlist_item_tooltip_content_cb_set() or
15783 * elm_genlist_item_tooltip_text_set()
15785 * @see elm_genlist_item_tooltip_style_get()
15789 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15791 * Get the style set a given genlist item's tooltip.
15793 * @param item genlist item with tooltip already set on.
15794 * @return style the theme style in use, which defaults to
15795 * "default". If the object does not have a tooltip set,
15796 * then @c NULL is returned.
15798 * @see elm_genlist_item_tooltip_style_set() for more details
15802 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15804 * @brief Disable size restrictions on an object's tooltip
15805 * @param item The tooltip's anchor object
15806 * @param disable If EINA_TRUE, size restrictions are disabled
15807 * @return EINA_FALSE on failure, EINA_TRUE on success
15809 * This function allows a tooltip to expand beyond its parant window's canvas.
15810 * It will instead be limited only by the size of the display.
15812 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15814 * @brief Retrieve size restriction state of an object's tooltip
15815 * @param item The tooltip's anchor object
15816 * @return If EINA_TRUE, size restrictions are disabled
15818 * This function returns whether a tooltip is allowed to expand beyond
15819 * its parant window's canvas.
15820 * It will instead be limited only by the size of the display.
15822 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15824 * Set the type of mouse pointer/cursor decoration to be shown,
15825 * when the mouse pointer is over the given genlist widget item
15827 * @param item genlist item to customize cursor on
15828 * @param cursor the cursor type's name
15830 * This function works analogously as elm_object_cursor_set(), but
15831 * here the cursor's changing area is restricted to the item's
15832 * area, and not the whole widget's. Note that that item cursors
15833 * have precedence over widget cursors, so that a mouse over @p
15834 * item will always show cursor @p type.
15836 * If this function is called twice for an object, a previously set
15837 * cursor will be unset on the second call.
15839 * @see elm_object_cursor_set()
15840 * @see elm_genlist_item_cursor_get()
15841 * @see elm_genlist_item_cursor_unset()
15845 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15847 * Get the type of mouse pointer/cursor decoration set to be shown,
15848 * when the mouse pointer is over the given genlist widget item
15850 * @param item genlist item with custom cursor set
15851 * @return the cursor type's name or @c NULL, if no custom cursors
15852 * were set to @p item (and on errors)
15854 * @see elm_object_cursor_get()
15855 * @see elm_genlist_item_cursor_set() for more details
15856 * @see elm_genlist_item_cursor_unset()
15860 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15862 * Unset any custom mouse pointer/cursor decoration set to be
15863 * shown, when the mouse pointer is over the given genlist widget
15864 * item, thus making it show the @b default cursor again.
15866 * @param item a genlist item
15868 * Use this call to undo any custom settings on this item's cursor
15869 * decoration, bringing it back to defaults (no custom style set).
15871 * @see elm_object_cursor_unset()
15872 * @see elm_genlist_item_cursor_set() for more details
15876 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15878 * Set a different @b style for a given custom cursor set for a
15881 * @param item genlist item with custom cursor set
15882 * @param style the <b>theme style</b> to use (e.g. @c "default",
15883 * @c "transparent", etc)
15885 * This function only makes sense when one is using custom mouse
15886 * cursor decorations <b>defined in a theme file</b> , which can
15887 * have, given a cursor name/type, <b>alternate styles</b> on
15888 * it. It works analogously as elm_object_cursor_style_set(), but
15889 * here applied only to genlist item objects.
15891 * @warning Before you set a cursor style you should have defined a
15892 * custom cursor previously on the item, with
15893 * elm_genlist_item_cursor_set()
15895 * @see elm_genlist_item_cursor_engine_only_set()
15896 * @see elm_genlist_item_cursor_style_get()
15900 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15902 * Get the current @b style set for a given genlist item's custom
15905 * @param item genlist item with custom cursor set.
15906 * @return style the cursor style in use. If the object does not
15907 * have a cursor set, then @c NULL is returned.
15909 * @see elm_genlist_item_cursor_style_set() for more details
15913 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15915 * Set if the (custom) cursor for a given genlist item should be
15916 * searched in its theme, also, or should only rely on the
15917 * rendering engine.
15919 * @param item item with custom (custom) cursor already set on
15920 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15921 * only on those provided by the rendering engine, @c EINA_FALSE to
15922 * have them searched on the widget's theme, as well.
15924 * @note This call is of use only if you've set a custom cursor
15925 * for genlist items, with elm_genlist_item_cursor_set().
15927 * @note By default, cursors will only be looked for between those
15928 * provided by the rendering engine.
15932 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15934 * Get if the (custom) cursor for a given genlist item is being
15935 * searched in its theme, also, or is only relying on the rendering
15938 * @param item a genlist item
15939 * @return @c EINA_TRUE, if cursors are being looked for only on
15940 * those provided by the rendering engine, @c EINA_FALSE if they
15941 * are being searched on the widget's theme, as well.
15943 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15947 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15949 * Update the contents of all realized items.
15951 * @param obj The genlist object.
15953 * This updates all realized items by calling all the item class functions again
15954 * to get the icons, labels and states. Use this when the original
15955 * item data has changed and the changes are desired to be reflected.
15957 * To update just one item, use elm_genlist_item_update().
15959 * @see elm_genlist_realized_items_get()
15960 * @see elm_genlist_item_update()
15964 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15966 * Activate a genlist mode on an item
15968 * @param item The genlist item
15969 * @param mode Mode name
15970 * @param mode_set Boolean to define set or unset mode.
15972 * A genlist mode is a different way of selecting an item. Once a mode is
15973 * activated on an item, any other selected item is immediately unselected.
15974 * This feature provides an easy way of implementing a new kind of animation
15975 * for selecting an item, without having to entirely rewrite the item style
15976 * theme. However, the elm_genlist_selected_* API can't be used to get what
15977 * item is activate for a mode.
15979 * The current item style will still be used, but applying a genlist mode to
15980 * an item will select it using a different kind of animation.
15982 * The current active item for a mode can be found by
15983 * elm_genlist_mode_item_get().
15985 * The characteristics of genlist mode are:
15986 * - Only one mode can be active at any time, and for only one item.
15987 * - Genlist handles deactivating other items when one item is activated.
15988 * - A mode is defined in the genlist theme (edc), and more modes can easily
15990 * - A mode style and the genlist item style are different things. They
15991 * can be combined to provide a default style to the item, with some kind
15992 * of animation for that item when the mode is activated.
15994 * When a mode is activated on an item, a new view for that item is created.
15995 * The theme of this mode defines the animation that will be used to transit
15996 * the item from the old view to the new view. This second (new) view will be
15997 * active for that item while the mode is active on the item, and will be
15998 * destroyed after the mode is totally deactivated from that item.
16000 * @see elm_genlist_mode_get()
16001 * @see elm_genlist_mode_item_get()
16005 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
16007 * Get the last (or current) genlist mode used.
16009 * @param obj The genlist object
16011 * This function just returns the name of the last used genlist mode. It will
16012 * be the current mode if it's still active.
16014 * @see elm_genlist_item_mode_set()
16015 * @see elm_genlist_mode_item_get()
16019 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16021 * Get active genlist mode item
16023 * @param obj The genlist object
16024 * @return The active item for that current mode. Or @c NULL if no item is
16025 * activated with any mode.
16027 * This function returns the item that was activated with a mode, by the
16028 * function elm_genlist_item_mode_set().
16030 * @see elm_genlist_item_mode_set()
16031 * @see elm_genlist_mode_get()
16035 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16036 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
16037 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16044 * @defgroup Check Check
16046 * @image html img/widget/check/preview-00.png
16047 * @image latex img/widget/check/preview-00.eps
16048 * @image html img/widget/check/preview-01.png
16049 * @image latex img/widget/check/preview-01.eps
16050 * @image html img/widget/check/preview-02.png
16051 * @image latex img/widget/check/preview-02.eps
16053 * @brief The check widget allows for toggling a value between true and
16056 * Check objects are a lot like radio objects in layout and functionality
16057 * except they do not work as a group, but independently and only toggle the
16058 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
16059 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
16060 * returns the current state. For convenience, like the radio objects, you
16061 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
16062 * for it to modify.
16064 * Signals that you can add callbacks for are:
16065 * "changed" - This is called whenever the user changes the state of one of
16066 * the check object(event_info is NULL).
16068 * @ref tutorial_check should give you a firm grasp of how to use this widget.
16072 * @brief Add a new Check object
16074 * @param parent The parent object
16075 * @return The new object or NULL if it cannot be created
16077 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16079 * @brief Set the text label of the check object
16081 * @param obj The check object
16082 * @param label The text label string in UTF-8
16084 * @deprecated use elm_object_text_set() instead.
16086 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16088 * @brief Get the text label of the check object
16090 * @param obj The check object
16091 * @return The text label string in UTF-8
16093 * @deprecated use elm_object_text_get() instead.
16095 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16097 * @brief Set the icon object of the check object
16099 * @param obj The check object
16100 * @param icon The icon object
16102 * Once the icon object is set, a previously set one will be deleted.
16103 * If you want to keep that old content object, use the
16104 * elm_check_icon_unset() function.
16106 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16108 * @brief Get the icon object of the check object
16110 * @param obj The check object
16111 * @return The icon object
16113 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16115 * @brief Unset the icon used for the check object
16117 * @param obj The check object
16118 * @return The icon object that was being used
16120 * Unparent and return the icon object which was set for this widget.
16122 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16124 * @brief Set the on/off state of the check object
16126 * @param obj The check object
16127 * @param state The state to use (1 == on, 0 == off)
16129 * This sets the state of the check. If set
16130 * with elm_check_state_pointer_set() the state of that variable is also
16131 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
16133 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
16135 * @brief Get the state of the check object
16137 * @param obj The check object
16138 * @return The boolean state
16140 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16142 * @brief Set a convenience pointer to a boolean to change
16144 * @param obj The check object
16145 * @param statep Pointer to the boolean to modify
16147 * This sets a pointer to a boolean, that, in addition to the check objects
16148 * state will also be modified directly. To stop setting the object pointed
16149 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
16150 * then when this is called, the check objects state will also be modified to
16151 * reflect the value of the boolean @p statep points to, just like calling
16152 * elm_check_state_set().
16154 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
16160 * @defgroup Radio Radio
16162 * @image html img/widget/radio/preview-00.png
16163 * @image latex img/widget/radio/preview-00.eps
16165 * @brief Radio is a widget that allows for 1 or more options to be displayed
16166 * and have the user choose only 1 of them.
16168 * A radio object contains an indicator, an optional Label and an optional
16169 * icon object. While it's possible to have a group of only one radio they,
16170 * are normally used in groups of 2 or more. To add a radio to a group use
16171 * elm_radio_group_add(). The radio object(s) will select from one of a set
16172 * of integer values, so any value they are configuring needs to be mapped to
16173 * a set of integers. To configure what value that radio object represents,
16174 * use elm_radio_state_value_set() to set the integer it represents. To set
16175 * the value the whole group(which one is currently selected) is to indicate
16176 * use elm_radio_value_set() on any group member, and to get the groups value
16177 * use elm_radio_value_get(). For convenience the radio objects are also able
16178 * to directly set an integer(int) to the value that is selected. To specify
16179 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
16180 * The radio objects will modify this directly. That implies the pointer must
16181 * point to valid memory for as long as the radio objects exist.
16183 * Signals that you can add callbacks for are:
16184 * @li changed - This is called whenever the user changes the state of one of
16185 * the radio objects within the group of radio objects that work together.
16187 * @ref tutorial_radio show most of this API in action.
16191 * @brief Add a new radio to the parent
16193 * @param parent The parent object
16194 * @return The new object or NULL if it cannot be created
16196 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16198 * @brief Set the text label of the radio object
16200 * @param obj The radio object
16201 * @param label The text label string in UTF-8
16203 * @deprecated use elm_object_text_set() instead.
16205 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16207 * @brief Get the text label of the radio object
16209 * @param obj The radio object
16210 * @return The text label string in UTF-8
16212 * @deprecated use elm_object_text_set() instead.
16214 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16216 * @brief Set the icon object of the radio object
16218 * @param obj The radio object
16219 * @param icon The icon object
16221 * Once the icon object is set, a previously set one will be deleted. If you
16222 * want to keep that old content object, use the elm_radio_icon_unset()
16225 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16227 * @brief Get the icon object of the radio object
16229 * @param obj The radio object
16230 * @return The icon object
16232 * @see elm_radio_icon_set()
16234 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16236 * @brief Unset the icon used for the radio object
16238 * @param obj The radio object
16239 * @return The icon object that was being used
16241 * Unparent and return the icon object which was set for this widget.
16243 * @see elm_radio_icon_set()
16245 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16247 * @brief Add this radio to a group of other radio objects
16249 * @param obj The radio object
16250 * @param group Any object whose group the @p obj is to join.
16252 * Radio objects work in groups. Each member should have a different integer
16253 * value assigned. In order to have them work as a group, they need to know
16254 * about each other. This adds the given radio object to the group of which
16255 * the group object indicated is a member.
16257 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16259 * @brief Set the integer value that this radio object represents
16261 * @param obj The radio object
16262 * @param value The value to use if this radio object is selected
16264 * This sets the value of the radio.
16266 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16268 * @brief Get the integer value that this radio object represents
16270 * @param obj The radio object
16271 * @return The value used if this radio object is selected
16273 * This gets the value of the radio.
16275 * @see elm_radio_value_set()
16277 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16279 * @brief Set the value of the radio.
16281 * @param obj The radio object
16282 * @param value The value to use for the group
16284 * This sets the value of the radio group and will also set the value if
16285 * pointed to, to the value supplied, but will not call any callbacks.
16287 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16289 * @brief Get the state of the radio object
16291 * @param obj The radio object
16292 * @return The integer state
16294 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16296 * @brief Set a convenience pointer to a integer to change
16298 * @param obj The radio object
16299 * @param valuep Pointer to the integer to modify
16301 * This sets a pointer to a integer, that, in addition to the radio objects
16302 * state will also be modified directly. To stop setting the object pointed
16303 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16304 * when this is called, the radio objects state will also be modified to
16305 * reflect the value of the integer valuep points to, just like calling
16306 * elm_radio_value_set().
16308 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16314 * @defgroup Pager Pager
16316 * @image html img/widget/pager/preview-00.png
16317 * @image latex img/widget/pager/preview-00.eps
16319 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16321 * The flipping between “pages” of objects is animated. All content in pager
16322 * is kept in a stack, the last content to be added will be on the top of the
16323 * stack(be visible).
16325 * Objects can be pushed or popped from the stack or deleted as normal.
16326 * Pushes and pops will animate (and a pop will delete the object once the
16327 * animation is finished). Any object already in the pager can be promoted to
16328 * the top(from its current stacking position) through the use of
16329 * elm_pager_content_promote(). Objects are pushed to the top with
16330 * elm_pager_content_push() and when the top item is no longer wanted, simply
16331 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16332 * object is no longer needed and is not the top item, just delete it as
16333 * normal. You can query which objects are the top and bottom with
16334 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16336 * Signals that you can add callbacks for are:
16337 * "hide,finished" - when the previous page is hided
16339 * This widget has the following styles available:
16342 * @li fade_translucide
16343 * @li fade_invisible
16344 * @note This styles affect only the flipping animations, the appearance when
16345 * not animating is unaffected by styles.
16347 * @ref tutorial_pager gives a good overview of the usage of the API.
16351 * Add a new pager to the parent
16353 * @param parent The parent object
16354 * @return The new object or NULL if it cannot be created
16358 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16360 * @brief Push an object to the top of the pager stack (and show it).
16362 * @param obj The pager object
16363 * @param content The object to push
16365 * The object pushed becomes a child of the pager, it will be controlled and
16366 * deleted when the pager is deleted.
16368 * @note If the content is already in the stack use
16369 * elm_pager_content_promote().
16370 * @warning Using this function on @p content already in the stack results in
16371 * undefined behavior.
16373 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16375 * @brief Pop the object that is on top of the stack
16377 * @param obj The pager object
16379 * This pops the object that is on the top(visible) of the pager, makes it
16380 * disappear, then deletes the object. The object that was underneath it on
16381 * the stack will become visible.
16383 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16385 * @brief Moves an object already in the pager stack to the top of the stack.
16387 * @param obj The pager object
16388 * @param content The object to promote
16390 * This will take the @p content and move it to the top of the stack as
16391 * if it had been pushed there.
16393 * @note If the content isn't already in the stack use
16394 * elm_pager_content_push().
16395 * @warning Using this function on @p content not already in the stack
16396 * results in undefined behavior.
16398 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16400 * @brief Return the object at the bottom of the pager stack
16402 * @param obj The pager object
16403 * @return The bottom object or NULL if none
16405 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16407 * @brief Return the object at the top of the pager stack
16409 * @param obj The pager object
16410 * @return The top object or NULL if none
16412 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16418 * @defgroup Slideshow Slideshow
16420 * @image html img/widget/slideshow/preview-00.png
16421 * @image latex img/widget/slideshow/preview-00.eps
16423 * This widget, as the name indicates, is a pre-made image
16424 * slideshow panel, with API functions acting on (child) image
16425 * items presentation. Between those actions, are:
16426 * - advance to next/previous image
16427 * - select the style of image transition animation
16428 * - set the exhibition time for each image
16429 * - start/stop the slideshow
16431 * The transition animations are defined in the widget's theme,
16432 * consequently new animations can be added without having to
16433 * update the widget's code.
16435 * @section Slideshow_Items Slideshow items
16437 * For slideshow items, just like for @ref Genlist "genlist" ones,
16438 * the user defines a @b classes, specifying functions that will be
16439 * called on the item's creation and deletion times.
16441 * The #Elm_Slideshow_Item_Class structure contains the following
16444 * - @c func.get - When an item is displayed, this function is
16445 * called, and it's where one should create the item object, de
16446 * facto. For example, the object can be a pure Evas image object
16447 * or an Elementary @ref Photocam "photocam" widget. See
16448 * #SlideshowItemGetFunc.
16449 * - @c func.del - When an item is no more displayed, this function
16450 * is called, where the user must delete any data associated to
16451 * the item. See #SlideshowItemDelFunc.
16453 * @section Slideshow_Caching Slideshow caching
16455 * The slideshow provides facilities to have items adjacent to the
16456 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16457 * you, so that the system does not have to decode image data
16458 * anymore at the time it has to actually switch images on its
16459 * viewport. The user is able to set the numbers of items to be
16460 * cached @b before and @b after the current item, in the widget's
16463 * Smart events one can add callbacks for are:
16465 * - @c "changed" - when the slideshow switches its view to a new
16468 * List of examples for the slideshow widget:
16469 * @li @ref slideshow_example
16473 * @addtogroup Slideshow
16477 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16478 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16479 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16480 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16481 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16484 * @struct _Elm_Slideshow_Item_Class
16486 * Slideshow item class definition. See @ref Slideshow_Items for
16489 struct _Elm_Slideshow_Item_Class
16491 struct _Elm_Slideshow_Item_Class_Func
16493 SlideshowItemGetFunc get;
16494 SlideshowItemDelFunc del;
16496 }; /**< #Elm_Slideshow_Item_Class member definitions */
16499 * Add a new slideshow widget to the given parent Elementary
16500 * (container) object
16502 * @param parent The parent object
16503 * @return A new slideshow widget handle or @c NULL, on errors
16505 * This function inserts a new slideshow widget on the canvas.
16507 * @ingroup Slideshow
16509 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16512 * Add (append) a new item in a given slideshow widget.
16514 * @param obj The slideshow object
16515 * @param itc The item class for the item
16516 * @param data The item's data
16517 * @return A handle to the item added or @c NULL, on errors
16519 * Add a new item to @p obj's internal list of items, appending it.
16520 * The item's class must contain the function really fetching the
16521 * image object to show for this item, which could be an Evas image
16522 * object or an Elementary photo, for example. The @p data
16523 * parameter is going to be passed to both class functions of the
16526 * @see #Elm_Slideshow_Item_Class
16527 * @see elm_slideshow_item_sorted_insert()
16529 * @ingroup Slideshow
16531 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16534 * Insert a new item into the given slideshow widget, using the @p func
16535 * function to sort items (by item handles).
16537 * @param obj The slideshow object
16538 * @param itc The item class for the item
16539 * @param data The item's data
16540 * @param func The comparing function to be used to sort slideshow
16541 * items <b>by #Elm_Slideshow_Item item handles</b>
16542 * @return Returns The slideshow item handle, on success, or
16543 * @c NULL, on errors
16545 * Add a new item to @p obj's internal list of items, in a position
16546 * determined by the @p func comparing function. The item's class
16547 * must contain the function really fetching the image object to
16548 * show for this item, which could be an Evas image object or an
16549 * Elementary photo, for example. The @p data parameter is going to
16550 * be passed to both class functions of the item.
16552 * @see #Elm_Slideshow_Item_Class
16553 * @see elm_slideshow_item_add()
16555 * @ingroup Slideshow
16557 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);
16560 * Display a given slideshow widget's item, programmatically.
16562 * @param obj The slideshow object
16563 * @param item The item to display on @p obj's viewport
16565 * The change between the current item and @p item will use the
16566 * transition @p obj is set to use (@see
16567 * elm_slideshow_transition_set()).
16569 * @ingroup Slideshow
16571 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16574 * Slide to the @b next item, in a given slideshow widget
16576 * @param obj The slideshow object
16578 * The sliding animation @p obj is set to use will be the
16579 * transition effect used, after this call is issued.
16581 * @note If the end of the slideshow's internal list of items is
16582 * reached, it'll wrap around to the list's beginning, again.
16584 * @ingroup Slideshow
16586 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16589 * Slide to the @b previous item, in a given slideshow widget
16591 * @param obj The slideshow object
16593 * The sliding animation @p obj is set to use will be the
16594 * transition effect used, after this call is issued.
16596 * @note If the beginning of the slideshow's internal list of items
16597 * is reached, it'll wrap around to the list's end, again.
16599 * @ingroup Slideshow
16601 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16604 * Returns the list of sliding transition/effect names available, for a
16605 * given slideshow widget.
16607 * @param obj The slideshow object
16608 * @return The list of transitions (list of @b stringshared strings
16611 * The transitions, which come from @p obj's theme, must be an EDC
16612 * data item named @c "transitions" on the theme file, with (prefix)
16613 * names of EDC programs actually implementing them.
16615 * The available transitions for slideshows on the default theme are:
16616 * - @c "fade" - the current item fades out, while the new one
16617 * fades in to the slideshow's viewport.
16618 * - @c "black_fade" - the current item fades to black, and just
16619 * then, the new item will fade in.
16620 * - @c "horizontal" - the current item slides horizontally, until
16621 * it gets out of the slideshow's viewport, while the new item
16622 * comes from the left to take its place.
16623 * - @c "vertical" - the current item slides vertically, until it
16624 * gets out of the slideshow's viewport, while the new item comes
16625 * from the bottom to take its place.
16626 * - @c "square" - the new item starts to appear from the middle of
16627 * the current one, but with a tiny size, growing until its
16628 * target (full) size and covering the old one.
16630 * @warning The stringshared strings get no new references
16631 * exclusive to the user grabbing the list, here, so if you'd like
16632 * to use them out of this call's context, you'd better @c
16633 * eina_stringshare_ref() them.
16635 * @see elm_slideshow_transition_set()
16637 * @ingroup Slideshow
16639 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16642 * Set the current slide transition/effect in use for a given
16645 * @param obj The slideshow object
16646 * @param transition The new transition's name string
16648 * If @p transition is implemented in @p obj's theme (i.e., is
16649 * contained in the list returned by
16650 * elm_slideshow_transitions_get()), this new sliding effect will
16651 * be used on the widget.
16653 * @see elm_slideshow_transitions_get() for more details
16655 * @ingroup Slideshow
16657 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16660 * Get the current slide transition/effect in use for a given
16663 * @param obj The slideshow object
16664 * @return The current transition's name
16666 * @see elm_slideshow_transition_set() for more details
16668 * @ingroup Slideshow
16670 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16673 * Set the interval between each image transition on a given
16674 * slideshow widget, <b>and start the slideshow, itself</b>
16676 * @param obj The slideshow object
16677 * @param timeout The new displaying timeout for images
16679 * After this call, the slideshow widget will start cycling its
16680 * view, sequentially and automatically, with the images of the
16681 * items it has. The time between each new image displayed is going
16682 * to be @p timeout, in @b seconds. If a different timeout was set
16683 * previously and an slideshow was in progress, it will continue
16684 * with the new time between transitions, after this call.
16686 * @note A value less than or equal to 0 on @p timeout will disable
16687 * the widget's internal timer, thus halting any slideshow which
16688 * could be happening on @p obj.
16690 * @see elm_slideshow_timeout_get()
16692 * @ingroup Slideshow
16694 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16697 * Get the interval set for image transitions on a given slideshow
16700 * @param obj The slideshow object
16701 * @return Returns the timeout set on it
16703 * @see elm_slideshow_timeout_set() for more details
16705 * @ingroup Slideshow
16707 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16710 * Set if, after a slideshow is started, for a given slideshow
16711 * widget, its items should be displayed cyclically or not.
16713 * @param obj The slideshow object
16714 * @param loop Use @c EINA_TRUE to make it cycle through items or
16715 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16718 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16719 * ignore what is set by this functions, i.e., they'll @b always
16720 * cycle through items. This affects only the "automatic"
16721 * slideshow, as set by elm_slideshow_timeout_set().
16723 * @see elm_slideshow_loop_get()
16725 * @ingroup Slideshow
16727 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16730 * Get if, after a slideshow is started, for a given slideshow
16731 * widget, its items are to be displayed cyclically or not.
16733 * @param obj The slideshow object
16734 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16735 * through or @c EINA_FALSE, otherwise
16737 * @see elm_slideshow_loop_set() for more details
16739 * @ingroup Slideshow
16741 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16744 * Remove all items from a given slideshow widget
16746 * @param obj The slideshow object
16748 * This removes (and deletes) all items in @p obj, leaving it
16751 * @see elm_slideshow_item_del(), to remove just one item.
16753 * @ingroup Slideshow
16755 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16758 * Get the internal list of items in a given slideshow widget.
16760 * @param obj The slideshow object
16761 * @return The list of items (#Elm_Slideshow_Item as data) or
16762 * @c NULL on errors.
16764 * This list is @b not to be modified in any way and must not be
16765 * freed. Use the list members with functions like
16766 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16768 * @warning This list is only valid until @p obj object's internal
16769 * items list is changed. It should be fetched again with another
16770 * call to this function when changes happen.
16772 * @ingroup Slideshow
16774 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16777 * Delete a given item from a slideshow widget.
16779 * @param item The slideshow item
16781 * @ingroup Slideshow
16783 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16786 * Return the data associated with a given slideshow item
16788 * @param item The slideshow item
16789 * @return Returns the data associated to this item
16791 * @ingroup Slideshow
16793 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16796 * Returns the currently displayed item, in a given slideshow widget
16798 * @param obj The slideshow object
16799 * @return A handle to the item being displayed in @p obj or
16800 * @c NULL, if none is (and on errors)
16802 * @ingroup Slideshow
16804 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16807 * Get the real Evas object created to implement the view of a
16808 * given slideshow item
16810 * @param item The slideshow item.
16811 * @return the Evas object implementing this item's view.
16813 * This returns the actual Evas object used to implement the
16814 * specified slideshow item's view. This may be @c NULL, as it may
16815 * not have been created or may have been deleted, at any time, by
16816 * the slideshow. <b>Do not modify this object</b> (move, resize,
16817 * show, hide, etc.), as the slideshow is controlling it. This
16818 * function is for querying, emitting custom signals or hooking
16819 * lower level callbacks for events on that object. Do not delete
16820 * this object under any circumstances.
16822 * @see elm_slideshow_item_data_get()
16824 * @ingroup Slideshow
16826 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16829 * Get the the item, in a given slideshow widget, placed at
16830 * position @p nth, in its internal items list
16832 * @param obj The slideshow object
16833 * @param nth The number of the item to grab a handle to (0 being
16835 * @return The item stored in @p obj at position @p nth or @c NULL,
16836 * if there's no item with that index (and on errors)
16838 * @ingroup Slideshow
16840 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16843 * Set the current slide layout in use for a given slideshow widget
16845 * @param obj The slideshow object
16846 * @param layout The new layout's name string
16848 * If @p layout is implemented in @p obj's theme (i.e., is contained
16849 * in the list returned by elm_slideshow_layouts_get()), this new
16850 * images layout will be used on the widget.
16852 * @see elm_slideshow_layouts_get() for more details
16854 * @ingroup Slideshow
16856 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16859 * Get the current slide layout in use for a given slideshow widget
16861 * @param obj The slideshow object
16862 * @return The current layout's name
16864 * @see elm_slideshow_layout_set() for more details
16866 * @ingroup Slideshow
16868 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16871 * Returns the list of @b layout names available, for a given
16872 * slideshow widget.
16874 * @param obj The slideshow object
16875 * @return The list of layouts (list of @b stringshared strings
16878 * Slideshow layouts will change how the widget is to dispose each
16879 * image item in its viewport, with regard to cropping, scaling,
16882 * The layouts, which come from @p obj's theme, must be an EDC
16883 * data item name @c "layouts" on the theme file, with (prefix)
16884 * names of EDC programs actually implementing them.
16886 * The available layouts for slideshows on the default theme are:
16887 * - @c "fullscreen" - item images with original aspect, scaled to
16888 * touch top and down slideshow borders or, if the image's heigh
16889 * is not enough, left and right slideshow borders.
16890 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16891 * one, but always leaving 10% of the slideshow's dimensions of
16892 * distance between the item image's borders and the slideshow
16893 * borders, for each axis.
16895 * @warning The stringshared strings get no new references
16896 * exclusive to the user grabbing the list, here, so if you'd like
16897 * to use them out of this call's context, you'd better @c
16898 * eina_stringshare_ref() them.
16900 * @see elm_slideshow_layout_set()
16902 * @ingroup Slideshow
16904 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16907 * Set the number of items to cache, on a given slideshow widget,
16908 * <b>before the current item</b>
16910 * @param obj The slideshow object
16911 * @param count Number of items to cache before the current one
16913 * The default value for this property is @c 2. See
16914 * @ref Slideshow_Caching "slideshow caching" for more details.
16916 * @see elm_slideshow_cache_before_get()
16918 * @ingroup Slideshow
16920 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16923 * Retrieve the number of items to cache, on a given slideshow widget,
16924 * <b>before the current item</b>
16926 * @param obj The slideshow object
16927 * @return The number of items set to be cached before the current one
16929 * @see elm_slideshow_cache_before_set() for more details
16931 * @ingroup Slideshow
16933 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16936 * Set the number of items to cache, on a given slideshow widget,
16937 * <b>after the current item</b>
16939 * @param obj The slideshow object
16940 * @param count Number of items to cache after the current one
16942 * The default value for this property is @c 2. See
16943 * @ref Slideshow_Caching "slideshow caching" for more details.
16945 * @see elm_slideshow_cache_after_get()
16947 * @ingroup Slideshow
16949 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16952 * Retrieve the number of items to cache, on a given slideshow widget,
16953 * <b>after the current item</b>
16955 * @param obj The slideshow object
16956 * @return The number of items set to be cached after the current one
16958 * @see elm_slideshow_cache_after_set() for more details
16960 * @ingroup Slideshow
16962 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16965 * Get the number of items stored in a given slideshow widget
16967 * @param obj The slideshow object
16968 * @return The number of items on @p obj, at the moment of this call
16970 * @ingroup Slideshow
16972 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16979 * @defgroup Fileselector File Selector
16981 * @image html img/widget/fileselector/preview-00.png
16982 * @image latex img/widget/fileselector/preview-00.eps
16984 * A file selector is a widget that allows a user to navigate
16985 * through a file system, reporting file selections back via its
16988 * It contains shortcut buttons for home directory (@c ~) and to
16989 * jump one directory upwards (..), as well as cancel/ok buttons to
16990 * confirm/cancel a given selection. After either one of those two
16991 * former actions, the file selector will issue its @c "done" smart
16994 * There's a text entry on it, too, showing the name of the current
16995 * selection. There's the possibility of making it editable, so it
16996 * is useful on file saving dialogs on applications, where one
16997 * gives a file name to save contents to, in a given directory in
16998 * the system. This custom file name will be reported on the @c
16999 * "done" smart callback (explained in sequence).
17001 * Finally, it has a view to display file system items into in two
17006 * If Elementary is built with support of the Ethumb thumbnailing
17007 * library, the second form of view will display preview thumbnails
17008 * of files which it supports.
17010 * Smart callbacks one can register to:
17012 * - @c "selected" - the user has clicked on a file (when not in
17013 * folders-only mode) or directory (when in folders-only mode)
17014 * - @c "directory,open" - the list has been populated with new
17015 * content (@c event_info is a pointer to the directory's
17016 * path, a @b stringshared string)
17017 * - @c "done" - the user has clicked on the "ok" or "cancel"
17018 * buttons (@c event_info is a pointer to the selection's
17019 * path, a @b stringshared string)
17021 * Here is an example on its usage:
17022 * @li @ref fileselector_example
17026 * @addtogroup Fileselector
17031 * Defines how a file selector widget is to layout its contents
17032 * (file system entries).
17034 typedef enum _Elm_Fileselector_Mode
17036 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
17037 ELM_FILESELECTOR_GRID, /**< layout as a grid */
17038 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
17039 } Elm_Fileselector_Mode;
17042 * Add a new file selector widget to the given parent Elementary
17043 * (container) object
17045 * @param parent The parent object
17046 * @return a new file selector widget handle or @c NULL, on errors
17048 * This function inserts a new file selector widget on the canvas.
17050 * @ingroup Fileselector
17052 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17055 * Enable/disable the file name entry box where the user can type
17056 * in a name for a file, in a given file selector widget
17058 * @param obj The file selector object
17059 * @param is_save @c EINA_TRUE to make the file selector a "saving
17060 * dialog", @c EINA_FALSE otherwise
17062 * Having the entry editable is useful on file saving dialogs on
17063 * applications, where one gives a file name to save contents to,
17064 * in a given directory in the system. This custom file name will
17065 * be reported on the @c "done" smart callback.
17067 * @see elm_fileselector_is_save_get()
17069 * @ingroup Fileselector
17071 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
17074 * Get whether the given file selector is in "saving dialog" mode
17076 * @param obj The file selector object
17077 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
17078 * mode, @c EINA_FALSE otherwise (and on errors)
17080 * @see elm_fileselector_is_save_set() for more details
17082 * @ingroup Fileselector
17084 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17087 * Enable/disable folder-only view for a given file selector widget
17089 * @param obj The file selector object
17090 * @param only @c EINA_TRUE to make @p obj only display
17091 * directories, @c EINA_FALSE to make files to be displayed in it
17094 * If enabled, the widget's view will only display folder items,
17097 * @see elm_fileselector_folder_only_get()
17099 * @ingroup Fileselector
17101 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
17104 * Get whether folder-only view is set for a given file selector
17107 * @param obj The file selector object
17108 * @return only @c EINA_TRUE if @p obj is only displaying
17109 * directories, @c EINA_FALSE if files are being displayed in it
17110 * too (and on errors)
17112 * @see elm_fileselector_folder_only_get()
17114 * @ingroup Fileselector
17116 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17119 * Enable/disable the "ok" and "cancel" buttons on a given file
17122 * @param obj The file selector object
17123 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
17125 * @note A file selector without those buttons will never emit the
17126 * @c "done" smart event, and is only usable if one is just hooking
17127 * to the other two events.
17129 * @see elm_fileselector_buttons_ok_cancel_get()
17131 * @ingroup Fileselector
17133 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
17136 * Get whether the "ok" and "cancel" buttons on a given file
17137 * selector widget are being shown.
17139 * @param obj The file selector object
17140 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
17141 * otherwise (and on errors)
17143 * @see elm_fileselector_buttons_ok_cancel_set() for more details
17145 * @ingroup Fileselector
17147 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17150 * Enable/disable a tree view in the given file selector widget,
17151 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
17153 * @param obj The file selector object
17154 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
17157 * In a tree view, arrows are created on the sides of directories,
17158 * allowing them to expand in place.
17160 * @note If it's in other mode, the changes made by this function
17161 * will only be visible when one switches back to "list" mode.
17163 * @see elm_fileselector_expandable_get()
17165 * @ingroup Fileselector
17167 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
17170 * Get whether tree view is enabled for the given file selector
17173 * @param obj The file selector object
17174 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
17175 * otherwise (and or errors)
17177 * @see elm_fileselector_expandable_set() for more details
17179 * @ingroup Fileselector
17181 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17184 * Set, programmatically, the @b directory that a given file
17185 * selector widget will display contents from
17187 * @param obj The file selector object
17188 * @param path The path to display in @p obj
17190 * This will change the @b directory that @p obj is displaying. It
17191 * will also clear the text entry area on the @p obj object, which
17192 * displays select files' names.
17194 * @see elm_fileselector_path_get()
17196 * @ingroup Fileselector
17198 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17201 * Get the parent directory's path that a given file selector
17202 * widget is displaying
17204 * @param obj The file selector object
17205 * @return The (full) path of the directory the file selector is
17206 * displaying, a @b stringshared string
17208 * @see elm_fileselector_path_set()
17210 * @ingroup Fileselector
17212 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17215 * Set, programmatically, the currently selected file/directory in
17216 * the given file selector widget
17218 * @param obj The file selector object
17219 * @param path The (full) path to a file or directory
17220 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17221 * latter case occurs if the directory or file pointed to do not
17224 * @see elm_fileselector_selected_get()
17226 * @ingroup Fileselector
17228 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17231 * Get the currently selected item's (full) path, in the given file
17234 * @param obj The file selector object
17235 * @return The absolute path of the selected item, a @b
17236 * stringshared string
17238 * @note Custom editions on @p obj object's text entry, if made,
17239 * will appear on the return string of this function, naturally.
17241 * @see elm_fileselector_selected_set() for more details
17243 * @ingroup Fileselector
17245 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17248 * Set the mode in which a given file selector widget will display
17249 * (layout) file system entries in its view
17251 * @param obj The file selector object
17252 * @param mode The mode of the fileselector, being it one of
17253 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17254 * first one, naturally, will display the files in a list. The
17255 * latter will make the widget to display its entries in a grid
17258 * @note By using elm_fileselector_expandable_set(), the user may
17259 * trigger a tree view for that list.
17261 * @note If Elementary is built with support of the Ethumb
17262 * thumbnailing library, the second form of view will display
17263 * preview thumbnails of files which it supports. You must have
17264 * elm_need_ethumb() called in your Elementary for thumbnailing to
17267 * @see elm_fileselector_expandable_set().
17268 * @see elm_fileselector_mode_get().
17270 * @ingroup Fileselector
17272 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17275 * Get the mode in which a given file selector widget is displaying
17276 * (layouting) file system entries in its view
17278 * @param obj The fileselector object
17279 * @return The mode in which the fileselector is at
17281 * @see elm_fileselector_mode_set() for more details
17283 * @ingroup Fileselector
17285 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17292 * @defgroup Progressbar Progress bar
17294 * The progress bar is a widget for visually representing the
17295 * progress status of a given job/task.
17297 * A progress bar may be horizontal or vertical. It may display an
17298 * icon besides it, as well as primary and @b units labels. The
17299 * former is meant to label the widget as a whole, while the
17300 * latter, which is formatted with floating point values (and thus
17301 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17302 * units"</c>), is meant to label the widget's <b>progress
17303 * value</b>. Label, icon and unit strings/objects are @b optional
17304 * for progress bars.
17306 * A progress bar may be @b inverted, in which state it gets its
17307 * values inverted, with high values being on the left or top and
17308 * low values on the right or bottom, as opposed to normally have
17309 * the low values on the former and high values on the latter,
17310 * respectively, for horizontal and vertical modes.
17312 * The @b span of the progress, as set by
17313 * elm_progressbar_span_size_set(), is its length (horizontally or
17314 * vertically), unless one puts size hints on the widget to expand
17315 * on desired directions, by any container. That length will be
17316 * scaled by the object or applications scaling factor. At any
17317 * point code can query the progress bar for its value with
17318 * elm_progressbar_value_get().
17320 * Available widget styles for progress bars:
17322 * - @c "wheel" (simple style, no text, no progression, only
17323 * "pulse" effect is available)
17325 * Here is an example on its usage:
17326 * @li @ref progressbar_example
17330 * Add a new progress bar widget to the given parent Elementary
17331 * (container) object
17333 * @param parent The parent object
17334 * @return a new progress bar widget handle or @c NULL, on errors
17336 * This function inserts a new progress bar widget on the canvas.
17338 * @ingroup Progressbar
17340 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17343 * Set whether a given progress bar widget is at "pulsing mode" or
17346 * @param obj The progress bar object
17347 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17348 * @c EINA_FALSE to put it back to its default one
17350 * By default, progress bars will display values from the low to
17351 * high value boundaries. There are, though, contexts in which the
17352 * state of progression of a given task is @b unknown. For those,
17353 * one can set a progress bar widget to a "pulsing state", to give
17354 * the user an idea that some computation is being held, but
17355 * without exact progress values. In the default theme it will
17356 * animate its bar with the contents filling in constantly and back
17357 * to non-filled, in a loop. To start and stop this pulsing
17358 * animation, one has to explicitly call elm_progressbar_pulse().
17360 * @see elm_progressbar_pulse_get()
17361 * @see elm_progressbar_pulse()
17363 * @ingroup Progressbar
17365 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17368 * Get whether a given progress bar widget is at "pulsing mode" or
17371 * @param obj The progress bar object
17372 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17373 * if it's in the default one (and on errors)
17375 * @ingroup Progressbar
17377 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17380 * Start/stop a given progress bar "pulsing" animation, if its
17383 * @param obj The progress bar object
17384 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17385 * @c EINA_FALSE to @b stop it
17387 * @note This call won't do anything if @p obj is not under "pulsing mode".
17389 * @see elm_progressbar_pulse_set() for more details.
17391 * @ingroup Progressbar
17393 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17396 * Set the progress value (in percentage) on a given progress bar
17399 * @param obj The progress bar object
17400 * @param val The progress value (@b must be between @c 0.0 and @c
17403 * Use this call to set progress bar levels.
17405 * @note If you passes a value out of the specified range for @p
17406 * val, it will be interpreted as the @b closest of the @b boundary
17407 * values in the range.
17409 * @ingroup Progressbar
17411 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17414 * Get the progress value (in percentage) on a given progress bar
17417 * @param obj The progress bar object
17418 * @return The value of the progressbar
17420 * @see elm_progressbar_value_set() for more details
17422 * @ingroup Progressbar
17424 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17427 * Set the label of a given progress bar widget
17429 * @param obj The progress bar object
17430 * @param label The text label string, in UTF-8
17432 * @ingroup Progressbar
17433 * @deprecated use elm_object_text_set() instead.
17435 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17438 * Get the label of a given progress bar widget
17440 * @param obj The progressbar object
17441 * @return The text label string, in UTF-8
17443 * @ingroup Progressbar
17444 * @deprecated use elm_object_text_set() instead.
17446 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17449 * Set the icon object of a given progress bar widget
17451 * @param obj The progress bar object
17452 * @param icon The icon object
17454 * Use this call to decorate @p obj with an icon next to it.
17456 * @note Once the icon object is set, a previously set one will be
17457 * deleted. If you want to keep that old content object, use the
17458 * elm_progressbar_icon_unset() function.
17460 * @see elm_progressbar_icon_get()
17462 * @ingroup Progressbar
17464 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17467 * Retrieve the icon object set for a given progress bar widget
17469 * @param obj The progress bar object
17470 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17471 * otherwise (and on errors)
17473 * @see elm_progressbar_icon_set() for more details
17475 * @ingroup Progressbar
17477 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17480 * Unset an icon set on a given progress bar widget
17482 * @param obj The progress bar object
17483 * @return The icon object that was being used, if any was set, or
17484 * @c NULL, otherwise (and on errors)
17486 * This call will unparent and return the icon object which was set
17487 * for this widget, previously, on success.
17489 * @see elm_progressbar_icon_set() for more details
17491 * @ingroup Progressbar
17493 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17496 * Set the (exact) length of the bar region of a given progress bar
17499 * @param obj The progress bar object
17500 * @param size The length of the progress bar's bar region
17502 * This sets the minimum width (when in horizontal mode) or height
17503 * (when in vertical mode) of the actual bar area of the progress
17504 * bar @p obj. This in turn affects the object's minimum size. Use
17505 * this when you're not setting other size hints expanding on the
17506 * given direction (like weight and alignment hints) and you would
17507 * like it to have a specific size.
17509 * @note Icon, label and unit text around @p obj will require their
17510 * own space, which will make @p obj to require more the @p size,
17513 * @see elm_progressbar_span_size_get()
17515 * @ingroup Progressbar
17517 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17520 * Get the length set for the bar region of a given progress bar
17523 * @param obj The progress bar object
17524 * @return The length of the progress bar's bar region
17526 * If that size was not set previously, with
17527 * elm_progressbar_span_size_set(), this call will return @c 0.
17529 * @ingroup Progressbar
17531 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17534 * Set the format string for a given progress bar widget's units
17537 * @param obj The progress bar object
17538 * @param format The format string for @p obj's units label
17540 * If @c NULL is passed on @p format, it will make @p obj's units
17541 * area to be hidden completely. If not, it'll set the <b>format
17542 * string</b> for the units label's @b text. The units label is
17543 * provided a floating point value, so the units text is up display
17544 * at most one floating point falue. Note that the units label is
17545 * optional. Use a format string such as "%1.2f meters" for
17548 * @note The default format string for a progress bar is an integer
17549 * percentage, as in @c "%.0f %%".
17551 * @see elm_progressbar_unit_format_get()
17553 * @ingroup Progressbar
17555 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17558 * Retrieve the format string set for a given progress bar widget's
17561 * @param obj The progress bar object
17562 * @return The format set string for @p obj's units label or
17563 * @c NULL, if none was set (and on errors)
17565 * @see elm_progressbar_unit_format_set() for more details
17567 * @ingroup Progressbar
17569 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17572 * Set the orientation of a given progress bar widget
17574 * @param obj The progress bar object
17575 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17576 * @b horizontal, @c EINA_FALSE to make it @b vertical
17578 * Use this function to change how your progress bar is to be
17579 * disposed: vertically or horizontally.
17581 * @see elm_progressbar_horizontal_get()
17583 * @ingroup Progressbar
17585 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17588 * Retrieve the orientation of a given progress bar widget
17590 * @param obj The progress bar object
17591 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17592 * @c EINA_FALSE if it's @b vertical (and on errors)
17594 * @see elm_progressbar_horizontal_set() for more details
17596 * @ingroup Progressbar
17598 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17601 * Invert a given progress bar widget's displaying values order
17603 * @param obj The progress bar object
17604 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17605 * @c EINA_FALSE to bring it back to default, non-inverted values.
17607 * A progress bar may be @b inverted, in which state it gets its
17608 * values inverted, with high values being on the left or top and
17609 * low values on the right or bottom, as opposed to normally have
17610 * the low values on the former and high values on the latter,
17611 * respectively, for horizontal and vertical modes.
17613 * @see elm_progressbar_inverted_get()
17615 * @ingroup Progressbar
17617 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17620 * Get whether a given progress bar widget's displaying values are
17623 * @param obj The progress bar object
17624 * @return @c EINA_TRUE, if @p obj has inverted values,
17625 * @c EINA_FALSE otherwise (and on errors)
17627 * @see elm_progressbar_inverted_set() for more details
17629 * @ingroup Progressbar
17631 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17634 * @defgroup Separator Separator
17636 * @brief Separator is a very thin object used to separate other objects.
17638 * A separator can be vertical or horizontal.
17640 * @ref tutorial_separator is a good example of how to use a separator.
17644 * @brief Add a separator object to @p parent
17646 * @param parent The parent object
17648 * @return The separator object, or NULL upon failure
17650 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17652 * @brief Set the horizontal mode of a separator object
17654 * @param obj The separator object
17655 * @param horizontal If true, the separator is horizontal
17657 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17659 * @brief Get the horizontal mode of a separator object
17661 * @param obj The separator object
17662 * @return If true, the separator is horizontal
17664 * @see elm_separator_horizontal_set()
17666 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17672 * @defgroup Spinner Spinner
17673 * @ingroup Elementary
17675 * @image html img/widget/spinner/preview-00.png
17676 * @image latex img/widget/spinner/preview-00.eps
17678 * A spinner is a widget which allows the user to increase or decrease
17679 * numeric values using arrow buttons, or edit values directly, clicking
17680 * over it and typing the new value.
17682 * By default the spinner will not wrap and has a label
17683 * of "%.0f" (just showing the integer value of the double).
17685 * A spinner has a label that is formatted with floating
17686 * point values and thus accepts a printf-style format string, like
17689 * It also allows specific values to be replaced by pre-defined labels.
17691 * Smart callbacks one can register to:
17693 * - "changed" - Whenever the spinner value is changed.
17694 * - "delay,changed" - A short time after the value is changed by the user.
17695 * This will be called only when the user stops dragging for a very short
17696 * period or when they release their finger/mouse, so it avoids possibly
17697 * expensive reactions to the value change.
17699 * Available styles for it:
17701 * - @c "vertical": up/down buttons at the right side and text left aligned.
17703 * Here is an example on its usage:
17704 * @ref spinner_example
17708 * @addtogroup Spinner
17713 * Add a new spinner widget to the given parent Elementary
17714 * (container) object.
17716 * @param parent The parent object.
17717 * @return a new spinner widget handle or @c NULL, on errors.
17719 * This function inserts a new spinner widget on the canvas.
17724 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17727 * Set the format string of the displayed label.
17729 * @param obj The spinner object.
17730 * @param fmt The format string for the label display.
17732 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17733 * string for the label text. The label text is provided a floating point
17734 * value, so the label text can display up to 1 floating point value.
17735 * Note that this is optional.
17737 * Use a format string such as "%1.2f meters" for example, and it will
17738 * display values like: "3.14 meters" for a value equal to 3.14159.
17740 * Default is "%0.f".
17742 * @see elm_spinner_label_format_get()
17746 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17749 * Get the label format of the spinner.
17751 * @param obj The spinner object.
17752 * @return The text label format string in UTF-8.
17754 * @see elm_spinner_label_format_set() for details.
17758 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17761 * Set the minimum and maximum values for the spinner.
17763 * @param obj The spinner object.
17764 * @param min The minimum value.
17765 * @param max The maximum value.
17767 * Define the allowed range of values to be selected by the user.
17769 * If actual value is less than @p min, it will be updated to @p min. If it
17770 * is bigger then @p max, will be updated to @p max. Actual value can be
17771 * get with elm_spinner_value_get().
17773 * By default, min is equal to 0, and max is equal to 100.
17775 * @warning Maximum must be greater than minimum.
17777 * @see elm_spinner_min_max_get()
17781 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17784 * Get the minimum and maximum values of the spinner.
17786 * @param obj The spinner object.
17787 * @param min Pointer where to store the minimum value.
17788 * @param max Pointer where to store the maximum value.
17790 * @note If only one value is needed, the other pointer can be passed
17793 * @see elm_spinner_min_max_set() for details.
17797 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17800 * Set the step used to increment or decrement the spinner value.
17802 * @param obj The spinner object.
17803 * @param step The step value.
17805 * This value will be incremented or decremented to the displayed value.
17806 * It will be incremented while the user keep right or top arrow pressed,
17807 * and will be decremented while the user keep left or bottom arrow pressed.
17809 * The interval to increment / decrement can be set with
17810 * elm_spinner_interval_set().
17812 * By default step value is equal to 1.
17814 * @see elm_spinner_step_get()
17818 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17821 * Get the step used to increment or decrement the spinner value.
17823 * @param obj The spinner object.
17824 * @return The step value.
17826 * @see elm_spinner_step_get() for more details.
17830 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17833 * Set the value the spinner displays.
17835 * @param obj The spinner object.
17836 * @param val The value to be displayed.
17838 * Value will be presented on the label following format specified with
17839 * elm_spinner_format_set().
17841 * @warning The value must to be between min and max values. This values
17842 * are set by elm_spinner_min_max_set().
17844 * @see elm_spinner_value_get().
17845 * @see elm_spinner_format_set().
17846 * @see elm_spinner_min_max_set().
17850 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17853 * Get the value displayed by the spinner.
17855 * @param obj The spinner object.
17856 * @return The value displayed.
17858 * @see elm_spinner_value_set() for details.
17862 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17865 * Set whether the spinner should wrap when it reaches its
17866 * minimum or maximum value.
17868 * @param obj The spinner object.
17869 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17872 * Disabled by default. If disabled, when the user tries to increment the
17874 * but displayed value plus step value is bigger than maximum value,
17876 * won't allow it. The same happens when the user tries to decrement it,
17877 * but the value less step is less than minimum value.
17879 * When wrap is enabled, in such situations it will allow these changes,
17880 * but will get the value that would be less than minimum and subtracts
17881 * from maximum. Or add the value that would be more than maximum to
17885 * @li min value = 10
17886 * @li max value = 50
17887 * @li step value = 20
17888 * @li displayed value = 20
17890 * When the user decrement value (using left or bottom arrow), it will
17891 * displays @c 40, because max - (min - (displayed - step)) is
17892 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17894 * @see elm_spinner_wrap_get().
17898 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17901 * Get whether the spinner should wrap when it reaches its
17902 * minimum or maximum value.
17904 * @param obj The spinner object
17905 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17906 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17908 * @see elm_spinner_wrap_set() for details.
17912 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17915 * Set whether the spinner can be directly edited by the user or not.
17917 * @param obj The spinner object.
17918 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17919 * don't allow users to edit it directly.
17921 * Spinner objects can have edition @b disabled, in which state they will
17922 * be changed only by arrows.
17923 * Useful for contexts
17924 * where you don't want your users to interact with it writting the value.
17926 * when using special values, the user can see real value instead
17927 * of special label on edition.
17929 * It's enabled by default.
17931 * @see elm_spinner_editable_get()
17935 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17938 * Get whether the spinner can be directly edited by the user or not.
17940 * @param obj The spinner object.
17941 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17942 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17944 * @see elm_spinner_editable_set() for details.
17948 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17951 * Set a special string to display in the place of the numerical value.
17953 * @param obj The spinner object.
17954 * @param value The value to be replaced.
17955 * @param label The label to be used.
17957 * It's useful for cases when a user should select an item that is
17958 * better indicated by a label than a value. For example, weekdays or months.
17962 * sp = elm_spinner_add(win);
17963 * elm_spinner_min_max_set(sp, 1, 3);
17964 * elm_spinner_special_value_add(sp, 1, "January");
17965 * elm_spinner_special_value_add(sp, 2, "February");
17966 * elm_spinner_special_value_add(sp, 3, "March");
17967 * evas_object_show(sp);
17972 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17975 * Set the interval on time updates for an user mouse button hold
17976 * on spinner widgets' arrows.
17978 * @param obj The spinner object.
17979 * @param interval The (first) interval value in seconds.
17981 * This interval value is @b decreased while the user holds the
17982 * mouse pointer either incrementing or decrementing spinner's value.
17984 * This helps the user to get to a given value distant from the
17985 * current one easier/faster, as it will start to change quicker and
17986 * quicker on mouse button holds.
17988 * The calculation for the next change interval value, starting from
17989 * the one set with this call, is the previous interval divided by
17990 * @c 1.05, so it decreases a little bit.
17992 * The default starting interval value for automatic changes is
17995 * @see elm_spinner_interval_get()
17999 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
18002 * Get the interval on time updates for an user mouse button hold
18003 * on spinner widgets' arrows.
18005 * @param obj The spinner object.
18006 * @return The (first) interval value, in seconds, set on it.
18008 * @see elm_spinner_interval_set() for more details.
18012 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18019 * @defgroup Index Index
18021 * @image html img/widget/index/preview-00.png
18022 * @image latex img/widget/index/preview-00.eps
18024 * An index widget gives you an index for fast access to whichever
18025 * group of other UI items one might have. It's a list of text
18026 * items (usually letters, for alphabetically ordered access).
18028 * Index widgets are by default hidden and just appear when the
18029 * user clicks over it's reserved area in the canvas. In its
18030 * default theme, it's an area one @ref Fingers "finger" wide on
18031 * the right side of the index widget's container.
18033 * When items on the index are selected, smart callbacks get
18034 * called, so that its user can make other container objects to
18035 * show a given area or child object depending on the index item
18036 * selected. You'd probably be using an index together with @ref
18037 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
18040 * Smart events one can add callbacks for are:
18041 * - @c "changed" - When the selected index item changes. @c
18042 * event_info is the selected item's data pointer.
18043 * - @c "delay,changed" - When the selected index item changes, but
18044 * after a small idling period. @c event_info is the selected
18045 * item's data pointer.
18046 * - @c "selected" - When the user releases a mouse button and
18047 * selects an item. @c event_info is the selected item's data
18049 * - @c "level,up" - when the user moves a finger from the first
18050 * level to the second level
18051 * - @c "level,down" - when the user moves a finger from the second
18052 * level to the first level
18054 * The @c "delay,changed" event is so that it'll wait a small time
18055 * before actually reporting those events and, moreover, just the
18056 * last event happening on those time frames will actually be
18059 * Here are some examples on its usage:
18060 * @li @ref index_example_01
18061 * @li @ref index_example_02
18065 * @addtogroup Index
18069 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
18072 * Add a new index widget to the given parent Elementary
18073 * (container) object
18075 * @param parent The parent object
18076 * @return a new index widget handle or @c NULL, on errors
18078 * This function inserts a new index widget on the canvas.
18082 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18085 * Set whether a given index widget is or not visible,
18088 * @param obj The index object
18089 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
18091 * Not to be confused with visible as in @c evas_object_show() --
18092 * visible with regard to the widget's auto hiding feature.
18094 * @see elm_index_active_get()
18098 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
18101 * Get whether a given index widget is currently visible or not.
18103 * @param obj The index object
18104 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
18106 * @see elm_index_active_set() for more details
18110 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18113 * Set the items level for a given index widget.
18115 * @param obj The index object.
18116 * @param level @c 0 or @c 1, the currently implemented levels.
18118 * @see elm_index_item_level_get()
18122 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18125 * Get the items level set for a given index widget.
18127 * @param obj The index object.
18128 * @return @c 0 or @c 1, which are the levels @p obj might be at.
18130 * @see elm_index_item_level_set() for more information
18134 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18137 * Returns the last selected item's data, for a given index widget.
18139 * @param obj The index object.
18140 * @return The item @b data associated to the last selected item on
18141 * @p obj (or @c NULL, on errors).
18143 * @warning The returned value is @b not an #Elm_Index_Item item
18144 * handle, but the data associated to it (see the @c item parameter
18145 * in elm_index_item_append(), as an example).
18149 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18152 * Append a new item on a given index widget.
18154 * @param obj The index object.
18155 * @param letter Letter under which the item should be indexed
18156 * @param item The item data to set for the index's item
18158 * Despite the most common usage of the @p letter argument is for
18159 * single char strings, one could use arbitrary strings as index
18162 * @c item will be the pointer returned back on @c "changed", @c
18163 * "delay,changed" and @c "selected" smart events.
18167 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18170 * Prepend a new item on a given index widget.
18172 * @param obj The index object.
18173 * @param letter Letter under which the item should be indexed
18174 * @param item The item data to set for the index's item
18176 * Despite the most common usage of the @p letter argument is for
18177 * single char strings, one could use arbitrary strings as index
18180 * @c item will be the pointer returned back on @c "changed", @c
18181 * "delay,changed" and @c "selected" smart events.
18185 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18188 * Append a new item, on a given index widget, <b>after the item
18189 * having @p relative as data</b>.
18191 * @param obj The index object.
18192 * @param letter Letter under which the item should be indexed
18193 * @param item The item data to set for the index's item
18194 * @param relative The item data of the index item to be the
18195 * predecessor of this new one
18197 * Despite the most common usage of the @p letter argument is for
18198 * single char strings, one could use arbitrary strings as index
18201 * @c item will be the pointer returned back on @c "changed", @c
18202 * "delay,changed" and @c "selected" smart events.
18204 * @note If @p relative is @c NULL or if it's not found to be data
18205 * set on any previous item on @p obj, this function will behave as
18206 * elm_index_item_append().
18210 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18213 * Prepend a new item, on a given index widget, <b>after the item
18214 * having @p relative as data</b>.
18216 * @param obj The index object.
18217 * @param letter Letter under which the item should be indexed
18218 * @param item The item data to set for the index's item
18219 * @param relative The item data of the index item to be the
18220 * successor of this new one
18222 * Despite the most common usage of the @p letter argument is for
18223 * single char strings, one could use arbitrary strings as index
18226 * @c item will be the pointer returned back on @c "changed", @c
18227 * "delay,changed" and @c "selected" smart events.
18229 * @note If @p relative is @c NULL or if it's not found to be data
18230 * set on any previous item on @p obj, this function will behave as
18231 * elm_index_item_prepend().
18235 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18238 * Insert a new item into the given index widget, using @p cmp_func
18239 * function to sort items (by item handles).
18241 * @param obj The index object.
18242 * @param letter Letter under which the item should be indexed
18243 * @param item The item data to set for the index's item
18244 * @param cmp_func The comparing function to be used to sort index
18245 * items <b>by #Elm_Index_Item item handles</b>
18246 * @param cmp_data_func A @b fallback function to be called for the
18247 * sorting of index items <b>by item data</b>). It will be used
18248 * when @p cmp_func returns @c 0 (equality), which means an index
18249 * item with provided item data already exists. To decide which
18250 * data item should be pointed to by the index item in question, @p
18251 * cmp_data_func will be used. If @p cmp_data_func returns a
18252 * non-negative value, the previous index item data will be
18253 * replaced by the given @p item pointer. If the previous data need
18254 * to be freed, it should be done by the @p cmp_data_func function,
18255 * because all references to it will be lost. If this function is
18256 * not provided (@c NULL is given), index items will be @b
18257 * duplicated, if @p cmp_func returns @c 0.
18259 * Despite the most common usage of the @p letter argument is for
18260 * single char strings, one could use arbitrary strings as index
18263 * @c item will be the pointer returned back on @c "changed", @c
18264 * "delay,changed" and @c "selected" smart events.
18268 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);
18271 * Remove an item from a given index widget, <b>to be referenced by
18272 * it's data value</b>.
18274 * @param obj The index object
18275 * @param item The item's data pointer for the item to be removed
18278 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18279 * that callback function will be called by this one.
18281 * @warning The item to be removed from @p obj will be found via
18282 * its item data pointer, and not by an #Elm_Index_Item handle.
18286 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18289 * Find a given index widget's item, <b>using item data</b>.
18291 * @param obj The index object
18292 * @param item The item data pointed to by the desired index item
18293 * @return The index item handle, if found, or @c NULL otherwise
18297 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18300 * Removes @b all items from a given index widget.
18302 * @param obj The index object.
18304 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18305 * that callback function will be called for each item in @p obj.
18309 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18312 * Go to a given items level on a index widget
18314 * @param obj The index object
18315 * @param level The index level (one of @c 0 or @c 1)
18319 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18322 * Return the data associated with a given index widget item
18324 * @param it The index widget item handle
18325 * @return The data associated with @p it
18327 * @see elm_index_item_data_set()
18331 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18334 * Set the data associated with a given index widget item
18336 * @param it The index widget item handle
18337 * @param data The new data pointer to set to @p it
18339 * This sets new item data on @p it.
18341 * @warning The old data pointer won't be touched by this function, so
18342 * the user had better to free that old data himself/herself.
18346 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18349 * Set the function to be called when a given index widget item is freed.
18351 * @param it The item to set the callback on
18352 * @param func The function to call on the item's deletion
18354 * When called, @p func will have both @c data and @c event_info
18355 * arguments with the @p it item's data value and, naturally, the
18356 * @c obj argument with a handle to the parent index widget.
18360 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18363 * Get the letter (string) set on a given index widget item.
18365 * @param it The index item handle
18366 * @return The letter string set on @p it
18370 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18377 * @defgroup Photocam Photocam
18379 * @image html img/widget/photocam/preview-00.png
18380 * @image latex img/widget/photocam/preview-00.eps
18382 * This is a widget specifically for displaying high-resolution digital
18383 * camera photos giving speedy feedback (fast load), low memory footprint
18384 * and zooming and panning as well as fitting logic. It is entirely focused
18385 * on jpeg images, and takes advantage of properties of the jpeg format (via
18386 * evas loader features in the jpeg loader).
18388 * Signals that you can add callbacks for are:
18389 * @li "clicked" - This is called when a user has clicked the photo without
18391 * @li "press" - This is called when a user has pressed down on the photo.
18392 * @li "longpressed" - This is called when a user has pressed down on the
18393 * photo for a long time without dragging around.
18394 * @li "clicked,double" - This is called when a user has double-clicked the
18396 * @li "load" - Photo load begins.
18397 * @li "loaded" - This is called when the image file load is complete for the
18398 * first view (low resolution blurry version).
18399 * @li "load,detail" - Photo detailed data load begins.
18400 * @li "loaded,detail" - This is called when the image file load is complete
18401 * for the detailed image data (full resolution needed).
18402 * @li "zoom,start" - Zoom animation started.
18403 * @li "zoom,stop" - Zoom animation stopped.
18404 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18405 * @li "scroll" - the content has been scrolled (moved)
18406 * @li "scroll,anim,start" - scrolling animation has started
18407 * @li "scroll,anim,stop" - scrolling animation has stopped
18408 * @li "scroll,drag,start" - dragging the contents around has started
18409 * @li "scroll,drag,stop" - dragging the contents around has stopped
18411 * @ref tutorial_photocam shows the API in action.
18415 * @brief Types of zoom available.
18417 typedef enum _Elm_Photocam_Zoom_Mode
18419 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18420 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18421 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18422 ELM_PHOTOCAM_ZOOM_MODE_LAST
18423 } Elm_Photocam_Zoom_Mode;
18425 * @brief Add a new Photocam object
18427 * @param parent The parent object
18428 * @return The new object or NULL if it cannot be created
18430 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18432 * @brief Set the photo file to be shown
18434 * @param obj The photocam object
18435 * @param file The photo file
18436 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18438 * This sets (and shows) the specified file (with a relative or absolute
18439 * path) and will return a load error (same error that
18440 * evas_object_image_load_error_get() will return). The image will change and
18441 * adjust its size at this point and begin a background load process for this
18442 * photo that at some time in the future will be displayed at the full
18445 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18447 * @brief Returns the path of the current image file
18449 * @param obj The photocam object
18450 * @return Returns the path
18452 * @see elm_photocam_file_set()
18454 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18456 * @brief Set the zoom level of the photo
18458 * @param obj The photocam object
18459 * @param zoom The zoom level to set
18461 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18462 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18463 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18464 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18467 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18469 * @brief Get the zoom level of the photo
18471 * @param obj The photocam object
18472 * @return The current zoom level
18474 * This returns the current zoom level of the photocam object. Note that if
18475 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18476 * (which is the default), the zoom level may be changed at any time by the
18477 * photocam object itself to account for photo size and photocam viewpoer
18480 * @see elm_photocam_zoom_set()
18481 * @see elm_photocam_zoom_mode_set()
18483 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18485 * @brief Set the zoom mode
18487 * @param obj The photocam object
18488 * @param mode The desired mode
18490 * This sets the zoom mode to manual or one of several automatic levels.
18491 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18492 * elm_photocam_zoom_set() and will stay at that level until changed by code
18493 * or until zoom mode is changed. This is the default mode. The Automatic
18494 * modes will allow the photocam object to automatically adjust zoom mode
18495 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18496 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18497 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18498 * pixels within the frame are left unfilled.
18500 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18502 * @brief Get the zoom mode
18504 * @param obj The photocam object
18505 * @return The current zoom mode
18507 * This gets the current zoom mode of the photocam object.
18509 * @see elm_photocam_zoom_mode_set()
18511 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18513 * @brief Get the current image pixel width and height
18515 * @param obj The photocam object
18516 * @param w A pointer to the width return
18517 * @param h A pointer to the height return
18519 * This gets the current photo pixel width and height (for the original).
18520 * The size will be returned in the integers @p w and @p h that are pointed
18523 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18525 * @brief Get the area of the image that is currently shown
18528 * @param x A pointer to the X-coordinate of region
18529 * @param y A pointer to the Y-coordinate of region
18530 * @param w A pointer to the width
18531 * @param h A pointer to the height
18533 * @see elm_photocam_image_region_show()
18534 * @see elm_photocam_image_region_bring_in()
18536 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18538 * @brief Set the viewed portion of the image
18540 * @param obj The photocam object
18541 * @param x X-coordinate of region in image original pixels
18542 * @param y Y-coordinate of region in image original pixels
18543 * @param w Width of region in image original pixels
18544 * @param h Height of region in image original pixels
18546 * This shows the region of the image without using animation.
18548 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18550 * @brief Bring in the viewed portion of the image
18552 * @param obj The photocam object
18553 * @param x X-coordinate of region in image original pixels
18554 * @param y Y-coordinate of region in image original pixels
18555 * @param w Width of region in image original pixels
18556 * @param h Height of region in image original pixels
18558 * This shows the region of the image using animation.
18560 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18562 * @brief Set the paused state for photocam
18564 * @param obj The photocam object
18565 * @param paused The pause state to set
18567 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18568 * photocam. The default is off. This will stop zooming using animation on
18569 * zoom levels changes and change instantly. This will stop any existing
18570 * animations that are running.
18572 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18574 * @brief Get the paused state for photocam
18576 * @param obj The photocam object
18577 * @return The current paused state
18579 * This gets the current paused state for the photocam object.
18581 * @see elm_photocam_paused_set()
18583 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18585 * @brief Get the internal low-res image used for photocam
18587 * @param obj The photocam object
18588 * @return The internal image object handle, or NULL if none exists
18590 * This gets the internal image object inside photocam. Do not modify it. It
18591 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18592 * deleted at any time as well.
18594 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18596 * @brief Set the photocam scrolling bouncing.
18598 * @param obj The photocam object
18599 * @param h_bounce bouncing for horizontal
18600 * @param v_bounce bouncing for vertical
18602 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18604 * @brief Get the photocam scrolling bouncing.
18606 * @param obj The photocam object
18607 * @param h_bounce bouncing for horizontal
18608 * @param v_bounce bouncing for vertical
18610 * @see elm_photocam_bounce_set()
18612 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18618 * @defgroup Map Map
18619 * @ingroup Elementary
18621 * @image html img/widget/map/preview-00.png
18622 * @image latex img/widget/map/preview-00.eps
18624 * This is a widget specifically for displaying a map. It uses basically
18625 * OpenStreetMap provider http://www.openstreetmap.org/,
18626 * but custom providers can be added.
18628 * It supports some basic but yet nice features:
18629 * @li zoom and scroll
18630 * @li markers with content to be displayed when user clicks over it
18631 * @li group of markers
18634 * Smart callbacks one can listen to:
18636 * - "clicked" - This is called when a user has clicked the map without
18638 * - "press" - This is called when a user has pressed down on the map.
18639 * - "longpressed" - This is called when a user has pressed down on the map
18640 * for a long time without dragging around.
18641 * - "clicked,double" - This is called when a user has double-clicked
18643 * - "load,detail" - Map detailed data load begins.
18644 * - "loaded,detail" - This is called when all currently visible parts of
18645 * the map are loaded.
18646 * - "zoom,start" - Zoom animation started.
18647 * - "zoom,stop" - Zoom animation stopped.
18648 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18649 * - "scroll" - the content has been scrolled (moved).
18650 * - "scroll,anim,start" - scrolling animation has started.
18651 * - "scroll,anim,stop" - scrolling animation has stopped.
18652 * - "scroll,drag,start" - dragging the contents around has started.
18653 * - "scroll,drag,stop" - dragging the contents around has stopped.
18654 * - "downloaded" - This is called when all currently required map images
18656 * - "route,load" - This is called when route request begins.
18657 * - "route,loaded" - This is called when route request ends.
18658 * - "name,load" - This is called when name request begins.
18659 * - "name,loaded- This is called when name request ends.
18661 * Available style for map widget:
18664 * Available style for markers:
18669 * Available style for marker bubble:
18672 * List of examples:
18673 * @li @ref map_example_01
18674 * @li @ref map_example_02
18675 * @li @ref map_example_03
18684 * @enum _Elm_Map_Zoom_Mode
18685 * @typedef Elm_Map_Zoom_Mode
18687 * Set map's zoom behavior. It can be set to manual or automatic.
18689 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18691 * Values <b> don't </b> work as bitmask, only one can be choosen.
18693 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18694 * than the scroller view.
18696 * @see elm_map_zoom_mode_set()
18697 * @see elm_map_zoom_mode_get()
18701 typedef enum _Elm_Map_Zoom_Mode
18703 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18704 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18705 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18706 ELM_MAP_ZOOM_MODE_LAST
18707 } Elm_Map_Zoom_Mode;
18710 * @enum _Elm_Map_Route_Sources
18711 * @typedef Elm_Map_Route_Sources
18713 * Set route service to be used. By default used source is
18714 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18716 * @see elm_map_route_source_set()
18717 * @see elm_map_route_source_get()
18721 typedef enum _Elm_Map_Route_Sources
18723 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18724 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. */
18725 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18726 ELM_MAP_ROUTE_SOURCE_LAST
18727 } Elm_Map_Route_Sources;
18729 typedef enum _Elm_Map_Name_Sources
18731 ELM_MAP_NAME_SOURCE_NOMINATIM,
18732 ELM_MAP_NAME_SOURCE_LAST
18733 } Elm_Map_Name_Sources;
18736 * @enum _Elm_Map_Route_Type
18737 * @typedef Elm_Map_Route_Type
18739 * Set type of transport used on route.
18741 * @see elm_map_route_add()
18745 typedef enum _Elm_Map_Route_Type
18747 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18748 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18749 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18750 ELM_MAP_ROUTE_TYPE_LAST
18751 } Elm_Map_Route_Type;
18754 * @enum _Elm_Map_Route_Method
18755 * @typedef Elm_Map_Route_Method
18757 * Set the routing method, what should be priorized, time or distance.
18759 * @see elm_map_route_add()
18763 typedef enum _Elm_Map_Route_Method
18765 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18766 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18767 ELM_MAP_ROUTE_METHOD_LAST
18768 } Elm_Map_Route_Method;
18770 typedef enum _Elm_Map_Name_Method
18772 ELM_MAP_NAME_METHOD_SEARCH,
18773 ELM_MAP_NAME_METHOD_REVERSE,
18774 ELM_MAP_NAME_METHOD_LAST
18775 } Elm_Map_Name_Method;
18777 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(). */
18778 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(). */
18779 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(). */
18780 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(). */
18781 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18782 typedef struct _Elm_Map_Track Elm_Map_Track;
18784 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. */
18785 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18786 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18787 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18789 typedef char *(*ElmMapModuleSourceFunc) (void);
18790 typedef int (*ElmMapModuleZoomMinFunc) (void);
18791 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18792 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18793 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18794 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18795 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18796 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18797 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18800 * Add a new map widget to the given parent Elementary (container) object.
18802 * @param parent The parent object.
18803 * @return a new map widget handle or @c NULL, on errors.
18805 * This function inserts a new map widget on the canvas.
18809 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18812 * Set the zoom level of the map.
18814 * @param obj The map object.
18815 * @param zoom The zoom level to set.
18817 * This sets the zoom level.
18819 * It will respect limits defined by elm_map_source_zoom_min_set() and
18820 * elm_map_source_zoom_max_set().
18822 * By default these values are 0 (world map) and 18 (maximum zoom).
18824 * This function should be used when zoom mode is set to
18825 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18826 * with elm_map_zoom_mode_set().
18828 * @see elm_map_zoom_mode_set().
18829 * @see elm_map_zoom_get().
18833 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18836 * Get the zoom level of the map.
18838 * @param obj The map object.
18839 * @return The current zoom level.
18841 * This returns the current zoom level of the map object.
18843 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18844 * (which is the default), the zoom level may be changed at any time by the
18845 * map object itself to account for map size and map viewport size.
18847 * @see elm_map_zoom_set() for details.
18851 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18854 * Set the zoom mode used by the map object.
18856 * @param obj The map object.
18857 * @param mode The zoom mode of the map, being it one of
18858 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18859 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18861 * This sets the zoom mode to manual or one of the automatic levels.
18862 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18863 * elm_map_zoom_set() and will stay at that level until changed by code
18864 * or until zoom mode is changed. This is the default mode.
18866 * The Automatic modes will allow the map object to automatically
18867 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18868 * adjust zoom so the map fits inside the scroll frame with no pixels
18869 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18870 * ensure no pixels within the frame are left unfilled. Do not forget that
18871 * the valid sizes are 2^zoom, consequently the map may be smaller than
18872 * the scroller view.
18874 * @see elm_map_zoom_set()
18878 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18881 * Get the zoom mode used by the map object.
18883 * @param obj The map object.
18884 * @return The zoom mode of the map, being it one of
18885 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18886 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18888 * This function returns the current zoom mode used by the map object.
18890 * @see elm_map_zoom_mode_set() for more details.
18894 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18897 * Get the current coordinates of the map.
18899 * @param obj The map object.
18900 * @param lon Pointer where to store longitude.
18901 * @param lat Pointer where to store latitude.
18903 * This gets the current center coordinates of the map object. It can be
18904 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18906 * @see elm_map_geo_region_bring_in()
18907 * @see elm_map_geo_region_show()
18911 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18914 * Animatedly bring in given coordinates to the center of the map.
18916 * @param obj The map object.
18917 * @param lon Longitude to center at.
18918 * @param lat Latitude to center at.
18920 * This causes map to jump to the given @p lat and @p lon coordinates
18921 * and show it (by scrolling) in the center of the viewport, if it is not
18922 * already centered. This will use animation to do so and take a period
18923 * of time to complete.
18925 * @see elm_map_geo_region_show() for a function to avoid animation.
18926 * @see elm_map_geo_region_get()
18930 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18933 * Show the given coordinates at the center of the map, @b immediately.
18935 * @param obj The map object.
18936 * @param lon Longitude to center at.
18937 * @param lat Latitude to center at.
18939 * This causes map to @b redraw its viewport's contents to the
18940 * region contining the given @p lat and @p lon, that will be moved to the
18941 * center of the map.
18943 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18944 * @see elm_map_geo_region_get()
18948 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18951 * Pause or unpause the map.
18953 * @param obj The map object.
18954 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18957 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18960 * The default is off.
18962 * This will stop zooming using animation, changing zoom levels will
18963 * change instantly. This will stop any existing animations that are running.
18965 * @see elm_map_paused_get()
18969 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18972 * Get a value whether map is paused or not.
18974 * @param obj The map object.
18975 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18976 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18978 * This gets the current paused state for the map object.
18980 * @see elm_map_paused_set() for details.
18984 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18987 * Set to show markers during zoom level changes or not.
18989 * @param obj The map object.
18990 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18993 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18996 * The default is off.
18998 * This will stop zooming using animation, changing zoom levels will
18999 * change instantly. This will stop any existing animations that are running.
19001 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19004 * The default is off.
19006 * Enabling it will force the map to stop displaying the markers during
19007 * zoom level changes. Set to on if you have a large number of markers.
19009 * @see elm_map_paused_markers_get()
19013 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
19016 * Get a value whether markers will be displayed on zoom level changes or not
19018 * @param obj The map object.
19019 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
19020 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
19022 * This gets the current markers paused state for the map object.
19024 * @see elm_map_paused_markers_set() for details.
19028 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19031 * Get the information of downloading status.
19033 * @param obj The map object.
19034 * @param try_num Pointer where to store number of tiles being downloaded.
19035 * @param finish_num Pointer where to store number of tiles successfully
19038 * This gets the current downloading status for the map object, the number
19039 * of tiles being downloaded and the number of tiles already downloaded.
19043 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
19046 * Convert a pixel coordinate (x,y) into a geographic coordinate
19047 * (longitude, latitude).
19049 * @param obj The map object.
19050 * @param x the coordinate.
19051 * @param y the coordinate.
19052 * @param size the size in pixels of the map.
19053 * The map is a square and generally his size is : pow(2.0, zoom)*256.
19054 * @param lon Pointer where to store the longitude that correspond to x.
19055 * @param lat Pointer where to store the latitude that correspond to y.
19057 * @note Origin pixel point is the top left corner of the viewport.
19058 * Map zoom and size are taken on account.
19060 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
19064 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);
19067 * Convert a geographic coordinate (longitude, latitude) into a pixel
19068 * coordinate (x, y).
19070 * @param obj The map object.
19071 * @param lon the longitude.
19072 * @param lat the latitude.
19073 * @param size the size in pixels of the map. The map is a square
19074 * and generally his size is : pow(2.0, zoom)*256.
19075 * @param x Pointer where to store the horizontal pixel coordinate that
19076 * correspond to the longitude.
19077 * @param y Pointer where to store the vertical pixel coordinate that
19078 * correspond to the latitude.
19080 * @note Origin pixel point is the top left corner of the viewport.
19081 * Map zoom and size are taken on account.
19083 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
19087 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);
19090 * Convert a geographic coordinate (longitude, latitude) into a name
19093 * @param obj The map object.
19094 * @param lon the longitude.
19095 * @param lat the latitude.
19096 * @return name A #Elm_Map_Name handle for this coordinate.
19098 * To get the string for this address, elm_map_name_address_get()
19101 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
19105 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
19108 * Convert a name (address) into a geographic coordinate
19109 * (longitude, latitude).
19111 * @param obj The map object.
19112 * @param name The address.
19113 * @return name A #Elm_Map_Name handle for this address.
19115 * To get the longitude and latitude, elm_map_name_region_get()
19118 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
19122 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
19125 * Convert a pixel coordinate into a rotated pixel coordinate.
19127 * @param obj The map object.
19128 * @param x horizontal coordinate of the point to rotate.
19129 * @param y vertical coordinate of the point to rotate.
19130 * @param cx rotation's center horizontal position.
19131 * @param cy rotation's center vertical position.
19132 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
19133 * @param xx Pointer where to store rotated x.
19134 * @param yy Pointer where to store rotated y.
19138 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);
19141 * Add a new marker to the map object.
19143 * @param obj The map object.
19144 * @param lon The longitude of the marker.
19145 * @param lat The latitude of the marker.
19146 * @param clas The class, to use when marker @b isn't grouped to others.
19147 * @param clas_group The class group, to use when marker is grouped to others
19148 * @param data The data passed to the callbacks.
19150 * @return The created marker or @c NULL upon failure.
19152 * A marker will be created and shown in a specific point of the map, defined
19153 * by @p lon and @p lat.
19155 * It will be displayed using style defined by @p class when this marker
19156 * is displayed alone (not grouped). A new class can be created with
19157 * elm_map_marker_class_new().
19159 * If the marker is grouped to other markers, it will be displayed with
19160 * style defined by @p class_group. Markers with the same group are grouped
19161 * if they are close. A new group class can be created with
19162 * elm_map_marker_group_class_new().
19164 * Markers created with this method can be deleted with
19165 * elm_map_marker_remove().
19167 * A marker can have associated content to be displayed by a bubble,
19168 * when a user click over it, as well as an icon. These objects will
19169 * be fetch using class' callback functions.
19171 * @see elm_map_marker_class_new()
19172 * @see elm_map_marker_group_class_new()
19173 * @see elm_map_marker_remove()
19177 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);
19180 * Set the maximum numbers of markers' content to be displayed in a group.
19182 * @param obj The map object.
19183 * @param max The maximum numbers of items displayed in a bubble.
19185 * A bubble will be displayed when the user clicks over the group,
19186 * and will place the content of markers that belong to this group
19189 * A group can have a long list of markers, consequently the creation
19190 * of the content of the bubble can be very slow.
19192 * In order to avoid this, a maximum number of items is displayed
19195 * By default this number is 30.
19197 * Marker with the same group class are grouped if they are close.
19199 * @see elm_map_marker_add()
19203 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
19206 * Remove a marker from the map.
19208 * @param marker The marker to remove.
19210 * @see elm_map_marker_add()
19214 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19217 * Get the current coordinates of the marker.
19219 * @param marker marker.
19220 * @param lat Pointer where to store the marker's latitude.
19221 * @param lon Pointer where to store the marker's longitude.
19223 * These values are set when adding markers, with function
19224 * elm_map_marker_add().
19226 * @see elm_map_marker_add()
19230 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19233 * Animatedly bring in given marker to the center of the map.
19235 * @param marker The marker to center at.
19237 * This causes map to jump to the given @p marker's coordinates
19238 * and show it (by scrolling) in the center of the viewport, if it is not
19239 * already centered. This will use animation to do so and take a period
19240 * of time to complete.
19242 * @see elm_map_marker_show() for a function to avoid animation.
19243 * @see elm_map_marker_region_get()
19247 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19250 * Show the given marker at the center of the map, @b immediately.
19252 * @param marker The marker to center at.
19254 * This causes map to @b redraw its viewport's contents to the
19255 * region contining the given @p marker's coordinates, that will be
19256 * moved to the center of the map.
19258 * @see elm_map_marker_bring_in() for a function to move with animation.
19259 * @see elm_map_markers_list_show() if more than one marker need to be
19261 * @see elm_map_marker_region_get()
19265 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19268 * Move and zoom the map to display a list of markers.
19270 * @param markers A list of #Elm_Map_Marker handles.
19272 * The map will be centered on the center point of the markers in the list.
19273 * Then the map will be zoomed in order to fit the markers using the maximum
19274 * zoom which allows display of all the markers.
19276 * @warning All the markers should belong to the same map object.
19278 * @see elm_map_marker_show() to show a single marker.
19279 * @see elm_map_marker_bring_in()
19283 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19286 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19288 * @param marker The marker wich content should be returned.
19289 * @return Return the evas object if it exists, else @c NULL.
19291 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19292 * elm_map_marker_class_get_cb_set() should be used.
19294 * This content is what will be inside the bubble that will be displayed
19295 * when an user clicks over the marker.
19297 * This returns the actual Evas object used to be placed inside
19298 * the bubble. This may be @c NULL, as it may
19299 * not have been created or may have been deleted, at any time, by
19300 * the map. <b>Do not modify this object</b> (move, resize,
19301 * show, hide, etc.), as the map is controlling it. This
19302 * function is for querying, emitting custom signals or hooking
19303 * lower level callbacks for events on that object. Do not delete
19304 * this object under any circumstances.
19308 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19311 * Update the marker
19313 * @param marker The marker to be updated.
19315 * If a content is set to this marker, it will call function to delete it,
19316 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19317 * #ElmMapMarkerGetFunc.
19319 * These functions are set for the marker class with
19320 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19324 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19327 * Close all the bubbles opened by the user.
19329 * @param obj The map object.
19331 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19332 * when the user clicks on a marker.
19334 * This functions is set for the marker class with
19335 * elm_map_marker_class_get_cb_set().
19339 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19342 * Create a new group class.
19344 * @param obj The map object.
19345 * @return Returns the new group class.
19347 * Each marker must be associated to a group class. Markers in the same
19348 * group are grouped if they are close.
19350 * The group class defines the style of the marker when a marker is grouped
19351 * to others markers. When it is alone, another class will be used.
19353 * A group class will need to be provided when creating a marker with
19354 * elm_map_marker_add().
19356 * Some properties and functions can be set by class, as:
19357 * - style, with elm_map_group_class_style_set()
19358 * - data - to be associated to the group class. It can be set using
19359 * elm_map_group_class_data_set().
19360 * - min zoom to display markers, set with
19361 * elm_map_group_class_zoom_displayed_set().
19362 * - max zoom to group markers, set using
19363 * elm_map_group_class_zoom_grouped_set().
19364 * - visibility - set if markers will be visible or not, set with
19365 * elm_map_group_class_hide_set().
19366 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19367 * It can be set using elm_map_group_class_icon_cb_set().
19369 * @see elm_map_marker_add()
19370 * @see elm_map_group_class_style_set()
19371 * @see elm_map_group_class_data_set()
19372 * @see elm_map_group_class_zoom_displayed_set()
19373 * @see elm_map_group_class_zoom_grouped_set()
19374 * @see elm_map_group_class_hide_set()
19375 * @see elm_map_group_class_icon_cb_set()
19379 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19382 * Set the marker's style of a group class.
19384 * @param clas The group class.
19385 * @param style The style to be used by markers.
19387 * Each marker must be associated to a group class, and will use the style
19388 * defined by such class when grouped to other markers.
19390 * The following styles are provided by default theme:
19391 * @li @c radio - blue circle
19392 * @li @c radio2 - green circle
19395 * @see elm_map_group_class_new() for more details.
19396 * @see elm_map_marker_add()
19400 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19403 * Set the icon callback function of a group class.
19405 * @param clas The group class.
19406 * @param icon_get The callback function that will return the icon.
19408 * Each marker must be associated to a group class, and it can display a
19409 * custom icon. The function @p icon_get must return this icon.
19411 * @see elm_map_group_class_new() for more details.
19412 * @see elm_map_marker_add()
19416 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19419 * Set the data associated to the group class.
19421 * @param clas The group class.
19422 * @param data The new user data.
19424 * This data will be passed for callback functions, like icon get callback,
19425 * that can be set with elm_map_group_class_icon_cb_set().
19427 * If a data was previously set, the object will lose the pointer for it,
19428 * so if needs to be freed, you must do it yourself.
19430 * @see elm_map_group_class_new() for more details.
19431 * @see elm_map_group_class_icon_cb_set()
19432 * @see elm_map_marker_add()
19436 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19439 * Set the minimum zoom from where the markers are displayed.
19441 * @param clas The group class.
19442 * @param zoom The minimum zoom.
19444 * Markers only will be displayed when the map is displayed at @p zoom
19447 * @see elm_map_group_class_new() for more details.
19448 * @see elm_map_marker_add()
19452 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19455 * Set the zoom from where the markers are no more grouped.
19457 * @param clas The group class.
19458 * @param zoom The maximum zoom.
19460 * Markers only will be grouped when the map is displayed at
19461 * less than @p zoom.
19463 * @see elm_map_group_class_new() for more details.
19464 * @see elm_map_marker_add()
19468 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19471 * Set if the markers associated to the group class @clas are hidden or not.
19473 * @param clas The group class.
19474 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19477 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19482 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19485 * Create a new marker class.
19487 * @param obj The map object.
19488 * @return Returns the new group class.
19490 * Each marker must be associated to a class.
19492 * The marker class defines the style of the marker when a marker is
19493 * displayed alone, i.e., not grouped to to others markers. When grouped
19494 * it will use group class style.
19496 * A marker class will need to be provided when creating a marker with
19497 * elm_map_marker_add().
19499 * Some properties and functions can be set by class, as:
19500 * - style, with elm_map_marker_class_style_set()
19501 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19502 * It can be set using elm_map_marker_class_icon_cb_set().
19503 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19504 * Set using elm_map_marker_class_get_cb_set().
19505 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19506 * Set using elm_map_marker_class_del_cb_set().
19508 * @see elm_map_marker_add()
19509 * @see elm_map_marker_class_style_set()
19510 * @see elm_map_marker_class_icon_cb_set()
19511 * @see elm_map_marker_class_get_cb_set()
19512 * @see elm_map_marker_class_del_cb_set()
19516 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19519 * Set the marker's style of a marker class.
19521 * @param clas The marker class.
19522 * @param style The style to be used by markers.
19524 * Each marker must be associated to a marker class, and will use the style
19525 * defined by such class when alone, i.e., @b not grouped to other markers.
19527 * The following styles are provided by default theme:
19532 * @see elm_map_marker_class_new() for more details.
19533 * @see elm_map_marker_add()
19537 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19540 * Set the icon callback function of a marker class.
19542 * @param clas The marker class.
19543 * @param icon_get The callback function that will return the icon.
19545 * Each marker must be associated to a marker class, and it can display a
19546 * custom icon. The function @p icon_get must return this icon.
19548 * @see elm_map_marker_class_new() for more details.
19549 * @see elm_map_marker_add()
19553 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19556 * Set the bubble content callback function of a marker class.
19558 * @param clas The marker class.
19559 * @param get The callback function that will return the content.
19561 * Each marker must be associated to a marker class, and it can display a
19562 * a content on a bubble that opens when the user click over the marker.
19563 * The function @p get must return this content object.
19565 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19568 * @see elm_map_marker_class_new() for more details.
19569 * @see elm_map_marker_class_del_cb_set()
19570 * @see elm_map_marker_add()
19574 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19577 * Set the callback function used to delete bubble content of a marker class.
19579 * @param clas The marker class.
19580 * @param del The callback function that will delete the content.
19582 * Each marker must be associated to a marker class, and it can display a
19583 * a content on a bubble that opens when the user click over the marker.
19584 * The function to return such content can be set with
19585 * elm_map_marker_class_get_cb_set().
19587 * If this content must be freed, a callback function need to be
19588 * set for that task with this function.
19590 * If this callback is defined it will have to delete (or not) the
19591 * object inside, but if the callback is not defined the object will be
19592 * destroyed with evas_object_del().
19594 * @see elm_map_marker_class_new() for more details.
19595 * @see elm_map_marker_class_get_cb_set()
19596 * @see elm_map_marker_add()
19600 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19603 * Get the list of available sources.
19605 * @param obj The map object.
19606 * @return The source names list.
19608 * It will provide a list with all available sources, that can be set as
19609 * current source with elm_map_source_name_set(), or get with
19610 * elm_map_source_name_get().
19612 * Available sources:
19618 * @see elm_map_source_name_set() for more details.
19619 * @see elm_map_source_name_get()
19623 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19626 * Set the source of the map.
19628 * @param obj The map object.
19629 * @param source The source to be used.
19631 * Map widget retrieves images that composes the map from a web service.
19632 * This web service can be set with this method.
19634 * A different service can return a different maps with different
19635 * information and it can use different zoom values.
19637 * The @p source_name need to match one of the names provided by
19638 * elm_map_source_names_get().
19640 * The current source can be get using elm_map_source_name_get().
19642 * @see elm_map_source_names_get()
19643 * @see elm_map_source_name_get()
19648 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19651 * Get the name of currently used source.
19653 * @param obj The map object.
19654 * @return Returns the name of the source in use.
19656 * @see elm_map_source_name_set() for more details.
19660 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19663 * Set the source of the route service to be used by the map.
19665 * @param obj The map object.
19666 * @param source The route service to be used, being it one of
19667 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19668 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19670 * Each one has its own algorithm, so the route retrieved may
19671 * differ depending on the source route. Now, only the default is working.
19673 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19674 * http://www.yournavigation.org/.
19676 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19677 * assumptions. Its routing core is based on Contraction Hierarchies.
19679 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19681 * @see elm_map_route_source_get().
19685 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19688 * Get the current route source.
19690 * @param obj The map object.
19691 * @return The source of the route service used by the map.
19693 * @see elm_map_route_source_set() for details.
19697 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19700 * Set the minimum zoom of the source.
19702 * @param obj The map object.
19703 * @param zoom New minimum zoom value to be used.
19705 * By default, it's 0.
19709 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19712 * Get the minimum zoom of the source.
19714 * @param obj The map object.
19715 * @return Returns the minimum zoom of the source.
19717 * @see elm_map_source_zoom_min_set() for details.
19721 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19724 * Set the maximum zoom of the source.
19726 * @param obj The map object.
19727 * @param zoom New maximum zoom value to be used.
19729 * By default, it's 18.
19733 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19736 * Get the maximum zoom of the source.
19738 * @param obj The map object.
19739 * @return Returns the maximum zoom of the source.
19741 * @see elm_map_source_zoom_min_set() for details.
19745 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19748 * Set the user agent used by the map object to access routing services.
19750 * @param obj The map object.
19751 * @param user_agent The user agent to be used by the map.
19753 * User agent is a client application implementing a network protocol used
19754 * in communications within a client–server distributed computing system
19756 * The @p user_agent identification string will transmitted in a header
19757 * field @c User-Agent.
19759 * @see elm_map_user_agent_get()
19763 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19766 * Get the user agent used by the map object.
19768 * @param obj The map object.
19769 * @return The user agent identification string used by the map.
19771 * @see elm_map_user_agent_set() for details.
19775 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19778 * Add a new route to the map object.
19780 * @param obj The map object.
19781 * @param type The type of transport to be considered when tracing a route.
19782 * @param method The routing method, what should be priorized.
19783 * @param flon The start longitude.
19784 * @param flat The start latitude.
19785 * @param tlon The destination longitude.
19786 * @param tlat The destination latitude.
19788 * @return The created route or @c NULL upon failure.
19790 * A route will be traced by point on coordinates (@p flat, @p flon)
19791 * to point on coordinates (@p tlat, @p tlon), using the route service
19792 * set with elm_map_route_source_set().
19794 * It will take @p type on consideration to define the route,
19795 * depending if the user will be walking or driving, the route may vary.
19796 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19797 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19799 * Another parameter is what the route should priorize, the minor distance
19800 * or the less time to be spend on the route. So @p method should be one
19801 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19803 * Routes created with this method can be deleted with
19804 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19805 * and distance can be get with elm_map_route_distance_get().
19807 * @see elm_map_route_remove()
19808 * @see elm_map_route_color_set()
19809 * @see elm_map_route_distance_get()
19810 * @see elm_map_route_source_set()
19814 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);
19817 * Remove a route from the map.
19819 * @param route The route to remove.
19821 * @see elm_map_route_add()
19825 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19828 * Set the route color.
19830 * @param route The route object.
19831 * @param r Red channel value, from 0 to 255.
19832 * @param g Green channel value, from 0 to 255.
19833 * @param b Blue channel value, from 0 to 255.
19834 * @param a Alpha channel value, from 0 to 255.
19836 * It uses an additive color model, so each color channel represents
19837 * how much of each primary colors must to be used. 0 represents
19838 * ausence of this color, so if all of the three are set to 0,
19839 * the color will be black.
19841 * These component values should be integers in the range 0 to 255,
19842 * (single 8-bit byte).
19844 * This sets the color used for the route. By default, it is set to
19845 * solid red (r = 255, g = 0, b = 0, a = 255).
19847 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19849 * @see elm_map_route_color_get()
19853 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19856 * Get the route color.
19858 * @param route The route object.
19859 * @param r Pointer where to store the red channel value.
19860 * @param g Pointer where to store the green channel value.
19861 * @param b Pointer where to store the blue channel value.
19862 * @param a Pointer where to store the alpha channel value.
19864 * @see elm_map_route_color_set() for details.
19868 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19871 * Get the route distance in kilometers.
19873 * @param route The route object.
19874 * @return The distance of route (unit : km).
19878 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19881 * Get the information of route nodes.
19883 * @param route The route object.
19884 * @return Returns a string with the nodes of route.
19888 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19891 * Get the information of route waypoint.
19893 * @param route the route object.
19894 * @return Returns a string with information about waypoint of route.
19898 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19901 * Get the address of the name.
19903 * @param name The name handle.
19904 * @return Returns the address string of @p name.
19906 * This gets the coordinates of the @p name, created with one of the
19907 * conversion functions.
19909 * @see elm_map_utils_convert_name_into_coord()
19910 * @see elm_map_utils_convert_coord_into_name()
19914 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19917 * Get the current coordinates of the name.
19919 * @param name The name handle.
19920 * @param lat Pointer where to store the latitude.
19921 * @param lon Pointer where to store The longitude.
19923 * This gets the coordinates of the @p name, created with one of the
19924 * conversion functions.
19926 * @see elm_map_utils_convert_name_into_coord()
19927 * @see elm_map_utils_convert_coord_into_name()
19931 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19934 * Remove a name from the map.
19936 * @param name The name to remove.
19938 * Basically the struct handled by @p name will be freed, so convertions
19939 * between address and coordinates will be lost.
19941 * @see elm_map_utils_convert_name_into_coord()
19942 * @see elm_map_utils_convert_coord_into_name()
19946 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19951 * @param obj The map object.
19952 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19953 * @param cx Rotation's center horizontal position.
19954 * @param cy Rotation's center vertical position.
19956 * @see elm_map_rotate_get()
19960 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19963 * Get the rotate degree of the map
19965 * @param obj The map object
19966 * @param degree Pointer where to store degrees from 0.0 to 360.0
19967 * to rotate arount Z axis.
19968 * @param cx Pointer where to store rotation's center horizontal position.
19969 * @param cy Pointer where to store rotation's center vertical position.
19971 * @see elm_map_rotate_set() to set map rotation.
19975 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);
19978 * Enable or disable mouse wheel to be used to zoom in / out the map.
19980 * @param obj The map object.
19981 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19984 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19986 * It's disabled by default.
19988 * @see elm_map_wheel_disabled_get()
19992 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19995 * Get a value whether mouse wheel is enabled or not.
19997 * @param obj The map object.
19998 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19999 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20001 * Mouse wheel can be used for the user to zoom in or zoom out the map.
20003 * @see elm_map_wheel_disabled_set() for details.
20007 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20011 * Add a track on the map
20013 * @param obj The map object.
20014 * @param emap The emap route object.
20015 * @return The route object. This is an elm object of type Route.
20017 * @see elm_route_add() for details.
20021 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
20025 * Remove a track from the map
20027 * @param obj The map object.
20028 * @param route The track to remove.
20032 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
20039 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
20041 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
20043 EAPI double elm_route_lon_min_get(Evas_Object *obj);
20044 EAPI double elm_route_lat_min_get(Evas_Object *obj);
20045 EAPI double elm_route_lon_max_get(Evas_Object *obj);
20046 EAPI double elm_route_lat_max_get(Evas_Object *obj);
20050 * @defgroup Panel Panel
20052 * @image html img/widget/panel/preview-00.png
20053 * @image latex img/widget/panel/preview-00.eps
20055 * @brief A panel is a type of animated container that contains subobjects.
20056 * It can be expanded or contracted by clicking the button on it's edge.
20058 * Orientations are as follows:
20059 * @li ELM_PANEL_ORIENT_TOP
20060 * @li ELM_PANEL_ORIENT_LEFT
20061 * @li ELM_PANEL_ORIENT_RIGHT
20063 * @ref tutorial_panel shows one way to use this widget.
20066 typedef enum _Elm_Panel_Orient
20068 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
20069 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
20070 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
20071 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
20072 } Elm_Panel_Orient;
20074 * @brief Adds a panel object
20076 * @param parent The parent object
20078 * @return The panel object, or NULL on failure
20080 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20082 * @brief Sets the orientation of the panel
20084 * @param parent The parent object
20085 * @param orient The panel orientation. Can be one of the following:
20086 * @li ELM_PANEL_ORIENT_TOP
20087 * @li ELM_PANEL_ORIENT_LEFT
20088 * @li ELM_PANEL_ORIENT_RIGHT
20090 * Sets from where the panel will (dis)appear.
20092 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
20094 * @brief Get the orientation of the panel.
20096 * @param obj The panel object
20097 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
20099 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20101 * @brief Set the content of the panel.
20103 * @param obj The panel object
20104 * @param content The panel content
20106 * Once the content object is set, a previously set one will be deleted.
20107 * If you want to keep that old content object, use the
20108 * elm_panel_content_unset() function.
20110 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20112 * @brief Get the content of the panel.
20114 * @param obj The panel object
20115 * @return The content that is being used
20117 * Return the content object which is set for this widget.
20119 * @see elm_panel_content_set()
20121 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20123 * @brief Unset the content of the panel.
20125 * @param obj The panel object
20126 * @return The content that was being used
20128 * Unparent and return the content object which was set for this widget.
20130 * @see elm_panel_content_set()
20132 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20134 * @brief Set the state of the panel.
20136 * @param obj The panel object
20137 * @param hidden If true, the panel will run the animation to contract
20139 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
20141 * @brief Get the state of the panel.
20143 * @param obj The panel object
20144 * @param hidden If true, the panel is in the "hide" state
20146 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20148 * @brief Toggle the hidden state of the panel from code
20150 * @param obj The panel object
20152 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @defgroup Panes Panes
20159 * @ingroup Elementary
20161 * @image html img/widget/panes/preview-00.png
20162 * @image latex img/widget/panes/preview-00.eps width=\textwidth
20164 * @image html img/panes.png
20165 * @image latex img/panes.eps width=\textwidth
20167 * The panes adds a dragable bar between two contents. When dragged
20168 * this bar will resize contents size.
20170 * Panes can be displayed vertically or horizontally, and contents
20171 * size proportion can be customized (homogeneous by default).
20173 * Smart callbacks one can listen to:
20174 * - "press" - The panes has been pressed (button wasn't released yet).
20175 * - "unpressed" - The panes was released after being pressed.
20176 * - "clicked" - The panes has been clicked>
20177 * - "clicked,double" - The panes has been double clicked
20179 * Available styles for it:
20182 * Here is an example on its usage:
20183 * @li @ref panes_example
20187 * @addtogroup Panes
20192 * Add a new panes widget to the given parent Elementary
20193 * (container) object.
20195 * @param parent The parent object.
20196 * @return a new panes widget handle or @c NULL, on errors.
20198 * This function inserts a new panes widget on the canvas.
20202 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20205 * Set the left content of the panes widget.
20207 * @param obj The panes object.
20208 * @param content The new left content object.
20210 * Once the content object is set, a previously set one will be deleted.
20211 * If you want to keep that old content object, use the
20212 * elm_panes_content_left_unset() function.
20214 * If panes is displayed vertically, left content will be displayed at
20217 * @see elm_panes_content_left_get()
20218 * @see elm_panes_content_right_set() to set content on the other side.
20222 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20225 * Set the right content of the panes widget.
20227 * @param obj The panes object.
20228 * @param content The new right content object.
20230 * Once the content object is set, a previously set one will be deleted.
20231 * If you want to keep that old content object, use the
20232 * elm_panes_content_right_unset() function.
20234 * If panes is displayed vertically, left content will be displayed at
20237 * @see elm_panes_content_right_get()
20238 * @see elm_panes_content_left_set() to set content on the other side.
20242 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20245 * Get the left content of the panes.
20247 * @param obj The panes object.
20248 * @return The left content object that is being used.
20250 * Return the left content object which is set for this widget.
20252 * @see elm_panes_content_left_set() for details.
20256 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20259 * Get the right content of the panes.
20261 * @param obj The panes object
20262 * @return The right content object that is being used
20264 * Return the right content object which is set for this widget.
20266 * @see elm_panes_content_right_set() for details.
20270 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20273 * Unset the left content used for the panes.
20275 * @param obj The panes object.
20276 * @return The left content object that was being used.
20278 * Unparent and return the left content object which was set for this widget.
20280 * @see elm_panes_content_left_set() for details.
20281 * @see elm_panes_content_left_get().
20285 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20288 * Unset the right content used for the panes.
20290 * @param obj The panes object.
20291 * @return The right content object that was being used.
20293 * Unparent and return the right content object which was set for this
20296 * @see elm_panes_content_right_set() for details.
20297 * @see elm_panes_content_right_get().
20301 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20304 * Get the size proportion of panes widget's left side.
20306 * @param obj The panes object.
20307 * @return float value between 0.0 and 1.0 representing size proportion
20310 * @see elm_panes_content_left_size_set() for more details.
20314 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20317 * Set the size proportion of panes widget's left side.
20319 * @param obj The panes object.
20320 * @param size Value between 0.0 and 1.0 representing size proportion
20323 * By default it's homogeneous, i.e., both sides have the same size.
20325 * If something different is required, it can be set with this function.
20326 * For example, if the left content should be displayed over
20327 * 75% of the panes size, @p size should be passed as @c 0.75.
20328 * This way, right content will be resized to 25% of panes size.
20330 * If displayed vertically, left content is displayed at top, and
20331 * right content at bottom.
20333 * @note This proportion will change when user drags the panes bar.
20335 * @see elm_panes_content_left_size_get()
20339 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20342 * Set the orientation of a given panes widget.
20344 * @param obj The panes object.
20345 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20346 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20348 * Use this function to change how your panes is to be
20349 * disposed: vertically or horizontally.
20351 * By default it's displayed horizontally.
20353 * @see elm_panes_horizontal_get()
20357 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20360 * Retrieve the orientation of a given panes widget.
20362 * @param obj The panes object.
20363 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20364 * @c EINA_FALSE if it's @b vertical (and on errors).
20366 * @see elm_panes_horizontal_set() for more details.
20370 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20377 * @defgroup Flip Flip
20379 * @image html img/widget/flip/preview-00.png
20380 * @image latex img/widget/flip/preview-00.eps
20382 * This widget holds 2 content objects(Evas_Object): one on the front and one
20383 * on the back. It allows you to flip from front to back and vice-versa using
20384 * various animations.
20386 * If either the front or back contents are not set the flip will treat that
20387 * as transparent. So if you wore to set the front content but not the back,
20388 * and then call elm_flip_go() you would see whatever is below the flip.
20390 * For a list of supported animations see elm_flip_go().
20392 * Signals that you can add callbacks for are:
20393 * "animate,begin" - when a flip animation was started
20394 * "animate,done" - when a flip animation is finished
20396 * @ref tutorial_flip show how to use most of the API.
20400 typedef enum _Elm_Flip_Mode
20402 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20403 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20404 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20405 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20406 ELM_FLIP_CUBE_LEFT,
20407 ELM_FLIP_CUBE_RIGHT,
20409 ELM_FLIP_CUBE_DOWN,
20410 ELM_FLIP_PAGE_LEFT,
20411 ELM_FLIP_PAGE_RIGHT,
20415 typedef enum _Elm_Flip_Interaction
20417 ELM_FLIP_INTERACTION_NONE,
20418 ELM_FLIP_INTERACTION_ROTATE,
20419 ELM_FLIP_INTERACTION_CUBE,
20420 ELM_FLIP_INTERACTION_PAGE
20421 } Elm_Flip_Interaction;
20422 typedef enum _Elm_Flip_Direction
20424 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20425 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20426 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20427 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20428 } Elm_Flip_Direction;
20430 * @brief Add a new flip to the parent
20432 * @param parent The parent object
20433 * @return The new object or NULL if it cannot be created
20435 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20437 * @brief Set the front content of the flip widget.
20439 * @param obj The flip object
20440 * @param content The new front content object
20442 * Once the content object is set, a previously set one will be deleted.
20443 * If you want to keep that old content object, use the
20444 * elm_flip_content_front_unset() function.
20446 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20448 * @brief Set the back content of the flip widget.
20450 * @param obj The flip object
20451 * @param content The new back content object
20453 * Once the content object is set, a previously set one will be deleted.
20454 * If you want to keep that old content object, use the
20455 * elm_flip_content_back_unset() function.
20457 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20459 * @brief Get the front content used for the flip
20461 * @param obj The flip object
20462 * @return The front content object that is being used
20464 * Return the front content object which is set for this widget.
20466 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20468 * @brief Get the back content used for the flip
20470 * @param obj The flip object
20471 * @return The back content object that is being used
20473 * Return the back content object which is set for this widget.
20475 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20477 * @brief Unset the front content used for the flip
20479 * @param obj The flip object
20480 * @return The front content object that was being used
20482 * Unparent and return the front content object which was set for this widget.
20484 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20486 * @brief Unset the back content used for the flip
20488 * @param obj The flip object
20489 * @return The back content object that was being used
20491 * Unparent and return the back content object which was set for this widget.
20493 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20495 * @brief Get flip front visibility state
20497 * @param obj The flip objct
20498 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20501 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20503 * @brief Set flip perspective
20505 * @param obj The flip object
20506 * @param foc The coordinate to set the focus on
20507 * @param x The X coordinate
20508 * @param y The Y coordinate
20510 * @warning This function currently does nothing.
20512 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20514 * @brief Runs the flip animation
20516 * @param obj The flip object
20517 * @param mode The mode type
20519 * Flips the front and back contents using the @p mode animation. This
20520 * efectively hides the currently visible content and shows the hidden one.
20522 * There a number of possible animations to use for the flipping:
20523 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20524 * around a horizontal axis in the middle of its height, the other content
20525 * is shown as the other side of the flip.
20526 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20527 * around a vertical axis in the middle of its width, the other content is
20528 * shown as the other side of the flip.
20529 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20530 * around a diagonal axis in the middle of its width, the other content is
20531 * shown as the other side of the flip.
20532 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20533 * around a diagonal axis in the middle of its height, the other content is
20534 * shown as the other side of the flip.
20535 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20536 * as if the flip was a cube, the other content is show as the right face of
20538 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20539 * right as if the flip was a cube, the other content is show as the left
20540 * face of the cube.
20541 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20542 * flip was a cube, the other content is show as the bottom face of the cube.
20543 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20544 * the flip was a cube, the other content is show as the upper face of the
20546 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20547 * if the flip was a book, the other content is shown as the page below that.
20548 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20549 * as if the flip was a book, the other content is shown as the page below
20551 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20552 * flip was a book, the other content is shown as the page below that.
20553 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20554 * flip was a book, the other content is shown as the page below that.
20556 * @image html elm_flip.png
20557 * @image latex elm_flip.eps width=\textwidth
20559 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20561 * @brief Set the interactive flip mode
20563 * @param obj The flip object
20564 * @param mode The interactive flip mode to use
20566 * This sets if the flip should be interactive (allow user to click and
20567 * drag a side of the flip to reveal the back page and cause it to flip).
20568 * By default a flip is not interactive. You may also need to set which
20569 * sides of the flip are "active" for flipping and how much space they use
20570 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20571 * and elm_flip_interacton_direction_hitsize_set()
20573 * The four avilable mode of interaction are:
20574 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20575 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20576 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20577 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20579 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20580 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20581 * happen, those can only be acheived with elm_flip_go();
20583 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20585 * @brief Get the interactive flip mode
20587 * @param obj The flip object
20588 * @return The interactive flip mode
20590 * Returns the interactive flip mode set by elm_flip_interaction_set()
20592 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20594 * @brief Set which directions of the flip respond to interactive flip
20596 * @param obj The flip object
20597 * @param dir The direction to change
20598 * @param enabled If that direction is enabled or not
20600 * By default all directions are disabled, so you may want to enable the
20601 * desired directions for flipping if you need interactive flipping. You must
20602 * call this function once for each direction that should be enabled.
20604 * @see elm_flip_interaction_set()
20606 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20608 * @brief Get the enabled state of that flip direction
20610 * @param obj The flip object
20611 * @param dir The direction to check
20612 * @return If that direction is enabled or not
20614 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20616 * @see elm_flip_interaction_set()
20618 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20620 * @brief Set the amount of the flip that is sensitive to interactive flip
20622 * @param obj The flip object
20623 * @param dir The direction to modify
20624 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20626 * Set the amount of the flip that is sensitive to interactive flip, with 0
20627 * representing no area in the flip and 1 representing the entire flip. There
20628 * is however a consideration to be made in that the area will never be
20629 * smaller than the finger size set(as set in your Elementary configuration).
20631 * @see elm_flip_interaction_set()
20633 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20635 * @brief Get the amount of the flip that is sensitive to interactive flip
20637 * @param obj The flip object
20638 * @param dir The direction to check
20639 * @return The size set for that direction
20641 * Returns the amount os sensitive area set by
20642 * elm_flip_interacton_direction_hitsize_set().
20644 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20649 /* scrolledentry */
20650 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20651 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20652 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20653 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20654 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20655 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20656 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20658 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20659 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20661 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20662 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20663 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20664 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20665 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20666 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20667 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20668 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20669 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20670 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20671 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20672 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20673 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20674 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20675 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20676 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20677 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20678 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20679 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20680 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20681 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20682 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20683 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20684 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20685 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);
20686 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20687 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20688 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);
20689 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20690 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);
20691 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20692 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20693 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20694 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20695 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20696 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20697 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20698 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20699 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);
20700 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);
20701 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);
20702 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);
20703 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);
20704 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);
20705 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20706 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20707 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20708 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20709 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20710 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20711 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20714 * @defgroup Conformant Conformant
20715 * @ingroup Elementary
20717 * @image html img/widget/conformant/preview-00.png
20718 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20720 * @image html img/conformant.png
20721 * @image latex img/conformant.eps width=\textwidth
20723 * The aim is to provide a widget that can be used in elementary apps to
20724 * account for space taken up by the indicator, virtual keypad & softkey
20725 * windows when running the illume2 module of E17.
20727 * So conformant content will be sized and positioned considering the
20728 * space required for such stuff, and when they popup, as a keyboard
20729 * shows when an entry is selected, conformant content won't change.
20731 * Available styles for it:
20734 * See how to use this widget in this example:
20735 * @ref conformant_example
20739 * @addtogroup Conformant
20744 * Add a new conformant widget to the given parent Elementary
20745 * (container) object.
20747 * @param parent The parent object.
20748 * @return A new conformant widget handle or @c NULL, on errors.
20750 * This function inserts a new conformant widget on the canvas.
20752 * @ingroup Conformant
20754 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20757 * Set the content of the conformant widget.
20759 * @param obj The conformant object.
20760 * @param content The content to be displayed by the conformant.
20762 * Content will be sized and positioned considering the space required
20763 * to display a virtual keyboard. So it won't fill all the conformant
20764 * size. This way is possible to be sure that content won't resize
20765 * or be re-positioned after the keyboard is displayed.
20767 * Once the content object is set, a previously set one will be deleted.
20768 * If you want to keep that old content object, use the
20769 * elm_conformat_content_unset() function.
20771 * @see elm_conformant_content_unset()
20772 * @see elm_conformant_content_get()
20774 * @ingroup Conformant
20776 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20779 * Get the content of the conformant widget.
20781 * @param obj The conformant object.
20782 * @return The content that is being used.
20784 * Return the content object which is set for this widget.
20785 * It won't be unparent from conformant. For that, use
20786 * elm_conformant_content_unset().
20788 * @see elm_conformant_content_set() for more details.
20789 * @see elm_conformant_content_unset()
20791 * @ingroup Conformant
20793 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20796 * Unset the content of the conformant widget.
20798 * @param obj The conformant object.
20799 * @return The content that was being used.
20801 * Unparent and return the content object which was set for this widget.
20803 * @see elm_conformant_content_set() for more details.
20805 * @ingroup Conformant
20807 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20810 * Returns the Evas_Object that represents the content area.
20812 * @param obj The conformant object.
20813 * @return The content area of the widget.
20815 * @ingroup Conformant
20817 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20824 * @defgroup Mapbuf Mapbuf
20825 * @ingroup Elementary
20827 * @image html img/widget/mapbuf/preview-00.png
20828 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20830 * This holds one content object and uses an Evas Map of transformation
20831 * points to be later used with this content. So the content will be
20832 * moved, resized, etc as a single image. So it will improve performance
20833 * when you have a complex interafce, with a lot of elements, and will
20834 * need to resize or move it frequently (the content object and its
20837 * See how to use this widget in this example:
20838 * @ref mapbuf_example
20842 * @addtogroup Mapbuf
20847 * Add a new mapbuf widget to the given parent Elementary
20848 * (container) object.
20850 * @param parent The parent object.
20851 * @return A new mapbuf widget handle or @c NULL, on errors.
20853 * This function inserts a new mapbuf widget on the canvas.
20857 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20860 * Set the content of the mapbuf.
20862 * @param obj The mapbuf object.
20863 * @param content The content that will be filled in this mapbuf object.
20865 * Once the content object is set, a previously set one will be deleted.
20866 * If you want to keep that old content object, use the
20867 * elm_mapbuf_content_unset() function.
20869 * To enable map, elm_mapbuf_enabled_set() should be used.
20873 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20876 * Get the content of the mapbuf.
20878 * @param obj The mapbuf object.
20879 * @return The content that is being used.
20881 * Return the content object which is set for this widget.
20883 * @see elm_mapbuf_content_set() for details.
20887 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20890 * Unset the content of the mapbuf.
20892 * @param obj The mapbuf object.
20893 * @return The content that was being used.
20895 * Unparent and return the content object which was set for this widget.
20897 * @see elm_mapbuf_content_set() for details.
20901 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20904 * Enable or disable the map.
20906 * @param obj The mapbuf object.
20907 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20909 * This enables the map that is set or disables it. On enable, the object
20910 * geometry will be saved, and the new geometry will change (position and
20911 * size) to reflect the map geometry set.
20913 * Also, when enabled, alpha and smooth states will be used, so if the
20914 * content isn't solid, alpha should be enabled, for example, otherwise
20915 * a black retangle will fill the content.
20917 * When disabled, the stored map will be freed and geometry prior to
20918 * enabling the map will be restored.
20920 * It's disabled by default.
20922 * @see elm_mapbuf_alpha_set()
20923 * @see elm_mapbuf_smooth_set()
20927 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20930 * Get a value whether map is enabled or not.
20932 * @param obj The mapbuf object.
20933 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20934 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20936 * @see elm_mapbuf_enabled_set() for details.
20940 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20943 * Enable or disable smooth map rendering.
20945 * @param obj The mapbuf object.
20946 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20949 * This sets smoothing for map rendering. If the object is a type that has
20950 * its own smoothing settings, then both the smooth settings for this object
20951 * and the map must be turned off.
20953 * By default smooth maps are enabled.
20957 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20960 * Get a value whether smooth map rendering is enabled or not.
20962 * @param obj The mapbuf object.
20963 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20964 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20966 * @see elm_mapbuf_smooth_set() for details.
20970 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20973 * Set or unset alpha flag for map rendering.
20975 * @param obj The mapbuf object.
20976 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20979 * This sets alpha flag for map rendering. If the object is a type that has
20980 * its own alpha settings, then this will take precedence. Only image objects
20981 * have this currently. It stops alpha blending of the map area, and is
20982 * useful if you know the object and/or all sub-objects is 100% solid.
20984 * Alpha is enabled by default.
20988 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20991 * Get a value whether alpha blending is enabled or not.
20993 * @param obj The mapbuf object.
20994 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20995 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20997 * @see elm_mapbuf_alpha_set() for details.
21001 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21008 * @defgroup Flipselector Flip Selector
21010 * @image html img/widget/flipselector/preview-00.png
21011 * @image latex img/widget/flipselector/preview-00.eps
21013 * A flip selector is a widget to show a set of @b text items, one
21014 * at a time, with the same sheet switching style as the @ref Clock
21015 * "clock" widget, when one changes the current displaying sheet
21016 * (thus, the "flip" in the name).
21018 * User clicks to flip sheets which are @b held for some time will
21019 * make the flip selector to flip continuosly and automatically for
21020 * the user. The interval between flips will keep growing in time,
21021 * so that it helps the user to reach an item which is distant from
21022 * the current selection.
21024 * Smart callbacks one can register to:
21025 * - @c "selected" - when the widget's selected text item is changed
21026 * - @c "overflowed" - when the widget's current selection is changed
21027 * from the first item in its list to the last
21028 * - @c "underflowed" - when the widget's current selection is changed
21029 * from the last item in its list to the first
21031 * Available styles for it:
21034 * Here is an example on its usage:
21035 * @li @ref flipselector_example
21039 * @addtogroup Flipselector
21043 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
21046 * Add a new flip selector widget to the given parent Elementary
21047 * (container) widget
21049 * @param parent The parent object
21050 * @return a new flip selector widget handle or @c NULL, on errors
21052 * This function inserts a new flip selector widget on the canvas.
21054 * @ingroup Flipselector
21056 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21059 * Programmatically select the next item of a flip selector widget
21061 * @param obj The flipselector object
21063 * @note The selection will be animated. Also, if it reaches the
21064 * end of its list of member items, it will continue with the first
21067 * @ingroup Flipselector
21069 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21072 * Programmatically select the previous item of a flip selector
21075 * @param obj The flipselector object
21077 * @note The selection will be animated. Also, if it reaches the
21078 * beginning of its list of member items, it will continue with the
21079 * last one backwards.
21081 * @ingroup Flipselector
21083 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
21086 * Append a (text) item to a flip selector widget
21088 * @param obj The flipselector object
21089 * @param label The (text) label of the new item
21090 * @param func Convenience callback function to take place when
21092 * @param data Data passed to @p func, above
21093 * @return A handle to the item added or @c NULL, on errors
21095 * The widget's list of labels to show will be appended with the
21096 * given value. If the user wishes so, a callback function pointer
21097 * can be passed, which will get called when this same item is
21100 * @note The current selection @b won't be modified by appending an
21101 * element to the list.
21103 * @note The maximum length of the text label is going to be
21104 * determined <b>by the widget's theme</b>. Strings larger than
21105 * that value are going to be @b truncated.
21107 * @ingroup Flipselector
21109 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21112 * Prepend a (text) item to a flip selector widget
21114 * @param obj The flipselector object
21115 * @param label The (text) label of the new item
21116 * @param func Convenience callback function to take place when
21118 * @param data Data passed to @p func, above
21119 * @return A handle to the item added or @c NULL, on errors
21121 * The widget's list of labels to show will be prepended with the
21122 * given value. If the user wishes so, a callback function pointer
21123 * can be passed, which will get called when this same item is
21126 * @note The current selection @b won't be modified by prepending
21127 * an element to the list.
21129 * @note The maximum length of the text label is going to be
21130 * determined <b>by the widget's theme</b>. Strings larger than
21131 * that value are going to be @b truncated.
21133 * @ingroup Flipselector
21135 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21138 * Get the internal list of items in a given flip selector widget.
21140 * @param obj The flipselector object
21141 * @return The list of items (#Elm_Flipselector_Item as data) or
21142 * @c NULL on errors.
21144 * This list is @b not to be modified in any way and must not be
21145 * freed. Use the list members with functions like
21146 * elm_flipselector_item_label_set(),
21147 * elm_flipselector_item_label_get(),
21148 * elm_flipselector_item_del(),
21149 * elm_flipselector_item_selected_get(),
21150 * elm_flipselector_item_selected_set().
21152 * @warning This list is only valid until @p obj object's internal
21153 * items list is changed. It should be fetched again with another
21154 * call to this function when changes happen.
21156 * @ingroup Flipselector
21158 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21161 * Get the first item in the given flip selector widget's list of
21164 * @param obj The flipselector object
21165 * @return The first item or @c NULL, if it has no items (and on
21168 * @see elm_flipselector_item_append()
21169 * @see elm_flipselector_last_item_get()
21171 * @ingroup Flipselector
21173 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21176 * Get the last item in the given flip selector widget's list of
21179 * @param obj The flipselector object
21180 * @return The last item or @c NULL, if it has no items (and on
21183 * @see elm_flipselector_item_prepend()
21184 * @see elm_flipselector_first_item_get()
21186 * @ingroup Flipselector
21188 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21191 * Get the currently selected item in a flip selector widget.
21193 * @param obj The flipselector object
21194 * @return The selected item or @c NULL, if the widget has no items
21197 * @ingroup Flipselector
21199 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21202 * Set whether a given flip selector widget's item should be the
21203 * currently selected one.
21205 * @param item The flip selector item
21206 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
21208 * This sets whether @p item is or not the selected (thus, under
21209 * display) one. If @p item is different than one under display,
21210 * the latter will be unselected. If the @p item is set to be
21211 * unselected, on the other hand, the @b first item in the widget's
21212 * internal members list will be the new selected one.
21214 * @see elm_flipselector_item_selected_get()
21216 * @ingroup Flipselector
21218 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21221 * Get whether a given flip selector widget's item is the currently
21224 * @param item The flip selector item
21225 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21228 * @see elm_flipselector_item_selected_set()
21230 * @ingroup Flipselector
21232 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21235 * Delete a given item from a flip selector widget.
21237 * @param item The item to delete
21239 * @ingroup Flipselector
21241 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21244 * Get the label of a given flip selector widget's item.
21246 * @param item The item to get label from
21247 * @return The text label of @p item or @c NULL, on errors
21249 * @see elm_flipselector_item_label_set()
21251 * @ingroup Flipselector
21253 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21256 * Set the label of a given flip selector widget's item.
21258 * @param item The item to set label on
21259 * @param label The text label string, in UTF-8 encoding
21261 * @see elm_flipselector_item_label_get()
21263 * @ingroup Flipselector
21265 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21268 * Gets the item before @p item in a flip selector widget's
21269 * internal list of items.
21271 * @param item The item to fetch previous from
21272 * @return The item before the @p item, in its parent's list. If
21273 * there is no previous item for @p item or there's an
21274 * error, @c NULL is returned.
21276 * @see elm_flipselector_item_next_get()
21278 * @ingroup Flipselector
21280 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21283 * Gets the item after @p item in a flip selector widget's
21284 * internal list of items.
21286 * @param item The item to fetch next from
21287 * @return The item after the @p item, in its parent's list. If
21288 * there is no next item for @p item or there's an
21289 * error, @c NULL is returned.
21291 * @see elm_flipselector_item_next_get()
21293 * @ingroup Flipselector
21295 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21298 * Set the interval on time updates for an user mouse button hold
21299 * on a flip selector widget.
21301 * @param obj The flip selector object
21302 * @param interval The (first) interval value in seconds
21304 * This interval value is @b decreased while the user holds the
21305 * mouse pointer either flipping up or flipping doww a given flip
21308 * This helps the user to get to a given item distant from the
21309 * current one easier/faster, as it will start to flip quicker and
21310 * quicker on mouse button holds.
21312 * The calculation for the next flip interval value, starting from
21313 * the one set with this call, is the previous interval divided by
21314 * 1.05, so it decreases a little bit.
21316 * The default starting interval value for automatic flips is
21319 * @see elm_flipselector_interval_get()
21321 * @ingroup Flipselector
21323 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21326 * Get the interval on time updates for an user mouse button hold
21327 * on a flip selector widget.
21329 * @param obj The flip selector object
21330 * @return The (first) interval value, in seconds, set on it
21332 * @see elm_flipselector_interval_set() for more details
21334 * @ingroup Flipselector
21336 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21342 * @addtogroup Calendar
21347 * @enum _Elm_Calendar_Mark_Repeat
21348 * @typedef Elm_Calendar_Mark_Repeat
21350 * Event periodicity, used to define if a mark should be repeated
21351 * @b beyond event's day. It's set when a mark is added.
21353 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21354 * there will be marks every week after this date. Marks will be displayed
21355 * at 13th, 20th, 27th, 3rd June ...
21357 * Values don't work as bitmask, only one can be choosen.
21359 * @see elm_calendar_mark_add()
21361 * @ingroup Calendar
21363 typedef enum _Elm_Calendar_Mark_Repeat
21365 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21366 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21367 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21368 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*/
21369 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. */
21370 } Elm_Calendar_Mark_Repeat;
21372 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(). */
21375 * Add a new calendar widget to the given parent Elementary
21376 * (container) object.
21378 * @param parent The parent object.
21379 * @return a new calendar widget handle or @c NULL, on errors.
21381 * This function inserts a new calendar widget on the canvas.
21383 * @ref calendar_example_01
21385 * @ingroup Calendar
21387 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21390 * Get weekdays names displayed by the calendar.
21392 * @param obj The calendar object.
21393 * @return Array of seven strings to be used as weekday names.
21395 * By default, weekdays abbreviations get from system are displayed:
21396 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21397 * The first string is related to Sunday, the second to Monday...
21399 * @see elm_calendar_weekdays_name_set()
21401 * @ref calendar_example_05
21403 * @ingroup Calendar
21405 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21408 * Set weekdays names to be displayed by the calendar.
21410 * @param obj The calendar object.
21411 * @param weekdays Array of seven strings to be used as weekday names.
21412 * @warning It must have 7 elements, or it will access invalid memory.
21413 * @warning The strings must be NULL terminated ('@\0').
21415 * By default, weekdays abbreviations get from system are displayed:
21416 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21418 * The first string should be related to Sunday, the second to Monday...
21420 * The usage should be like this:
21422 * const char *weekdays[] =
21424 * "Sunday", "Monday", "Tuesday", "Wednesday",
21425 * "Thursday", "Friday", "Saturday"
21427 * elm_calendar_weekdays_names_set(calendar, weekdays);
21430 * @see elm_calendar_weekdays_name_get()
21432 * @ref calendar_example_02
21434 * @ingroup Calendar
21436 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21439 * Set the minimum and maximum values for the year
21441 * @param obj The calendar object
21442 * @param min The minimum year, greater than 1901;
21443 * @param max The maximum year;
21445 * Maximum must be greater than minimum, except if you don't wan't to set
21447 * Default values are 1902 and -1.
21449 * If the maximum year is a negative value, it will be limited depending
21450 * on the platform architecture (year 2037 for 32 bits);
21452 * @see elm_calendar_min_max_year_get()
21454 * @ref calendar_example_03
21456 * @ingroup Calendar
21458 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21461 * Get the minimum and maximum values for the year
21463 * @param obj The calendar object.
21464 * @param min The minimum year.
21465 * @param max The maximum year.
21467 * Default values are 1902 and -1.
21469 * @see elm_calendar_min_max_year_get() for more details.
21471 * @ref calendar_example_05
21473 * @ingroup Calendar
21475 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21478 * Enable or disable day selection
21480 * @param obj The calendar object.
21481 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21484 * Enabled by default. If disabled, the user still can select months,
21485 * but not days. Selected days are highlighted on calendar.
21486 * It should be used if you won't need such selection for the widget usage.
21488 * When a day is selected, or month is changed, smart callbacks for
21489 * signal "changed" will be called.
21491 * @see elm_calendar_day_selection_enable_get()
21493 * @ref calendar_example_04
21495 * @ingroup Calendar
21497 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21500 * Get a value whether day selection is enabled or not.
21502 * @see elm_calendar_day_selection_enable_set() for details.
21504 * @param obj The calendar object.
21505 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21506 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21508 * @ref calendar_example_05
21510 * @ingroup Calendar
21512 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21516 * Set selected date to be highlighted on calendar.
21518 * @param obj The calendar object.
21519 * @param selected_time A @b tm struct to represent the selected date.
21521 * Set the selected date, changing the displayed month if needed.
21522 * Selected date changes when the user goes to next/previous month or
21523 * select a day pressing over it on calendar.
21525 * @see elm_calendar_selected_time_get()
21527 * @ref calendar_example_04
21529 * @ingroup Calendar
21531 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21534 * Get selected date.
21536 * @param obj The calendar object
21537 * @param selected_time A @b tm struct to point to selected date
21538 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21541 * Get date selected by the user or set by function
21542 * elm_calendar_selected_time_set().
21543 * Selected date changes when the user goes to next/previous month or
21544 * select a day pressing over it on calendar.
21546 * @see elm_calendar_selected_time_get()
21548 * @ref calendar_example_05
21550 * @ingroup Calendar
21552 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21555 * Set a function to format the string that will be used to display
21558 * @param obj The calendar object
21559 * @param format_function Function to set the month-year string given
21560 * the selected date
21562 * By default it uses strftime with "%B %Y" format string.
21563 * It should allocate the memory that will be used by the string,
21564 * that will be freed by the widget after usage.
21565 * A pointer to the string and a pointer to the time struct will be provided.
21570 * _format_month_year(struct tm *selected_time)
21573 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21574 * return strdup(buf);
21577 * elm_calendar_format_function_set(calendar, _format_month_year);
21580 * @ref calendar_example_02
21582 * @ingroup Calendar
21584 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21587 * Add a new mark to the calendar
21589 * @param obj The calendar object
21590 * @param mark_type A string used to define the type of mark. It will be
21591 * emitted to the theme, that should display a related modification on these
21592 * days representation.
21593 * @param mark_time A time struct to represent the date of inclusion of the
21594 * mark. For marks that repeats it will just be displayed after the inclusion
21595 * date in the calendar.
21596 * @param repeat Repeat the event following this periodicity. Can be a unique
21597 * mark (that don't repeat), daily, weekly, monthly or annually.
21598 * @return The created mark or @p NULL upon failure.
21600 * Add a mark that will be drawn in the calendar respecting the insertion
21601 * time and periodicity. It will emit the type as signal to the widget theme.
21602 * Default theme supports "holiday" and "checked", but it can be extended.
21604 * It won't immediately update the calendar, drawing the marks.
21605 * For this, call elm_calendar_marks_draw(). However, when user selects
21606 * next or previous month calendar forces marks drawn.
21608 * Marks created with this method can be deleted with
21609 * elm_calendar_mark_del().
21613 * struct tm selected_time;
21614 * time_t current_time;
21616 * current_time = time(NULL) + 5 * 84600;
21617 * localtime_r(¤t_time, &selected_time);
21618 * elm_calendar_mark_add(cal, "holiday", selected_time,
21619 * ELM_CALENDAR_ANNUALLY);
21621 * current_time = time(NULL) + 1 * 84600;
21622 * localtime_r(¤t_time, &selected_time);
21623 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21625 * elm_calendar_marks_draw(cal);
21628 * @see elm_calendar_marks_draw()
21629 * @see elm_calendar_mark_del()
21631 * @ref calendar_example_06
21633 * @ingroup Calendar
21635 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);
21638 * Delete mark from the calendar.
21640 * @param mark The mark to be deleted.
21642 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21643 * should be used instead of getting marks list and deleting each one.
21645 * @see elm_calendar_mark_add()
21647 * @ref calendar_example_06
21649 * @ingroup Calendar
21651 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21654 * Remove all calendar's marks
21656 * @param obj The calendar object.
21658 * @see elm_calendar_mark_add()
21659 * @see elm_calendar_mark_del()
21661 * @ingroup Calendar
21663 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21667 * Get a list of all the calendar marks.
21669 * @param obj The calendar object.
21670 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21672 * @see elm_calendar_mark_add()
21673 * @see elm_calendar_mark_del()
21674 * @see elm_calendar_marks_clear()
21676 * @ingroup Calendar
21678 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21681 * Draw calendar marks.
21683 * @param obj The calendar object.
21685 * Should be used after adding, removing or clearing marks.
21686 * It will go through the entire marks list updating the calendar.
21687 * If lots of marks will be added, add all the marks and then call
21690 * When the month is changed, i.e. user selects next or previous month,
21691 * marks will be drawed.
21693 * @see elm_calendar_mark_add()
21694 * @see elm_calendar_mark_del()
21695 * @see elm_calendar_marks_clear()
21697 * @ref calendar_example_06
21699 * @ingroup Calendar
21701 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21704 * Set a day text color to the same that represents Saturdays.
21706 * @param obj The calendar object.
21707 * @param pos The text position. Position is the cell counter, from left
21708 * to right, up to down. It starts on 0 and ends on 41.
21710 * @deprecated use elm_calendar_mark_add() instead like:
21713 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21714 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21717 * @see elm_calendar_mark_add()
21719 * @ingroup Calendar
21721 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21724 * Set a day text color to the same that represents Sundays.
21726 * @param obj The calendar object.
21727 * @param pos The text position. Position is the cell counter, from left
21728 * to right, up to down. It starts on 0 and ends on 41.
21730 * @deprecated use elm_calendar_mark_add() instead like:
21733 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21734 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21737 * @see elm_calendar_mark_add()
21739 * @ingroup Calendar
21741 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21744 * Set a day text color to the same that represents Weekdays.
21746 * @param obj The calendar object
21747 * @param pos The text position. Position is the cell counter, from left
21748 * to right, up to down. It starts on 0 and ends on 41.
21750 * @deprecated use elm_calendar_mark_add() instead like:
21753 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21755 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21756 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21757 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21758 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21759 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21760 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21761 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21762 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21763 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21766 * @see elm_calendar_mark_add()
21768 * @ingroup Calendar
21770 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21773 * Set the interval on time updates for an user mouse button hold
21774 * on calendar widgets' month selection.
21776 * @param obj The calendar object
21777 * @param interval The (first) interval value in seconds
21779 * This interval value is @b decreased while the user holds the
21780 * mouse pointer either selecting next or previous month.
21782 * This helps the user to get to a given month distant from the
21783 * current one easier/faster, as it will start to change quicker and
21784 * quicker on mouse button holds.
21786 * The calculation for the next change interval value, starting from
21787 * the one set with this call, is the previous interval divided by
21788 * 1.05, so it decreases a little bit.
21790 * The default starting interval value for automatic changes is
21793 * @see elm_calendar_interval_get()
21795 * @ingroup Calendar
21797 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21800 * Get the interval on time updates for an user mouse button hold
21801 * on calendar widgets' month selection.
21803 * @param obj The calendar object
21804 * @return The (first) interval value, in seconds, set on it
21806 * @see elm_calendar_interval_set() for more details
21808 * @ingroup Calendar
21810 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21817 * @defgroup Diskselector Diskselector
21818 * @ingroup Elementary
21820 * @image html img/widget/diskselector/preview-00.png
21821 * @image latex img/widget/diskselector/preview-00.eps
21823 * A diskselector is a kind of list widget. It scrolls horizontally,
21824 * and can contain label and icon objects. Three items are displayed
21825 * with the selected one in the middle.
21827 * It can act like a circular list with round mode and labels can be
21828 * reduced for a defined length for side items.
21830 * Smart callbacks one can listen to:
21831 * - "selected" - when item is selected, i.e. scroller stops.
21833 * Available styles for it:
21836 * List of examples:
21837 * @li @ref diskselector_example_01
21838 * @li @ref diskselector_example_02
21842 * @addtogroup Diskselector
21846 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(). */
21849 * Add a new diskselector widget to the given parent Elementary
21850 * (container) object.
21852 * @param parent The parent object.
21853 * @return a new diskselector widget handle or @c NULL, on errors.
21855 * This function inserts a new diskselector widget on the canvas.
21857 * @ingroup Diskselector
21859 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21862 * Enable or disable round mode.
21864 * @param obj The diskselector object.
21865 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21868 * Disabled by default. If round mode is enabled the items list will
21869 * work like a circle list, so when the user reaches the last item,
21870 * the first one will popup.
21872 * @see elm_diskselector_round_get()
21874 * @ingroup Diskselector
21876 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21879 * Get a value whether round mode is enabled or not.
21881 * @see elm_diskselector_round_set() for details.
21883 * @param obj The diskselector object.
21884 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21885 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21887 * @ingroup Diskselector
21889 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21892 * Get the side labels max length.
21894 * @deprecated use elm_diskselector_side_label_length_get() instead:
21896 * @param obj The diskselector object.
21897 * @return The max length defined for side labels, or 0 if not a valid
21900 * @ingroup Diskselector
21902 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21905 * Set the side labels max length.
21907 * @deprecated use elm_diskselector_side_label_length_set() instead:
21909 * @param obj The diskselector object.
21910 * @param len The max length defined for side labels.
21912 * @ingroup Diskselector
21914 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21917 * Get the side labels max length.
21919 * @see elm_diskselector_side_label_length_set() for details.
21921 * @param obj The diskselector object.
21922 * @return The max length defined for side labels, or 0 if not a valid
21925 * @ingroup Diskselector
21927 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21930 * Set the side labels max length.
21932 * @param obj The diskselector object.
21933 * @param len The max length defined for side labels.
21935 * Length is the number of characters of items' label that will be
21936 * visible when it's set on side positions. It will just crop
21937 * the string after defined size. E.g.:
21939 * An item with label "January" would be displayed on side position as
21940 * "Jan" if max length is set to 3, or "Janu", if this property
21943 * When it's selected, the entire label will be displayed, except for
21944 * width restrictions. In this case label will be cropped and "..."
21945 * will be concatenated.
21947 * Default side label max length is 3.
21949 * This property will be applyed over all items, included before or
21950 * later this function call.
21952 * @ingroup Diskselector
21954 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21957 * Set the number of items to be displayed.
21959 * @param obj The diskselector object.
21960 * @param num The number of items the diskselector will display.
21962 * Default value is 3, and also it's the minimun. If @p num is less
21963 * than 3, it will be set to 3.
21965 * Also, it can be set on theme, using data item @c display_item_num
21966 * on group "elm/diskselector/item/X", where X is style set.
21969 * group { name: "elm/diskselector/item/X";
21971 * item: "display_item_num" "5";
21974 * @ingroup Diskselector
21976 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21979 * Set bouncing behaviour when the scrolled content reaches an edge.
21981 * Tell the internal scroller object whether it should bounce or not
21982 * when it reaches the respective edges for each axis.
21984 * @param obj The diskselector object.
21985 * @param h_bounce Whether to bounce or not in the horizontal axis.
21986 * @param v_bounce Whether to bounce or not in the vertical axis.
21988 * @see elm_scroller_bounce_set()
21990 * @ingroup Diskselector
21992 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21995 * Get the bouncing behaviour of the internal scroller.
21997 * Get whether the internal scroller should bounce when the edge of each
21998 * axis is reached scrolling.
22000 * @param obj The diskselector object.
22001 * @param h_bounce Pointer where to store the bounce state of the horizontal
22003 * @param v_bounce Pointer where to store the bounce state of the vertical
22006 * @see elm_scroller_bounce_get()
22007 * @see elm_diskselector_bounce_set()
22009 * @ingroup Diskselector
22011 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22014 * Get the scrollbar policy.
22016 * @see elm_diskselector_scroller_policy_get() for details.
22018 * @param obj The diskselector object.
22019 * @param policy_h Pointer where to store horizontal scrollbar policy.
22020 * @param policy_v Pointer where to store vertical scrollbar policy.
22022 * @ingroup Diskselector
22024 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);
22027 * Set the scrollbar policy.
22029 * @param obj The diskselector object.
22030 * @param policy_h Horizontal scrollbar policy.
22031 * @param policy_v Vertical scrollbar policy.
22033 * This sets the scrollbar visibility policy for the given scroller.
22034 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22035 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22036 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22037 * This applies respectively for the horizontal and vertical scrollbars.
22039 * The both are disabled by default, i.e., are set to
22040 * #ELM_SCROLLER_POLICY_OFF.
22042 * @ingroup Diskselector
22044 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22047 * Remove all diskselector's items.
22049 * @param obj The diskselector object.
22051 * @see elm_diskselector_item_del()
22052 * @see elm_diskselector_item_append()
22054 * @ingroup Diskselector
22056 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22059 * Get a list of all the diskselector items.
22061 * @param obj The diskselector object.
22062 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22063 * or @c NULL on failure.
22065 * @see elm_diskselector_item_append()
22066 * @see elm_diskselector_item_del()
22067 * @see elm_diskselector_clear()
22069 * @ingroup Diskselector
22071 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22074 * Appends a new item to the diskselector object.
22076 * @param obj The diskselector object.
22077 * @param label The label of the diskselector item.
22078 * @param icon The icon object to use at left side of the item. An
22079 * icon can be any Evas object, but usually it is an icon created
22080 * with elm_icon_add().
22081 * @param func The function to call when the item is selected.
22082 * @param data The data to associate with the item for related callbacks.
22084 * @return The created item or @c NULL upon failure.
22086 * A new item will be created and appended to the diskselector, i.e., will
22087 * be set as last item. Also, if there is no selected item, it will
22088 * be selected. This will always happens for the first appended item.
22090 * If no icon is set, label will be centered on item position, otherwise
22091 * the icon will be placed at left of the label, that will be shifted
22094 * Items created with this method can be deleted with
22095 * elm_diskselector_item_del().
22097 * Associated @p data can be properly freed when item is deleted if a
22098 * callback function is set with elm_diskselector_item_del_cb_set().
22100 * If a function is passed as argument, it will be called everytime this item
22101 * is selected, i.e., the user stops the diskselector with this
22102 * item on center position. If such function isn't needed, just passing
22103 * @c NULL as @p func is enough. The same should be done for @p data.
22105 * Simple example (with no function callback or data associated):
22107 * disk = elm_diskselector_add(win);
22108 * ic = elm_icon_add(win);
22109 * elm_icon_file_set(ic, "path/to/image", NULL);
22110 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22111 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22114 * @see elm_diskselector_item_del()
22115 * @see elm_diskselector_item_del_cb_set()
22116 * @see elm_diskselector_clear()
22117 * @see elm_icon_add()
22119 * @ingroup Diskselector
22121 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);
22125 * Delete them item from the diskselector.
22127 * @param it The item of diskselector to be deleted.
22129 * If deleting all diskselector items is required, elm_diskselector_clear()
22130 * should be used instead of getting items list and deleting each one.
22132 * @see elm_diskselector_clear()
22133 * @see elm_diskselector_item_append()
22134 * @see elm_diskselector_item_del_cb_set()
22136 * @ingroup Diskselector
22138 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22141 * Set the function called when a diskselector item is freed.
22143 * @param it The item to set the callback on
22144 * @param func The function called
22146 * If there is a @p func, then it will be called prior item's memory release.
22147 * That will be called with the following arguments:
22149 * @li item's Evas object;
22152 * This way, a data associated to a diskselector item could be properly
22155 * @ingroup Diskselector
22157 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22160 * Get the data associated to the item.
22162 * @param it The diskselector item
22163 * @return The data associated to @p it
22165 * The return value is a pointer to data associated to @p item when it was
22166 * created, with function elm_diskselector_item_append(). If no data
22167 * was passed as argument, it will return @c NULL.
22169 * @see elm_diskselector_item_append()
22171 * @ingroup Diskselector
22173 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22176 * Set the icon associated to the item.
22178 * @param it The diskselector item
22179 * @param icon The icon object to associate with @p it
22181 * The icon object to use at left side of the item. An
22182 * icon can be any Evas object, but usually it is an icon created
22183 * with elm_icon_add().
22185 * Once the icon object is set, a previously set one will be deleted.
22186 * @warning Setting the same icon for two items will cause the icon to
22187 * dissapear from the first item.
22189 * If an icon was passed as argument on item creation, with function
22190 * elm_diskselector_item_append(), it will be already
22191 * associated to the item.
22193 * @see elm_diskselector_item_append()
22194 * @see elm_diskselector_item_icon_get()
22196 * @ingroup Diskselector
22198 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22201 * Get the icon associated to the item.
22203 * @param it The diskselector item
22204 * @return The icon associated to @p it
22206 * The return value is a pointer to the icon associated to @p item when it was
22207 * created, with function elm_diskselector_item_append(), or later
22208 * with function elm_diskselector_item_icon_set. If no icon
22209 * was passed as argument, it will return @c NULL.
22211 * @see elm_diskselector_item_append()
22212 * @see elm_diskselector_item_icon_set()
22214 * @ingroup Diskselector
22216 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22219 * Set the label of item.
22221 * @param it The item of diskselector.
22222 * @param label The label of item.
22224 * The label to be displayed by the item.
22226 * If no icon is set, label will be centered on item position, otherwise
22227 * the icon will be placed at left of the label, that will be shifted
22230 * An item with label "January" would be displayed on side position as
22231 * "Jan" if max length is set to 3 with function
22232 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22235 * When this @p item is selected, the entire label will be displayed,
22236 * except for width restrictions.
22237 * In this case label will be cropped and "..." will be concatenated,
22238 * but only for display purposes. It will keep the entire string, so
22239 * if diskselector is resized the remaining characters will be displayed.
22241 * If a label was passed as argument on item creation, with function
22242 * elm_diskselector_item_append(), it will be already
22243 * displayed by the item.
22245 * @see elm_diskselector_side_label_lenght_set()
22246 * @see elm_diskselector_item_label_get()
22247 * @see elm_diskselector_item_append()
22249 * @ingroup Diskselector
22251 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22254 * Get the label of item.
22256 * @param it The item of diskselector.
22257 * @return The label of item.
22259 * The return value is a pointer to the label associated to @p item when it was
22260 * created, with function elm_diskselector_item_append(), or later
22261 * with function elm_diskselector_item_label_set. If no label
22262 * was passed as argument, it will return @c NULL.
22264 * @see elm_diskselector_item_label_set() for more details.
22265 * @see elm_diskselector_item_append()
22267 * @ingroup Diskselector
22269 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22272 * Get the selected item.
22274 * @param obj The diskselector object.
22275 * @return The selected diskselector item.
22277 * The selected item can be unselected with function
22278 * elm_diskselector_item_selected_set(), and the first item of
22279 * diskselector will be selected.
22281 * The selected item always will be centered on diskselector, with
22282 * full label displayed, i.e., max lenght set to side labels won't
22283 * apply on the selected item. More details on
22284 * elm_diskselector_side_label_length_set().
22286 * @ingroup Diskselector
22288 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22291 * Set the selected state of an item.
22293 * @param it The diskselector item
22294 * @param selected The selected state
22296 * This sets the selected state of the given item @p it.
22297 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22299 * If a new item is selected the previosly selected will be unselected.
22300 * Previoulsy selected item can be get with function
22301 * elm_diskselector_selected_item_get().
22303 * If the item @p it is unselected, the first item of diskselector will
22306 * Selected items will be visible on center position of diskselector.
22307 * So if it was on another position before selected, or was invisible,
22308 * diskselector will animate items until the selected item reaches center
22311 * @see elm_diskselector_item_selected_get()
22312 * @see elm_diskselector_selected_item_get()
22314 * @ingroup Diskselector
22316 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22319 * Get whether the @p item is selected or not.
22321 * @param it The diskselector item.
22322 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22323 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22325 * @see elm_diskselector_selected_item_set() for details.
22326 * @see elm_diskselector_item_selected_get()
22328 * @ingroup Diskselector
22330 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22333 * Get the first item of the diskselector.
22335 * @param obj The diskselector object.
22336 * @return The first item, or @c NULL if none.
22338 * The list of items follows append order. So it will return the first
22339 * item appended to the widget that wasn't deleted.
22341 * @see elm_diskselector_item_append()
22342 * @see elm_diskselector_items_get()
22344 * @ingroup Diskselector
22346 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22349 * Get the last item of the diskselector.
22351 * @param obj The diskselector object.
22352 * @return The last item, or @c NULL if none.
22354 * The list of items follows append order. So it will return last first
22355 * item appended to the widget that wasn't deleted.
22357 * @see elm_diskselector_item_append()
22358 * @see elm_diskselector_items_get()
22360 * @ingroup Diskselector
22362 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22365 * Get the item before @p item in diskselector.
22367 * @param it The diskselector item.
22368 * @return The item before @p item, or @c NULL if none or on failure.
22370 * The list of items follows append order. So it will return item appended
22371 * just before @p item and that wasn't deleted.
22373 * If it is the first item, @c NULL will be returned.
22374 * First item can be get by elm_diskselector_first_item_get().
22376 * @see elm_diskselector_item_append()
22377 * @see elm_diskselector_items_get()
22379 * @ingroup Diskselector
22381 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22384 * Get the item after @p item in diskselector.
22386 * @param it The diskselector item.
22387 * @return The item after @p item, or @c NULL if none or on failure.
22389 * The list of items follows append order. So it will return item appended
22390 * just after @p item and that wasn't deleted.
22392 * If it is the last item, @c NULL will be returned.
22393 * Last item can be get by elm_diskselector_last_item_get().
22395 * @see elm_diskselector_item_append()
22396 * @see elm_diskselector_items_get()
22398 * @ingroup Diskselector
22400 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22403 * Set the text to be shown in the diskselector item.
22405 * @param item Target item
22406 * @param text The text to set in the content
22408 * Setup the text as tooltip to object. The item can have only one tooltip,
22409 * so any previous tooltip data is removed.
22411 * @see elm_object_tooltip_text_set() for more details.
22413 * @ingroup Diskselector
22415 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22418 * Set the content to be shown in the tooltip item.
22420 * Setup the tooltip to item. The item can have only one tooltip,
22421 * so any previous tooltip data is removed. @p func(with @p data) will
22422 * be called every time that need show the tooltip and it should
22423 * return a valid Evas_Object. This object is then managed fully by
22424 * tooltip system and is deleted when the tooltip is gone.
22426 * @param item the diskselector item being attached a tooltip.
22427 * @param func the function used to create the tooltip contents.
22428 * @param data what to provide to @a func as callback data/context.
22429 * @param del_cb called when data is not needed anymore, either when
22430 * another callback replaces @p func, the tooltip is unset with
22431 * elm_diskselector_item_tooltip_unset() or the owner @a item
22432 * dies. This callback receives as the first parameter the
22433 * given @a data, and @c event_info is the item.
22435 * @see elm_object_tooltip_content_cb_set() for more details.
22437 * @ingroup Diskselector
22439 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);
22442 * Unset tooltip from item.
22444 * @param item diskselector item to remove previously set tooltip.
22446 * Remove tooltip from item. The callback provided as del_cb to
22447 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22448 * it is not used anymore.
22450 * @see elm_object_tooltip_unset() for more details.
22451 * @see elm_diskselector_item_tooltip_content_cb_set()
22453 * @ingroup Diskselector
22455 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22459 * Sets a different style for this item tooltip.
22461 * @note before you set a style you should define a tooltip with
22462 * elm_diskselector_item_tooltip_content_cb_set() or
22463 * elm_diskselector_item_tooltip_text_set()
22465 * @param item diskselector item with tooltip already set.
22466 * @param style the theme style to use (default, transparent, ...)
22468 * @see elm_object_tooltip_style_set() for more details.
22470 * @ingroup Diskselector
22472 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22475 * Get the style for this item tooltip.
22477 * @param item diskselector item with tooltip already set.
22478 * @return style the theme style in use, defaults to "default". If the
22479 * object does not have a tooltip set, then NULL is returned.
22481 * @see elm_object_tooltip_style_get() for more details.
22482 * @see elm_diskselector_item_tooltip_style_set()
22484 * @ingroup Diskselector
22486 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22489 * Set the cursor to be shown when mouse is over the diskselector item
22491 * @param item Target item
22492 * @param cursor the cursor name to be used.
22494 * @see elm_object_cursor_set() for more details.
22496 * @ingroup Diskselector
22498 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22501 * Get the cursor to be shown when mouse is over the diskselector item
22503 * @param item diskselector item with cursor already set.
22504 * @return the cursor name.
22506 * @see elm_object_cursor_get() for more details.
22507 * @see elm_diskselector_cursor_set()
22509 * @ingroup Diskselector
22511 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22515 * Unset the cursor to be shown when mouse is over the diskselector item
22517 * @param item Target item
22519 * @see elm_object_cursor_unset() for more details.
22520 * @see elm_diskselector_cursor_set()
22522 * @ingroup Diskselector
22524 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22527 * Sets a different style for this item cursor.
22529 * @note before you set a style you should define a cursor with
22530 * elm_diskselector_item_cursor_set()
22532 * @param item diskselector item with cursor already set.
22533 * @param style the theme style to use (default, transparent, ...)
22535 * @see elm_object_cursor_style_set() for more details.
22537 * @ingroup Diskselector
22539 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22543 * Get the style for this item cursor.
22545 * @param item diskselector item with cursor already set.
22546 * @return style the theme style in use, defaults to "default". If the
22547 * object does not have a cursor set, then @c NULL is returned.
22549 * @see elm_object_cursor_style_get() for more details.
22550 * @see elm_diskselector_item_cursor_style_set()
22552 * @ingroup Diskselector
22554 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22558 * Set if the cursor set should be searched on the theme or should use
22559 * the provided by the engine, only.
22561 * @note before you set if should look on theme you should define a cursor
22562 * with elm_diskselector_item_cursor_set().
22563 * By default it will only look for cursors provided by the engine.
22565 * @param item widget item with cursor already set.
22566 * @param engine_only boolean to define if cursors set with
22567 * elm_diskselector_item_cursor_set() should be searched only
22568 * between cursors provided by the engine or searched on widget's
22571 * @see elm_object_cursor_engine_only_set() for more details.
22573 * @ingroup Diskselector
22575 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22578 * Get the cursor engine only usage for this item cursor.
22580 * @param item widget item with cursor already set.
22581 * @return engine_only boolean to define it cursors should be looked only
22582 * between the provided by the engine or searched on widget's theme as well.
22583 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22585 * @see elm_object_cursor_engine_only_get() for more details.
22586 * @see elm_diskselector_item_cursor_engine_only_set()
22588 * @ingroup Diskselector
22590 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22597 * @defgroup Colorselector Colorselector
22601 * @image html img/widget/colorselector/preview-00.png
22602 * @image latex img/widget/colorselector/preview-00.eps
22604 * @brief Widget for user to select a color.
22606 * Signals that you can add callbacks for are:
22607 * "changed" - When the color value changes(event_info is NULL).
22609 * See @ref tutorial_colorselector.
22612 * @brief Add a new colorselector to the parent
22614 * @param parent The parent object
22615 * @return The new object or NULL if it cannot be created
22617 * @ingroup Colorselector
22619 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22621 * Set a color for the colorselector
22623 * @param obj Colorselector object
22624 * @param r r-value of color
22625 * @param g g-value of color
22626 * @param b b-value of color
22627 * @param a a-value of color
22629 * @ingroup Colorselector
22631 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22633 * Get a color from the colorselector
22635 * @param obj Colorselector object
22636 * @param r integer pointer for r-value of color
22637 * @param g integer pointer for g-value of color
22638 * @param b integer pointer for b-value of color
22639 * @param a integer pointer for a-value of color
22641 * @ingroup Colorselector
22643 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22649 * @defgroup Ctxpopup Ctxpopup
22651 * @image html img/widget/ctxpopup/preview-00.png
22652 * @image latex img/widget/ctxpopup/preview-00.eps
22654 * @brief Context popup widet.
22656 * A ctxpopup is a widget that, when shown, pops up a list of items.
22657 * It automatically chooses an area inside its parent object's view
22658 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22659 * optimally fit into it. In the default theme, it will also point an
22660 * arrow to it's top left position at the time one shows it. Ctxpopup
22661 * items have a label and/or an icon. It is intended for a small
22662 * number of items (hence the use of list, not genlist).
22664 * @note Ctxpopup is a especialization of @ref Hover.
22666 * Signals that you can add callbacks for are:
22667 * "dismissed" - the ctxpopup was dismissed
22669 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22672 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22674 typedef enum _Elm_Ctxpopup_Direction
22676 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22678 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22679 the clicked area */
22680 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22681 the clicked area */
22682 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22684 } Elm_Ctxpopup_Direction;
22687 * @brief Add a new Ctxpopup object to the parent.
22689 * @param parent Parent object
22690 * @return New object or @c NULL, if it cannot be created
22692 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22694 * @brief Set the Ctxpopup's parent
22696 * @param obj The ctxpopup object
22697 * @param area The parent to use
22699 * Set the parent object.
22701 * @note elm_ctxpopup_add() will automatically call this function
22702 * with its @c parent argument.
22704 * @see elm_ctxpopup_add()
22705 * @see elm_hover_parent_set()
22707 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22709 * @brief Get the Ctxpopup's parent
22711 * @param obj The ctxpopup object
22713 * @see elm_ctxpopup_hover_parent_set() for more information
22715 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22717 * @brief Clear all items in the given ctxpopup object.
22719 * @param obj Ctxpopup object
22721 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22723 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22725 * @param obj Ctxpopup object
22726 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22728 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22730 * @brief Get the value of current ctxpopup object's orientation.
22732 * @param obj Ctxpopup object
22733 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22735 * @see elm_ctxpopup_horizontal_set()
22737 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22739 * @brief Add a new item to a ctxpopup object.
22741 * @param obj Ctxpopup object
22742 * @param icon Icon to be set on new item
22743 * @param label The Label of the new item
22744 * @param func Convenience function called when item selected
22745 * @param data Data passed to @p func
22746 * @return A handle to the item added or @c NULL, on errors
22748 * @warning Ctxpopup can't hold both an item list and a content at the same
22749 * time. When an item is added, any previous content will be removed.
22751 * @see elm_ctxpopup_content_set()
22753 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);
22755 * @brief Delete the given item in a ctxpopup object.
22757 * @param item Ctxpopup item to be deleted
22759 * @see elm_ctxpopup_item_append()
22761 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22763 * @brief Set the ctxpopup item's state as disabled or enabled.
22765 * @param item Ctxpopup item to be enabled/disabled
22766 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22768 * When disabled the item is greyed out to indicate it's state.
22770 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22772 * @brief Get the ctxpopup item's disabled/enabled state.
22774 * @param item Ctxpopup item to be enabled/disabled
22775 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22777 * @see elm_ctxpopup_item_disabled_set()
22779 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22781 * @brief Get the icon object for the given ctxpopup item.
22783 * @param item Ctxpopup item
22784 * @return icon object or @c NULL, if the item does not have icon or an error
22787 * @see elm_ctxpopup_item_append()
22788 * @see elm_ctxpopup_item_icon_set()
22790 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22792 * @brief Sets the side icon associated with the ctxpopup item
22794 * @param item Ctxpopup item
22795 * @param icon Icon object to be set
22797 * Once the icon object is set, a previously set one will be deleted.
22798 * @warning Setting the same icon for two items will cause the icon to
22799 * dissapear from the first item.
22801 * @see elm_ctxpopup_item_append()
22803 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22805 * @brief Get the label for the given ctxpopup item.
22807 * @param item Ctxpopup item
22808 * @return label string or @c NULL, if the item does not have label or an
22811 * @see elm_ctxpopup_item_append()
22812 * @see elm_ctxpopup_item_label_set()
22814 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22816 * @brief (Re)set the label on the given ctxpopup item.
22818 * @param item Ctxpopup item
22819 * @param label String to set as label
22821 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22823 * @brief Set an elm widget as the content of the ctxpopup.
22825 * @param obj Ctxpopup object
22826 * @param content Content to be swallowed
22828 * If the content object is already set, a previous one will bedeleted. If
22829 * you want to keep that old content object, use the
22830 * elm_ctxpopup_content_unset() function.
22832 * @deprecated use elm_object_content_set()
22834 * @warning Ctxpopup can't hold both a item list and a content at the same
22835 * time. When a content is set, any previous items will be removed.
22837 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22839 * @brief Unset the ctxpopup content
22841 * @param obj Ctxpopup object
22842 * @return The content that was being used
22844 * Unparent and return the content object which was set for this widget.
22846 * @deprecated use elm_object_content_unset()
22848 * @see elm_ctxpopup_content_set()
22850 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22852 * @brief Set the direction priority of a ctxpopup.
22854 * @param obj Ctxpopup object
22855 * @param first 1st priority of direction
22856 * @param second 2nd priority of direction
22857 * @param third 3th priority of direction
22858 * @param fourth 4th priority of direction
22860 * This functions gives a chance to user to set the priority of ctxpopup
22861 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22862 * requested direction.
22864 * @see Elm_Ctxpopup_Direction
22866 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);
22868 * @brief Get the direction priority of a ctxpopup.
22870 * @param obj Ctxpopup object
22871 * @param first 1st priority of direction to be returned
22872 * @param second 2nd priority of direction to be returned
22873 * @param third 3th priority of direction to be returned
22874 * @param fourth 4th priority of direction to be returned
22876 * @see elm_ctxpopup_direction_priority_set() for more information.
22878 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);
22886 * @defgroup Transit Transit
22887 * @ingroup Elementary
22889 * Transit is designed to apply various animated transition effects to @c
22890 * Evas_Object, such like translation, rotation, etc. For using these
22891 * effects, create an @ref Elm_Transit and add the desired transition effects.
22893 * Once the effects are added into transit, they will be automatically
22894 * managed (their callback will be called until the duration is ended, and
22895 * they will be deleted on completion).
22899 * Elm_Transit *trans = elm_transit_add();
22900 * elm_transit_object_add(trans, obj);
22901 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22902 * elm_transit_duration_set(transit, 1);
22903 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22904 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22905 * elm_transit_repeat_times_set(transit, 3);
22908 * Some transition effects are used to change the properties of objects. They
22910 * @li @ref elm_transit_effect_translation_add
22911 * @li @ref elm_transit_effect_color_add
22912 * @li @ref elm_transit_effect_rotation_add
22913 * @li @ref elm_transit_effect_wipe_add
22914 * @li @ref elm_transit_effect_zoom_add
22915 * @li @ref elm_transit_effect_resizing_add
22917 * Other transition effects are used to make one object disappear and another
22918 * object appear on its old place. These effects are:
22920 * @li @ref elm_transit_effect_flip_add
22921 * @li @ref elm_transit_effect_resizable_flip_add
22922 * @li @ref elm_transit_effect_fade_add
22923 * @li @ref elm_transit_effect_blend_add
22925 * It's also possible to make a transition chain with @ref
22926 * elm_transit_chain_transit_add.
22928 * @warning We strongly recommend to use elm_transit just when edje can not do
22929 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22930 * animations can be manipulated inside the theme.
22932 * List of examples:
22933 * @li @ref transit_example_01_explained
22934 * @li @ref transit_example_02_explained
22935 * @li @ref transit_example_03_c
22936 * @li @ref transit_example_04_c
22942 * @enum Elm_Transit_Tween_Mode
22944 * The type of acceleration used in the transition.
22948 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22949 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22950 over time, then decrease again
22952 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22954 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22956 } Elm_Transit_Tween_Mode;
22959 * @enum Elm_Transit_Effect_Flip_Axis
22961 * The axis where flip effect should be applied.
22965 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22966 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22967 } Elm_Transit_Effect_Flip_Axis;
22969 * @enum Elm_Transit_Effect_Wipe_Dir
22971 * The direction where the wipe effect should occur.
22975 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22976 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22977 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22978 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22979 } Elm_Transit_Effect_Wipe_Dir;
22980 /** @enum Elm_Transit_Effect_Wipe_Type
22982 * Whether the wipe effect should show or hide the object.
22986 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22988 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22990 } Elm_Transit_Effect_Wipe_Type;
22993 * @typedef Elm_Transit
22995 * The Transit created with elm_transit_add(). This type has the information
22996 * about the objects which the transition will be applied, and the
22997 * transition effects that will be used. It also contains info about
22998 * duration, number of repetitions, auto-reverse, etc.
23000 typedef struct _Elm_Transit Elm_Transit;
23001 typedef void Elm_Transit_Effect;
23003 * @typedef Elm_Transit_Effect_Transition_Cb
23005 * Transition callback called for this effect on each transition iteration.
23007 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23009 * Elm_Transit_Effect_End_Cb
23011 * Transition callback called for this effect when the transition is over.
23013 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23016 * Elm_Transit_Del_Cb
23018 * A callback called when the transit is deleted.
23020 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23025 * @note Is not necessary to delete the transit object, it will be deleted at
23026 * the end of its operation.
23027 * @note The transit will start playing when the program enter in the main loop, is not
23028 * necessary to give a start to the transit.
23030 * @return The transit object.
23034 EAPI Elm_Transit *elm_transit_add(void);
23037 * Stops the animation and delete the @p transit object.
23039 * Call this function if you wants to stop the animation before the duration
23040 * time. Make sure the @p transit object is still alive with
23041 * elm_transit_del_cb_set() function.
23042 * All added effects will be deleted, calling its repective data_free_cb
23043 * functions. The function setted by elm_transit_del_cb_set() will be called.
23045 * @see elm_transit_del_cb_set()
23047 * @param transit The transit object to be deleted.
23050 * @warning Just call this function if you are sure the transit is alive.
23052 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23055 * Add a new effect to the transit.
23057 * @note The cb function and the data are the key to the effect. If you try to
23058 * add an already added effect, nothing is done.
23059 * @note After the first addition of an effect in @p transit, if its
23060 * effect list become empty again, the @p transit will be killed by
23061 * elm_transit_del(transit) function.
23065 * Elm_Transit *transit = elm_transit_add();
23066 * elm_transit_effect_add(transit,
23067 * elm_transit_effect_blend_op,
23068 * elm_transit_effect_blend_context_new(),
23069 * elm_transit_effect_blend_context_free);
23072 * @param transit The transit object.
23073 * @param transition_cb The operation function. It is called when the
23074 * animation begins, it is the function that actually performs the animation.
23075 * It is called with the @p data, @p transit and the time progression of the
23076 * animation (a double value between 0.0 and 1.0).
23077 * @param effect The context data of the effect.
23078 * @param end_cb The function to free the context data, it will be called
23079 * at the end of the effect, it must finalize the animation and free the
23083 * @warning The transit free the context data at the and of the transition with
23084 * the data_free_cb function, do not use the context data in another transit.
23086 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);
23089 * Delete an added effect.
23091 * This function will remove the effect from the @p transit, calling the
23092 * data_free_cb to free the @p data.
23094 * @see elm_transit_effect_add()
23096 * @note If the effect is not found, nothing is done.
23097 * @note If the effect list become empty, this function will call
23098 * elm_transit_del(transit), that is, it will kill the @p transit.
23100 * @param transit The transit object.
23101 * @param transition_cb The operation function.
23102 * @param effect The context data of the effect.
23106 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);
23109 * Add new object to apply the effects.
23111 * @note After the first addition of an object in @p transit, if its
23112 * object list become empty again, the @p transit will be killed by
23113 * elm_transit_del(transit) function.
23114 * @note If the @p obj belongs to another transit, the @p obj will be
23115 * removed from it and it will only belong to the @p transit. If the old
23116 * transit stays without objects, it will die.
23117 * @note When you add an object into the @p transit, its state from
23118 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23119 * transit ends, if you change this state whith evas_object_pass_events_set()
23120 * after add the object, this state will change again when @p transit stops to
23123 * @param transit The transit object.
23124 * @param obj Object to be animated.
23127 * @warning It is not allowed to add a new object after transit begins to go.
23129 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23132 * Removes an added object from the transit.
23134 * @note If the @p obj is not in the @p transit, nothing is done.
23135 * @note If the list become empty, this function will call
23136 * elm_transit_del(transit), that is, it will kill the @p transit.
23138 * @param transit The transit object.
23139 * @param obj Object to be removed from @p transit.
23142 * @warning It is not allowed to remove objects after transit begins to go.
23144 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23147 * Get the objects of the transit.
23149 * @param transit The transit object.
23150 * @return a Eina_List with the objects from the transit.
23154 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23157 * Enable/disable keeping up the objects states.
23158 * If it is not kept, the objects states will be reset when transition ends.
23160 * @note @p transit can not be NULL.
23161 * @note One state includes geometry, color, map data.
23163 * @param transit The transit object.
23164 * @param state_keep Keeping or Non Keeping.
23168 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23171 * Get a value whether the objects states will be reset or not.
23173 * @note @p transit can not be NULL
23175 * @see elm_transit_objects_final_state_keep_set()
23177 * @param transit The transit object.
23178 * @return EINA_TRUE means the states of the objects will be reset.
23179 * If @p transit is NULL, EINA_FALSE is returned
23183 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23186 * Set the event enabled when transit is operating.
23188 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23189 * events from mouse and keyboard during the animation.
23190 * @note When you add an object with elm_transit_object_add(), its state from
23191 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23192 * transit ends, if you change this state with evas_object_pass_events_set()
23193 * after adding the object, this state will change again when @p transit stops
23196 * @param transit The transit object.
23197 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23198 * ignored otherwise.
23202 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23205 * Get the value of event enabled status.
23207 * @see elm_transit_event_enabled_set()
23209 * @param transit The Transit object
23210 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23211 * EINA_FALSE is returned
23215 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23218 * Set the user-callback function when the transit is deleted.
23220 * @note Using this function twice will overwrite the first function setted.
23221 * @note the @p transit object will be deleted after call @p cb function.
23223 * @param transit The transit object.
23224 * @param cb Callback function pointer. This function will be called before
23225 * the deletion of the transit.
23226 * @param data Callback funtion user data. It is the @p op parameter.
23230 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23233 * Set reverse effect automatically.
23235 * If auto reverse is setted, after running the effects with the progress
23236 * parameter from 0 to 1, it will call the effecs again with the progress
23237 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23238 * where the duration was setted with the function elm_transit_add and
23239 * the repeat with the function elm_transit_repeat_times_set().
23241 * @param transit The transit object.
23242 * @param reverse EINA_TRUE means the auto_reverse is on.
23246 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23249 * Get if the auto reverse is on.
23251 * @see elm_transit_auto_reverse_set()
23253 * @param transit The transit object.
23254 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23255 * EINA_FALSE is returned
23259 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23262 * Set the transit repeat count. Effect will be repeated by repeat count.
23264 * This function sets the number of repetition the transit will run after
23265 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23266 * If the @p repeat is a negative number, it will repeat infinite times.
23268 * @note If this function is called during the transit execution, the transit
23269 * will run @p repeat times, ignoring the times it already performed.
23271 * @param transit The transit object
23272 * @param repeat Repeat count
23276 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23279 * Get the transit repeat count.
23281 * @see elm_transit_repeat_times_set()
23283 * @param transit The Transit object.
23284 * @return The repeat count. If @p transit is NULL
23289 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23292 * Set the transit animation acceleration type.
23294 * This function sets the tween mode of the transit that can be:
23295 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23296 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23297 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23298 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23300 * @param transit The transit object.
23301 * @param tween_mode The tween type.
23305 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23308 * Get the transit animation acceleration type.
23310 * @note @p transit can not be NULL
23312 * @param transit The transit object.
23313 * @return The tween type. If @p transit is NULL
23314 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23318 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23321 * Set the transit animation time
23323 * @note @p transit can not be NULL
23325 * @param transit The transit object.
23326 * @param duration The animation time.
23330 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23333 * Get the transit animation time
23335 * @note @p transit can not be NULL
23337 * @param transit The transit object.
23339 * @return The transit animation time.
23343 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23346 * Starts the transition.
23347 * Once this API is called, the transit begins to measure the time.
23349 * @note @p transit can not be NULL
23351 * @param transit The transit object.
23355 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23358 * Pause/Resume the transition.
23360 * If you call elm_transit_go again, the transit will be started from the
23361 * beginning, and will be unpaused.
23363 * @note @p transit can not be NULL
23365 * @param transit The transit object.
23366 * @param paused Whether the transition should be paused or not.
23370 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23373 * Get the value of paused status.
23375 * @see elm_transit_paused_set()
23377 * @note @p transit can not be NULL
23379 * @param transit The transit object.
23380 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23381 * EINA_FALSE is returned
23385 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23388 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23390 * The value returned is a fraction (current time / total time). It
23391 * represents the progression position relative to the total.
23393 * @note @p transit can not be NULL
23395 * @param transit The transit object.
23397 * @return The time progression value. If @p transit is NULL
23402 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23405 * Makes the chain relationship between two transits.
23407 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23408 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23410 * @param transit The transit object.
23411 * @param chain_transit The chain transit object. This transit will be operated
23412 * after transit is done.
23414 * This function adds @p chain_transit transition to a chain after the @p
23415 * transit, and will be started as soon as @p transit ends. See @ref
23416 * transit_example_02_explained for a full example.
23420 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23423 * Cut off the chain relationship between two transits.
23425 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23426 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23428 * @param transit The transit object.
23429 * @param chain_transit The chain transit object.
23431 * This function remove the @p chain_transit transition from the @p transit.
23435 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23438 * Get the current chain transit list.
23440 * @note @p transit can not be NULL.
23442 * @param transit The transit object.
23443 * @return chain transit list.
23447 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23450 * Add the Resizing Effect to Elm_Transit.
23452 * @note This API is one of the facades. It creates resizing effect context
23453 * and add it's required APIs to elm_transit_effect_add.
23455 * @see elm_transit_effect_add()
23457 * @param transit Transit object.
23458 * @param from_w Object width size when effect begins.
23459 * @param from_h Object height size when effect begins.
23460 * @param to_w Object width size when effect ends.
23461 * @param to_h Object height size when effect ends.
23462 * @return Resizing effect context data.
23466 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);
23469 * Add the Translation Effect to Elm_Transit.
23471 * @note This API is one of the facades. It creates translation effect context
23472 * and add it's required APIs to elm_transit_effect_add.
23474 * @see elm_transit_effect_add()
23476 * @param transit Transit object.
23477 * @param from_dx X Position variation when effect begins.
23478 * @param from_dy Y Position variation when effect begins.
23479 * @param to_dx X Position variation when effect ends.
23480 * @param to_dy Y Position variation when effect ends.
23481 * @return Translation effect context data.
23484 * @warning It is highly recommended just create a transit with this effect when
23485 * the window that the objects of the transit belongs has already been created.
23486 * This is because this effect needs the geometry information about the objects,
23487 * and if the window was not created yet, it can get a wrong information.
23489 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);
23492 * Add the Zoom Effect to Elm_Transit.
23494 * @note This API is one of the facades. It creates zoom effect context
23495 * and add it's required APIs to elm_transit_effect_add.
23497 * @see elm_transit_effect_add()
23499 * @param transit Transit object.
23500 * @param from_rate Scale rate when effect begins (1 is current rate).
23501 * @param to_rate Scale rate when effect ends.
23502 * @return Zoom effect context data.
23505 * @warning It is highly recommended just create a transit with this effect when
23506 * the window that the objects of the transit belongs has already been created.
23507 * This is because this effect needs the geometry information about the objects,
23508 * and if the window was not created yet, it can get a wrong information.
23510 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23513 * Add the Flip Effect to Elm_Transit.
23515 * @note This API is one of the facades. It creates flip effect context
23516 * and add it's required APIs to elm_transit_effect_add.
23517 * @note This effect is applied to each pair of objects in the order they are listed
23518 * in the transit list of objects. The first object in the pair will be the
23519 * "front" object and the second will be the "back" object.
23521 * @see elm_transit_effect_add()
23523 * @param transit Transit object.
23524 * @param axis Flipping Axis(X or Y).
23525 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23526 * @return Flip effect context data.
23529 * @warning It is highly recommended just create a transit with this effect when
23530 * the window that the objects of the transit belongs has already been created.
23531 * This is because this effect needs the geometry information about the objects,
23532 * and if the window was not created yet, it can get a wrong information.
23534 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23537 * Add the Resizable Flip Effect to Elm_Transit.
23539 * @note This API is one of the facades. It creates resizable flip effect context
23540 * and add it's required APIs to elm_transit_effect_add.
23541 * @note This effect is applied to each pair of objects in the order they are listed
23542 * in the transit list of objects. The first object in the pair will be the
23543 * "front" object and the second will be the "back" object.
23545 * @see elm_transit_effect_add()
23547 * @param transit Transit object.
23548 * @param axis Flipping Axis(X or Y).
23549 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23550 * @return Resizable flip effect context data.
23553 * @warning It is highly recommended just create a transit with this effect when
23554 * the window that the objects of the transit belongs has already been created.
23555 * This is because this effect needs the geometry information about the objects,
23556 * and if the window was not created yet, it can get a wrong information.
23558 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23561 * Add the Wipe Effect to Elm_Transit.
23563 * @note This API is one of the facades. It creates wipe effect context
23564 * and add it's required APIs to elm_transit_effect_add.
23566 * @see elm_transit_effect_add()
23568 * @param transit Transit object.
23569 * @param type Wipe type. Hide or show.
23570 * @param dir Wipe Direction.
23571 * @return Wipe effect context data.
23574 * @warning It is highly recommended just create a transit with this effect when
23575 * the window that the objects of the transit belongs has already been created.
23576 * This is because this effect needs the geometry information about the objects,
23577 * and if the window was not created yet, it can get a wrong information.
23579 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23582 * Add the Color Effect to Elm_Transit.
23584 * @note This API is one of the facades. It creates color effect context
23585 * and add it's required APIs to elm_transit_effect_add.
23587 * @see elm_transit_effect_add()
23589 * @param transit Transit object.
23590 * @param from_r RGB R when effect begins.
23591 * @param from_g RGB G when effect begins.
23592 * @param from_b RGB B when effect begins.
23593 * @param from_a RGB A when effect begins.
23594 * @param to_r RGB R when effect ends.
23595 * @param to_g RGB G when effect ends.
23596 * @param to_b RGB B when effect ends.
23597 * @param to_a RGB A when effect ends.
23598 * @return Color effect context data.
23602 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);
23605 * Add the Fade Effect to Elm_Transit.
23607 * @note This API is one of the facades. It creates fade effect context
23608 * and add it's required APIs to elm_transit_effect_add.
23609 * @note This effect is applied to each pair of objects in the order they are listed
23610 * in the transit list of objects. The first object in the pair will be the
23611 * "before" object and the second will be the "after" object.
23613 * @see elm_transit_effect_add()
23615 * @param transit Transit object.
23616 * @return Fade effect context data.
23619 * @warning It is highly recommended just create a transit with this effect when
23620 * the window that the objects of the transit belongs has already been created.
23621 * This is because this effect needs the color information about the objects,
23622 * and if the window was not created yet, it can get a wrong information.
23624 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23627 * Add the Blend Effect to Elm_Transit.
23629 * @note This API is one of the facades. It creates blend effect context
23630 * and add it's required APIs to elm_transit_effect_add.
23631 * @note This effect is applied to each pair of objects in the order they are listed
23632 * in the transit list of objects. The first object in the pair will be the
23633 * "before" object and the second will be the "after" object.
23635 * @see elm_transit_effect_add()
23637 * @param transit Transit object.
23638 * @return Blend effect context data.
23641 * @warning It is highly recommended just create a transit with this effect when
23642 * the window that the objects of the transit belongs has already been created.
23643 * This is because this effect needs the color information about the objects,
23644 * and if the window was not created yet, it can get a wrong information.
23646 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23649 * Add the Rotation Effect to Elm_Transit.
23651 * @note This API is one of the facades. It creates rotation effect context
23652 * and add it's required APIs to elm_transit_effect_add.
23654 * @see elm_transit_effect_add()
23656 * @param transit Transit object.
23657 * @param from_degree Degree when effect begins.
23658 * @param to_degree Degree when effect is ends.
23659 * @return Rotation effect context data.
23662 * @warning It is highly recommended just create a transit with this effect when
23663 * the window that the objects of the transit belongs has already been created.
23664 * This is because this effect needs the geometry information about the objects,
23665 * and if the window was not created yet, it can get a wrong information.
23667 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23670 * Add the ImageAnimation Effect to Elm_Transit.
23672 * @note This API is one of the facades. It creates image animation effect context
23673 * and add it's required APIs to elm_transit_effect_add.
23674 * The @p images parameter is a list images paths. This list and
23675 * its contents will be deleted at the end of the effect by
23676 * elm_transit_effect_image_animation_context_free() function.
23680 * char buf[PATH_MAX];
23681 * Eina_List *images = NULL;
23682 * Elm_Transit *transi = elm_transit_add();
23684 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23685 * images = eina_list_append(images, eina_stringshare_add(buf));
23687 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23688 * images = eina_list_append(images, eina_stringshare_add(buf));
23689 * elm_transit_effect_image_animation_add(transi, images);
23693 * @see elm_transit_effect_add()
23695 * @param transit Transit object.
23696 * @param images Eina_List of images file paths. This list and
23697 * its contents will be deleted at the end of the effect by
23698 * elm_transit_effect_image_animation_context_free() function.
23699 * @return Image Animation effect context data.
23703 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23708 typedef struct _Elm_Store Elm_Store;
23709 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23710 typedef struct _Elm_Store_Item Elm_Store_Item;
23711 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23712 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23713 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23714 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23715 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23716 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23717 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23718 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23720 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23721 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23722 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23723 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23727 ELM_STORE_ITEM_MAPPING_NONE = 0,
23728 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23729 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23730 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23731 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23732 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23733 // can add more here as needed by common apps
23734 ELM_STORE_ITEM_MAPPING_LAST
23735 } Elm_Store_Item_Mapping_Type;
23737 struct _Elm_Store_Item_Mapping_Icon
23739 // FIXME: allow edje file icons
23741 Elm_Icon_Lookup_Order lookup_order;
23742 Eina_Bool standard_name : 1;
23743 Eina_Bool no_scale : 1;
23744 Eina_Bool smooth : 1;
23745 Eina_Bool scale_up : 1;
23746 Eina_Bool scale_down : 1;
23749 struct _Elm_Store_Item_Mapping_Empty
23754 struct _Elm_Store_Item_Mapping_Photo
23759 struct _Elm_Store_Item_Mapping_Custom
23761 Elm_Store_Item_Mapping_Cb func;
23764 struct _Elm_Store_Item_Mapping
23766 Elm_Store_Item_Mapping_Type type;
23771 Elm_Store_Item_Mapping_Empty empty;
23772 Elm_Store_Item_Mapping_Icon icon;
23773 Elm_Store_Item_Mapping_Photo photo;
23774 Elm_Store_Item_Mapping_Custom custom;
23775 // add more types here
23779 struct _Elm_Store_Item_Info
23781 Elm_Genlist_Item_Class *item_class;
23782 const Elm_Store_Item_Mapping *mapping;
23787 struct _Elm_Store_Item_Info_Filesystem
23789 Elm_Store_Item_Info base;
23793 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23794 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23796 EAPI void elm_store_free(Elm_Store *st);
23798 EAPI Elm_Store *elm_store_filesystem_new(void);
23799 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23800 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23801 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23803 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23805 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23806 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23807 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23808 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23809 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23810 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23812 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23813 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23814 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23815 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23816 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23817 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23818 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23821 * @defgroup SegmentControl SegmentControl
23822 * @ingroup Elementary
23824 * @image html img/widget/segment_control/preview-00.png
23825 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23827 * @image html img/segment_control.png
23828 * @image latex img/segment_control.eps width=\textwidth
23830 * Segment control widget is a horizontal control made of multiple segment
23831 * items, each segment item functioning similar to discrete two state button.
23832 * A segment control groups the items together and provides compact
23833 * single button with multiple equal size segments.
23835 * Segment item size is determined by base widget
23836 * size and the number of items added.
23837 * Only one segment item can be at selected state. A segment item can display
23838 * combination of Text and any Evas_Object like Images or other widget.
23840 * Smart callbacks one can listen to:
23841 * - "changed" - When the user clicks on a segment item which is not
23842 * previously selected and get selected. The event_info parameter is the
23843 * segment item index.
23845 * Available styles for it:
23848 * Here is an example on its usage:
23849 * @li @ref segment_control_example
23853 * @addtogroup SegmentControl
23857 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23860 * Add a new segment control widget to the given parent Elementary
23861 * (container) object.
23863 * @param parent The parent object.
23864 * @return a new segment control widget handle or @c NULL, on errors.
23866 * This function inserts a new segment control widget on the canvas.
23868 * @ingroup SegmentControl
23870 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23873 * Append a new item to the segment control object.
23875 * @param obj The segment control object.
23876 * @param icon The icon object to use for the left side of the item. An
23877 * icon can be any Evas object, but usually it is an icon created
23878 * with elm_icon_add().
23879 * @param label The label of the item.
23880 * Note that, NULL is different from empty string "".
23881 * @return The created item or @c NULL upon failure.
23883 * A new item will be created and appended to the segment control, i.e., will
23884 * be set as @b last item.
23886 * If it should be inserted at another position,
23887 * elm_segment_control_item_insert_at() should be used instead.
23889 * Items created with this function can be deleted with function
23890 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23892 * @note @p label set to @c NULL is different from empty string "".
23894 * only has icon, it will be displayed bigger and centered. If it has
23895 * icon and label, even that an empty string, icon will be smaller and
23896 * positioned at left.
23900 * sc = elm_segment_control_add(win);
23901 * ic = elm_icon_add(win);
23902 * elm_icon_file_set(ic, "path/to/image", NULL);
23903 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23904 * elm_segment_control_item_add(sc, ic, "label");
23905 * evas_object_show(sc);
23908 * @see elm_segment_control_item_insert_at()
23909 * @see elm_segment_control_item_del()
23911 * @ingroup SegmentControl
23913 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23916 * Insert a new item to the segment control object at specified position.
23918 * @param obj The segment control object.
23919 * @param icon The icon object to use for the left side of the item. An
23920 * icon can be any Evas object, but usually it is an icon created
23921 * with elm_icon_add().
23922 * @param label The label of the item.
23923 * @param index Item position. Value should be between 0 and items count.
23924 * @return The created item or @c NULL upon failure.
23926 * Index values must be between @c 0, when item will be prepended to
23927 * segment control, and items count, that can be get with
23928 * elm_segment_control_item_count_get(), case when item will be appended
23929 * to segment control, just like elm_segment_control_item_add().
23931 * Items created with this function can be deleted with function
23932 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23934 * @note @p label set to @c NULL is different from empty string "".
23936 * only has icon, it will be displayed bigger and centered. If it has
23937 * icon and label, even that an empty string, icon will be smaller and
23938 * positioned at left.
23940 * @see elm_segment_control_item_add()
23941 * @see elm_segment_control_count_get()
23942 * @see elm_segment_control_item_del()
23944 * @ingroup SegmentControl
23946 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);
23949 * Remove a segment control item from its parent, deleting it.
23951 * @param it The item to be removed.
23953 * Items can be added with elm_segment_control_item_add() or
23954 * elm_segment_control_item_insert_at().
23956 * @ingroup SegmentControl
23958 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23961 * Remove a segment control item at given index from its parent,
23964 * @param obj The segment control object.
23965 * @param index The position of the segment control item to be deleted.
23967 * Items can be added with elm_segment_control_item_add() or
23968 * elm_segment_control_item_insert_at().
23970 * @ingroup SegmentControl
23972 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23975 * Get the Segment items count from segment control.
23977 * @param obj The segment control object.
23978 * @return Segment items count.
23980 * It will just return the number of items added to segment control @p obj.
23982 * @ingroup SegmentControl
23984 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23987 * Get the item placed at specified index.
23989 * @param obj The segment control object.
23990 * @param index The index of the segment item.
23991 * @return The segment control item or @c NULL on failure.
23993 * Index is the position of an item in segment control widget. Its
23994 * range is from @c 0 to <tt> count - 1 </tt>.
23995 * Count is the number of items, that can be get with
23996 * elm_segment_control_item_count_get().
23998 * @ingroup SegmentControl
24000 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24003 * Get the label of item.
24005 * @param obj The segment control object.
24006 * @param index The index of the segment item.
24007 * @return The label of the item at @p index.
24009 * The return value is a pointer to the label associated to the item when
24010 * it was created, with function elm_segment_control_item_add(), or later
24011 * with function elm_segment_control_item_label_set. If no label
24012 * was passed as argument, it will return @c NULL.
24014 * @see elm_segment_control_item_label_set() for more details.
24015 * @see elm_segment_control_item_add()
24017 * @ingroup SegmentControl
24019 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24022 * Set the label of item.
24024 * @param it The item of segment control.
24025 * @param text The label of item.
24027 * The label to be displayed by the item.
24028 * Label will be at right of the icon (if set).
24030 * If a label was passed as argument on item creation, with function
24031 * elm_control_segment_item_add(), it will be already
24032 * displayed by the item.
24034 * @see elm_segment_control_item_label_get()
24035 * @see elm_segment_control_item_add()
24037 * @ingroup SegmentControl
24039 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24042 * Get the icon associated to the item.
24044 * @param obj The segment control object.
24045 * @param index The index of the segment item.
24046 * @return The left side icon associated to the item at @p index.
24048 * The return value is a pointer to the icon associated to the item when
24049 * it was created, with function elm_segment_control_item_add(), or later
24050 * with function elm_segment_control_item_icon_set(). If no icon
24051 * was passed as argument, it will return @c NULL.
24053 * @see elm_segment_control_item_add()
24054 * @see elm_segment_control_item_icon_set()
24056 * @ingroup SegmentControl
24058 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24061 * Set the icon associated to the item.
24063 * @param it The segment control item.
24064 * @param icon The icon object to associate with @p it.
24066 * The icon object to use at left side of the item. An
24067 * icon can be any Evas object, but usually it is an icon created
24068 * with elm_icon_add().
24070 * Once the icon object is set, a previously set one will be deleted.
24071 * @warning Setting the same icon for two items will cause the icon to
24072 * dissapear from the first item.
24074 * If an icon was passed as argument on item creation, with function
24075 * elm_segment_control_item_add(), it will be already
24076 * associated to the item.
24078 * @see elm_segment_control_item_add()
24079 * @see elm_segment_control_item_icon_get()
24081 * @ingroup SegmentControl
24083 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24086 * Get the index of an item.
24088 * @param it The segment control item.
24089 * @return The position of item in segment control widget.
24091 * Index is the position of an item in segment control widget. Its
24092 * range is from @c 0 to <tt> count - 1 </tt>.
24093 * Count is the number of items, that can be get with
24094 * elm_segment_control_item_count_get().
24096 * @ingroup SegmentControl
24098 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24101 * Get the base object of the item.
24103 * @param it The segment control item.
24104 * @return The base object associated with @p it.
24106 * Base object is the @c Evas_Object that represents that item.
24108 * @ingroup SegmentControl
24110 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24113 * Get the selected item.
24115 * @param obj The segment control object.
24116 * @return The selected item or @c NULL if none of segment items is
24119 * The selected item can be unselected with function
24120 * elm_segment_control_item_selected_set().
24122 * The selected item always will be highlighted on segment control.
24124 * @ingroup SegmentControl
24126 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24129 * Set the selected state of an item.
24131 * @param it The segment control item
24132 * @param select The selected state
24134 * This sets the selected state of the given item @p it.
24135 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24137 * If a new item is selected the previosly selected will be unselected.
24138 * Previoulsy selected item can be get with function
24139 * elm_segment_control_item_selected_get().
24141 * The selected item always will be highlighted on segment control.
24143 * @see elm_segment_control_item_selected_get()
24145 * @ingroup SegmentControl
24147 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24154 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24155 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24156 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24157 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24158 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24159 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24160 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24161 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24164 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24165 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24166 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24168 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24169 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24170 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24171 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24172 EAPI void elm_video_play(Evas_Object *video);
24173 EAPI void elm_video_pause(Evas_Object *video);
24174 EAPI void elm_video_stop(Evas_Object *video);
24175 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24176 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24177 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24178 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24179 EAPI double elm_video_audio_level_get(Evas_Object *video);
24180 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24181 EAPI double elm_video_play_position_get(Evas_Object *video);
24182 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24183 EAPI double elm_video_play_length_get(Evas_Object *video);
24184 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24185 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24186 EAPI const char *elm_video_title_get(Evas_Object *video);
24188 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24189 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24192 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24193 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);
24194 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24195 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24196 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24197 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24198 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24199 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24200 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24201 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24202 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24203 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24204 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24205 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24206 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);