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 build 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 circumstances 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); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
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 returns the new counter's value.
598 * @warning This call is exported only for use by the @c ELM_MAIN()
599 * macro. There is no need to use this if you use this macro (which
600 * is highly advisable). An elm_main() should contain the entry
601 * point code for your application, having the same prototype as
602 * elm_init(), and @b not being static (putting the @c EAPI symbol
603 * in front of its type declaration is advisable). The @c
604 * ELM_MAIN() call should be placed just after it.
607 * @dontinclude bg_example_01.c
611 * See the full @ref bg_example_01_c "example".
613 * @see elm_shutdown().
616 EAPI int elm_init(int argc, char **argv);
619 * Shut down Elementary
621 * @return The init counter value.
623 * This should be called at the end of your application, just
624 * before it ceases to do any more processing. This will clean up
625 * any permanent resources your application may have allocated via
626 * Elementary that would otherwise persist.
628 * @see elm_init() for an example
632 EAPI int elm_shutdown(void);
635 * Run Elementary's main loop
637 * This call should be issued just after all initialization is
638 * completed. This function will not return until elm_exit() is
639 * called. It will keep looping, running the main
640 * (event/processing) loop for Elementary.
642 * @see elm_init() for an example
646 EAPI void elm_run(void);
649 * Exit Elementary's main loop
651 * If this call is issued, it will flag the main loop to cease
652 * processing and return back to its parent function (usually your
653 * elm_main() function).
655 * @see elm_init() for an example. There, just after a request to
656 * close the window comes, the main loop will be left.
658 * @note By using the #ELM_POLICY_QUIT on your Elementary
659 * applications, you'll this function called automatically for you.
663 EAPI void elm_exit(void);
666 * Provide information in order to make Elementary determine the @b
667 * run time location of the software in question, so other data files
668 * such as images, sound files, executable utilities, libraries,
669 * modules and locale files can be found.
671 * @param mainfunc This is your application's main function name,
672 * whose binary's location is to be found. Providing @c NULL
673 * will make Elementary not to use it
674 * @param dom This will be used as the application's "domain", in the
675 * form of a prefix to any environment variables that may
676 * override prefix detection and the directory name, inside the
677 * standard share or data directories, where the software's
678 * data files will be looked for.
679 * @param checkfile This is an (optional) magic file's path to check
680 * for existence (and it must be located in the data directory,
681 * under the share directory provided above). Its presence will
682 * help determine the prefix found was correct. Pass @c NULL if
683 * the check is not to be done.
685 * This function allows one to re-locate the application somewhere
686 * else after compilation, if the developer wishes for easier
687 * distribution of pre-compiled binaries.
689 * The prefix system is designed to locate where the given software is
690 * installed (under a common path prefix) at run time and then report
691 * specific locations of this prefix and common directories inside
692 * this prefix like the binary, library, data and locale directories,
693 * through the @c elm_app_*_get() family of functions.
695 * Call elm_app_info_set() early on before you change working
696 * directory or anything about @c argv[0], so it gets accurate
699 * It will then try and trace back which file @p mainfunc comes from,
700 * if provided, to determine the application's prefix directory.
702 * The @p dom parameter provides a string prefix to prepend before
703 * environment variables, allowing a fallback to @b specific
704 * environment variables to locate the software. You would most
705 * probably provide a lowercase string there, because it will also
706 * serve as directory domain, explained next. For environment
707 * variables purposes, this string is made uppercase. For example if
708 * @c "myapp" is provided as the prefix, then the program would expect
709 * @c "MYAPP_PREFIX" as a master environment variable to specify the
710 * exact install prefix for the software, or more specific environment
711 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713 * the user or scripts before launching. If not provided (@c NULL),
714 * environment variables will not be used to override compiled-in
715 * defaults or auto detections.
717 * The @p dom string also provides a subdirectory inside the system
718 * shared data directory for data files. For example, if the system
719 * directory is @c /usr/local/share, then this directory name is
720 * appended, creating @c /usr/local/share/myapp, if it @p was @c
721 * "myapp". It is expected the application installs data files in
724 * The @p checkfile is a file name or path of something inside the
725 * share or data directory to be used to test that the prefix
726 * detection worked. For example, your app will install a wallpaper
727 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
731 * @see elm_app_compile_bin_dir_set()
732 * @see elm_app_compile_lib_dir_set()
733 * @see elm_app_compile_data_dir_set()
734 * @see elm_app_compile_locale_set()
735 * @see elm_app_prefix_dir_get()
736 * @see elm_app_bin_dir_get()
737 * @see elm_app_lib_dir_get()
738 * @see elm_app_data_dir_get()
739 * @see elm_app_locale_dir_get()
741 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
744 * Provide information on the @b fallback application's binaries
745 * directory, on scenarios where they get overriden by
746 * elm_app_info_set().
748 * @param dir The path to the default binaries directory (compile time
751 * @note Elementary will as well use this path to determine actual
752 * names of binaries' directory paths, maybe changing it to be @c
753 * something/local/bin instead of @c something/bin, only, for
756 * @warning You should call this function @b before
757 * elm_app_info_set().
759 EAPI void elm_app_compile_bin_dir_set(const char *dir);
762 * Provide information on the @b fallback application's libraries
763 * directory, on scenarios where they get overriden by
764 * elm_app_info_set().
766 * @param dir The path to the default libraries directory (compile
769 * @note Elementary will as well use this path to determine actual
770 * names of libraries' directory paths, maybe changing it to be @c
771 * something/lib32 or @c something/lib64 instead of @c something/lib,
774 * @warning You should call this function @b before
775 * elm_app_info_set().
777 EAPI void elm_app_compile_lib_dir_set(const char *dir);
780 * Provide information on the @b fallback application's data
781 * directory, on scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default data directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of data directory paths, maybe changing it to be @c
789 * something/local/share instead of @c something/share, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_data_dir_set(const char *dir);
798 * Provide information on the @b fallback application's locale
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default locale directory (compile time
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_locale_set(const char *dir);
811 * Retrieve the application's run time prefix directory, as set by
812 * elm_app_info_set() and the way (environment) the application was
815 * @return The directory prefix the application is actually using
817 EAPI const char *elm_app_prefix_dir_get(void);
820 * Retrieve the application's run time binaries prefix directory, as
821 * set by elm_app_info_set() and the way (environment) the application
824 * @return The binaries directory prefix the application is actually
827 EAPI const char *elm_app_bin_dir_get(void);
830 * Retrieve the application's run time libraries prefix directory, as
831 * set by elm_app_info_set() and the way (environment) the application
834 * @return The libraries directory prefix the application is actually
837 EAPI const char *elm_app_lib_dir_get(void);
840 * Retrieve the application's run time data prefix directory, as
841 * set by elm_app_info_set() and the way (environment) the application
844 * @return The data directory prefix the application is actually
847 EAPI const char *elm_app_data_dir_get(void);
850 * Retrieve the application's run time locale prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The locale directory prefix the application is actually
857 EAPI const char *elm_app_locale_dir_get(void);
859 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
860 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
861 EAPI int elm_quicklaunch_init(int argc, char **argv);
862 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
863 EAPI int elm_quicklaunch_sub_shutdown(void);
864 EAPI int elm_quicklaunch_shutdown(void);
865 EAPI void elm_quicklaunch_seed(void);
866 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
867 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868 EAPI void elm_quicklaunch_cleanup(void);
869 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
870 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
872 EAPI Eina_Bool elm_need_efreet(void);
873 EAPI Eina_Bool elm_need_e_dbus(void);
876 * This must be called before any other function that handle with
877 * elm_thumb objects or ethumb_client instances.
881 EAPI Eina_Bool elm_need_ethumb(void);
884 * Set a new policy's value (for a given policy group/identifier).
886 * @param policy policy identifier, as in @ref Elm_Policy.
887 * @param value policy value, which depends on the identifier
889 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
891 * Elementary policies define applications' behavior,
892 * somehow. These behaviors are divided in policy groups (see
893 * #Elm_Policy enumeration). This call will emit the Ecore event
894 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
898 * @note Currently, we have only one policy identifier/group
899 * (#ELM_POLICY_QUIT), which has two possible values.
903 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
906 * Gets the policy value set for given policy identifier.
908 * @param policy policy identifier, as in #Elm_Policy.
909 * @return The currently set policy value, for that
910 * identifier. Will be @c 0 if @p policy passed is invalid.
914 EAPI int elm_policy_get(unsigned int policy);
917 * Set a label of an object
919 * @param obj The Elementary object
920 * @param part The text part name to set (NULL for the default label)
921 * @param label The new text of the label
923 * @note Elementary objects may have many labels (e.g. Action Slider)
927 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
932 * Get a label of an object
934 * @param obj The Elementary object
935 * @param part The text part name to get (NULL for the default label)
936 * @return text of the label or NULL for any error
938 * @note Elementary objects may have many labels (e.g. Action Slider)
942 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
947 * Set a content of an object
949 * @param obj The Elementary object
950 * @param part The content part name to set (NULL for the default content)
951 * @param content The new content of the object
953 * @note Elementary objects may have many contents
957 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
962 * Get a content of an object
964 * @param obj The Elementary object
965 * @param item The content part name to get (NULL for the default content)
966 * @return content of the object or NULL for any error
968 * @note Elementary objects may have many contents
972 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
977 * Unset a content of an object
979 * @param obj The Elementary object
980 * @param item The content part name to unset (NULL for the default content)
982 * @note Elementary objects may have many contents
986 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
991 * Set a content of an object item
993 * @param it The Elementary object item
994 * @param part The content part name to unset (NULL for the default content)
995 * @param content The new content of the object item
997 * @note Elementary object items may have many contents
1001 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1006 * Get a content of an object item
1008 * @param it The Elementary object item
1009 * @param part The content part name to unset (NULL for the default content)
1010 * @return content of the object item or NULL for any error
1012 * @note Elementary object items may have many contents
1016 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1021 * Unset a content of an object item
1023 * @param it The Elementary object item
1024 * @param part The content part name to unset (NULL for the default content)
1026 * @note Elementary object items may have many contents
1030 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1035 * Set a label of an objec itemt
1037 * @param it The Elementary object item
1038 * @param part The text part name to set (NULL for the default label)
1039 * @param label The new text of the label
1041 * @note Elementary object items may have many labels
1045 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1050 * Get a label of an object
1052 * @param it The Elementary object item
1053 * @param part The text part name to get (NULL for the default label)
1054 * @return text of the label or NULL for any error
1056 * @note Elementary object items may have many labels
1060 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1062 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1069 * @defgroup Caches Caches
1071 * These are functions which let one fine-tune some cache values for
1072 * Elementary applications, thus allowing for performance adjustments.
1078 * @brief Flush all caches.
1080 * Frees all data that was in cache and is not currently being used to reduce
1081 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1082 * to calling all of the following functions:
1083 * @li edje_file_cache_flush()
1084 * @li edje_collection_cache_flush()
1085 * @li eet_clearcache()
1086 * @li evas_image_cache_flush()
1087 * @li evas_font_cache_flush()
1088 * @li evas_render_dump()
1089 * @note Evas caches are flushed for every canvas associated with a window.
1093 EAPI void elm_all_flush(void);
1096 * Get the configured cache flush interval time
1098 * This gets the globally configured cache flush interval time, in
1101 * @return The cache flush interval time
1104 * @see elm_all_flush()
1106 EAPI int elm_cache_flush_interval_get(void);
1109 * Set the configured cache flush interval time
1111 * This sets the globally configured cache flush interval time, in ticks
1113 * @param size The cache flush interval time
1116 * @see elm_all_flush()
1118 EAPI void elm_cache_flush_interval_set(int size);
1121 * Set the configured cache flush interval time for all applications on the
1124 * This sets the globally configured cache flush interval time -- in ticks
1125 * -- for all applications on the display.
1127 * @param size The cache flush interval time
1130 EAPI void elm_cache_flush_interval_all_set(int size);
1133 * Get the configured cache flush enabled state
1135 * This gets the globally configured cache flush state - if it is enabled
1136 * or not. When cache flushing is enabled, elementary will regularly
1137 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1138 * memory and allow usage to re-seed caches and data in memory where it
1139 * can do so. An idle application will thus minimise its memory usage as
1140 * data will be freed from memory and not be re-loaded as it is idle and
1141 * not rendering or doing anything graphically right now.
1143 * @return The cache flush state
1146 * @see elm_all_flush()
1148 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1151 * Set the configured cache flush enabled state
1153 * This sets the globally configured cache flush enabled state
1155 * @param size The cache flush enabled state
1158 * @see elm_all_flush()
1160 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1163 * Set the configured cache flush enabled state for all applications on the
1166 * This sets the globally configured cache flush enabled state for all
1167 * applications on the display.
1169 * @param size The cache flush enabled state
1172 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1175 * Get the configured font cache size
1177 * This gets the globally configured font cache size, in bytes
1179 * @return The font cache size
1182 EAPI int elm_font_cache_get(void);
1185 * Set the configured font cache size
1187 * This sets the globally configured font cache size, in bytes
1189 * @param size The font cache size
1192 EAPI void elm_font_cache_set(int size);
1195 * Set the configured font cache size for all applications on the
1198 * This sets the globally configured font cache size -- in bytes
1199 * -- for all applications on the display.
1201 * @param size The font cache size
1204 EAPI void elm_font_cache_all_set(int size);
1207 * Get the configured image cache size
1209 * This gets the globally configured image cache size, in bytes
1211 * @return The image cache size
1214 EAPI int elm_image_cache_get(void);
1217 * Set the configured image cache size
1219 * This sets the globally configured image cache size, in bytes
1221 * @param size The image cache size
1224 EAPI void elm_image_cache_set(int size);
1227 * Set the configured image cache size for all applications on the
1230 * This sets the globally configured image cache size -- in bytes
1231 * -- for all applications on the display.
1233 * @param size The image cache size
1236 EAPI void elm_image_cache_all_set(int size);
1239 * Get the configured edje file cache size.
1241 * This gets the globally configured edje file cache size, in number
1244 * @return The edje file cache size
1247 EAPI int elm_edje_file_cache_get(void);
1250 * Set the configured edje file cache size
1252 * This sets the globally configured edje file cache size, in number
1255 * @param size The edje file cache size
1258 EAPI void elm_edje_file_cache_set(int size);
1261 * Set the configured edje file cache size for all applications on the
1264 * This sets the globally configured edje file cache size -- in number
1265 * of files -- for all applications on the display.
1267 * @param size The edje file cache size
1270 EAPI void elm_edje_file_cache_all_set(int size);
1273 * Get the configured edje collections (groups) cache size.
1275 * This gets the globally configured edje collections cache size, in
1276 * number of collections.
1278 * @return The edje collections cache size
1281 EAPI int elm_edje_collection_cache_get(void);
1284 * Set the configured edje collections (groups) cache size
1286 * This sets the globally configured edje collections cache size, in
1287 * number of collections.
1289 * @param size The edje collections cache size
1292 EAPI void elm_edje_collection_cache_set(int size);
1295 * Set the configured edje collections (groups) cache size for all
1296 * applications on the display
1298 * This sets the globally configured edje collections cache size -- in
1299 * number of collections -- for all applications on the display.
1301 * @param size The edje collections cache size
1304 EAPI void elm_edje_collection_cache_all_set(int size);
1311 * @defgroup Scaling Widget Scaling
1313 * Different widgets can be scaled independently. These functions
1314 * allow you to manipulate this scaling on a per-widget basis. The
1315 * object and all its children get their scaling factors multiplied
1316 * by the scale factor set. This is multiplicative, in that if a
1317 * child also has a scale size set it is in turn multiplied by its
1318 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1319 * double size, @c 0.5 is half, etc.
1321 * @ref general_functions_example_page "This" example contemplates
1322 * some of these functions.
1326 * Get the global scaling factor
1328 * This gets the globally configured scaling factor that is applied to all
1331 * @return The scaling factor
1334 EAPI double elm_scale_get(void);
1337 * Set the global scaling factor
1339 * This sets the globally configured scaling factor that is applied to all
1342 * @param scale The scaling factor to set
1345 EAPI void elm_scale_set(double scale);
1348 * Set the global scaling factor for all applications on the display
1350 * This sets the globally configured scaling factor that is applied to all
1351 * objects for all applications.
1352 * @param scale The scaling factor to set
1355 EAPI void elm_scale_all_set(double scale);
1358 * Set the scaling factor for a given Elementary object
1360 * @param obj The Elementary to operate on
1361 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1366 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1369 * Get the scaling factor for a given Elementary object
1371 * @param obj The object
1372 * @return The scaling factor set by elm_object_scale_set()
1376 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1379 * @defgroup UI-Mirroring Selective Widget mirroring
1381 * These functions allow you to set ui-mirroring on specific
1382 * widgets or the whole interface. Widgets can be in one of two
1383 * modes, automatic and manual. Automatic means they'll be changed
1384 * according to the system mirroring mode and manual means only
1385 * explicit changes will matter. You are not supposed to change
1386 * mirroring state of a widget set to automatic, will mostly work,
1387 * but the behavior is not really defined.
1392 EAPI Eina_Bool elm_mirrored_get(void);
1393 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1396 * Get the system mirrored mode. This determines the default mirrored mode
1399 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1401 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * Set the system mirrored mode. This determines the default mirrored mode
1407 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1409 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1412 * Returns the widget's mirrored mode setting.
1414 * @param obj The widget.
1415 * @return mirrored mode setting of the object.
1418 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1421 * Sets the widget's mirrored mode setting.
1422 * When widget in automatic mode, it follows the system mirrored mode set by
1423 * elm_mirrored_set().
1424 * @param obj The widget.
1425 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1427 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1434 * Set the style to use by a widget
1436 * Sets the style name that will define the appearance of a widget. Styles
1437 * vary from widget to widget and may also be defined by other themes
1438 * by means of extensions and overlays.
1440 * @param obj The Elementary widget to style
1441 * @param style The style name to use
1443 * @see elm_theme_extension_add()
1444 * @see elm_theme_extension_del()
1445 * @see elm_theme_overlay_add()
1446 * @see elm_theme_overlay_del()
1450 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1452 * Get the style used by the widget
1454 * This gets the style being used for that widget. Note that the string
1455 * pointer is only valid as longas the object is valid and the style doesn't
1458 * @param obj The Elementary widget to query for its style
1459 * @return The style name used
1461 * @see elm_object_style_set()
1465 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1468 * @defgroup Styles Styles
1470 * Widgets can have different styles of look. These generic API's
1471 * set styles of widgets, if they support them (and if the theme(s)
1474 * @ref general_functions_example_page "This" example contemplates
1475 * some of these functions.
1479 * Set the disabled state of an Elementary object.
1481 * @param obj The Elementary object to operate on
1482 * @param disabled The state to put in in: @c EINA_TRUE for
1483 * disabled, @c EINA_FALSE for enabled
1485 * Elementary objects can be @b disabled, in which state they won't
1486 * receive input and, in general, will be themed differently from
1487 * their normal state, usually greyed out. Useful for contexts
1488 * where you don't want your users to interact with some of the
1489 * parts of you interface.
1491 * This sets the state for the widget, either disabling it or
1496 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1499 * Get the disabled state of an Elementary object.
1501 * @param obj The Elementary object to operate on
1502 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1503 * if it's enabled (or on errors)
1505 * This gets the state of the widget, which might be enabled or disabled.
1509 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1512 * @defgroup WidgetNavigation Widget Tree Navigation.
1514 * How to check if an Evas Object is an Elementary widget? How to
1515 * get the first elementary widget that is parent of the given
1516 * object? These are all covered in widget tree navigation.
1518 * @ref general_functions_example_page "This" example contemplates
1519 * some of these functions.
1523 * Check if the given Evas Object is an Elementary widget.
1525 * @param obj the object to query.
1526 * @return @c EINA_TRUE if it is an elementary widget variant,
1527 * @c EINA_FALSE otherwise
1528 * @ingroup WidgetNavigation
1530 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1533 * Get the first parent of the given object that is an Elementary
1536 * @param obj the Elementary object to query parent from.
1537 * @return the parent object that is an Elementary widget, or @c
1538 * NULL, if it was not found.
1540 * Use this to query for an object's parent widget.
1542 * @note Most of Elementary users wouldn't be mixing non-Elementary
1543 * smart objects in the objects tree of an application, as this is
1544 * an advanced usage of Elementary with Evas. So, except for the
1545 * application's window, which is the root of that tree, all other
1546 * objects would have valid Elementary widget parents.
1548 * @ingroup WidgetNavigation
1550 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Get the top level parent of an Elementary widget.
1555 * @param obj The object to query.
1556 * @return The top level Elementary widget, or @c NULL if parent cannot be
1558 * @ingroup WidgetNavigation
1560 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * Get the string that represents this Elementary widget.
1565 * @note Elementary is weird and exposes itself as a single
1566 * Evas_Object_Smart_Class of type "elm_widget", so
1567 * evas_object_type_get() always return that, making debug and
1568 * language bindings hard. This function tries to mitigate this
1569 * problem, but the solution is to change Elementary to use
1570 * proper inheritance.
1572 * @param obj the object to query.
1573 * @return Elementary widget name, or @c NULL if not a valid widget.
1574 * @ingroup WidgetNavigation
1576 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 * @defgroup Config Elementary Config
1581 * Elementary configuration is formed by a set options bounded to a
1582 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1583 * "finger size", etc. These are functions with which one syncronizes
1584 * changes made to those values to the configuration storing files, de
1585 * facto. You most probably don't want to use the functions in this
1586 * group unlees you're writing an elementary configuration manager.
1592 * Save back Elementary's configuration, so that it will persist on
1595 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1598 * This function will take effect -- thus, do I/O -- immediately. Use
1599 * it when you want to apply all configuration changes at once. The
1600 * current configuration set will get saved onto the current profile
1601 * configuration file.
1604 EAPI Eina_Bool elm_config_save(void);
1607 * Reload Elementary's configuration, bounded to current selected
1610 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1613 * Useful when you want to force reloading of configuration values for
1614 * a profile. If one removes user custom configuration directories,
1615 * for example, it will force a reload with system values insted.
1618 EAPI void elm_config_reload(void);
1625 * @defgroup Profile Elementary Profile
1627 * Profiles are pre-set options that affect the whole look-and-feel of
1628 * Elementary-based applications. There are, for example, profiles
1629 * aimed at desktop computer applications and others aimed at mobile,
1630 * touchscreen-based ones. You most probably don't want to use the
1631 * functions in this group unlees you're writing an elementary
1632 * configuration manager.
1638 * Get Elementary's profile in use.
1640 * This gets the global profile that is applied to all Elementary
1643 * @return The profile's name
1646 EAPI const char *elm_profile_current_get(void);
1649 * Get an Elementary's profile directory path in the filesystem. One
1650 * may want to fetch a system profile's dir or an user one (fetched
1653 * @param profile The profile's name
1654 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1655 * or a system one (@c EINA_FALSE)
1656 * @return The profile's directory path.
1659 * @note You must free it with elm_profile_dir_free().
1661 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1664 * Free an Elementary's profile directory path, as returned by
1665 * elm_profile_dir_get().
1667 * @param p_dir The profile's path
1671 EAPI void elm_profile_dir_free(const char *p_dir);
1674 * Get Elementary's list of available profiles.
1676 * @return The profiles list. List node data are the profile name
1680 * @note One must free this list, after usage, with the function
1681 * elm_profile_list_free().
1683 EAPI Eina_List *elm_profile_list_get(void);
1686 * Free Elementary's list of available profiles.
1688 * @param l The profiles list, as returned by elm_profile_list_get().
1692 EAPI void elm_profile_list_free(Eina_List *l);
1695 * Set Elementary's profile.
1697 * This sets the global profile that is applied to Elementary
1698 * applications. Just the process the call comes from will be
1701 * @param profile The profile's name
1705 EAPI void elm_profile_set(const char *profile);
1708 * Set Elementary's profile.
1710 * This sets the global profile that is applied to all Elementary
1711 * applications. All running Elementary windows will be affected.
1713 * @param profile The profile's name
1717 EAPI void elm_profile_all_set(const char *profile);
1724 * @defgroup Engine Elementary Engine
1726 * These are functions setting and querying which rendering engine
1727 * Elementary will use for drawing its windows' pixels.
1729 * The following are the available engines:
1730 * @li "software_x11"
1733 * @li "software_16_x11"
1734 * @li "software_8_x11"
1737 * @li "software_gdi"
1738 * @li "software_16_wince_gdi"
1740 * @li "software_16_sdl"
1748 * @brief Get Elementary's rendering engine in use.
1750 * @return The rendering engine's name
1751 * @note there's no need to free the returned string, here.
1753 * This gets the global rendering engine that is applied to all Elementary
1756 * @see elm_engine_set()
1758 EAPI const char *elm_engine_current_get(void);
1761 * @brief Set Elementary's rendering engine for use.
1763 * @param engine The rendering engine's name
1765 * This sets global rendering engine that is applied to all Elementary
1766 * applications. Note that it will take effect only to Elementary windows
1767 * created after this is called.
1769 * @see elm_win_add()
1771 EAPI void elm_engine_set(const char *engine);
1778 * @defgroup Fonts Elementary Fonts
1780 * These are functions dealing with font rendering, selection and the
1781 * like for Elementary applications. One might fetch which system
1782 * fonts are there to use and set custom fonts for individual classes
1783 * of UI items containing text (text classes).
1788 typedef struct _Elm_Text_Class
1794 typedef struct _Elm_Font_Overlay
1796 const char *text_class;
1798 Evas_Font_Size size;
1801 typedef struct _Elm_Font_Properties
1805 } Elm_Font_Properties;
1808 * Get Elementary's list of supported text classes.
1810 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1813 * Release the list with elm_text_classes_list_free().
1815 EAPI const Eina_List *elm_text_classes_list_get(void);
1818 * Free Elementary's list of supported text classes.
1822 * @see elm_text_classes_list_get().
1824 EAPI void elm_text_classes_list_free(const Eina_List *list);
1827 * Get Elementary's list of font overlays, set with
1828 * elm_font_overlay_set().
1830 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1835 * For each text class, one can set a <b>font overlay</b> for it,
1836 * overriding the default font properties for that class coming from
1837 * the theme in use. There is no need to free this list.
1839 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1841 EAPI const Eina_List *elm_font_overlay_list_get(void);
1844 * Set a font overlay for a given Elementary text class.
1846 * @param text_class Text class name
1847 * @param font Font name and style string
1848 * @param size Font size
1852 * @p font has to be in the format returned by
1853 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1854 * and elm_font_overlay_unset().
1856 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1859 * Unset a font overlay for a given Elementary text class.
1861 * @param text_class Text class name
1865 * This will bring back text elements belonging to text class
1866 * @p text_class back to their default font settings.
1868 EAPI void elm_font_overlay_unset(const char *text_class);
1871 * Apply the changes made with elm_font_overlay_set() and
1872 * elm_font_overlay_unset() on the current Elementary window.
1876 * This applies all font overlays set to all objects in the UI.
1878 EAPI void elm_font_overlay_apply(void);
1881 * Apply the changes made with elm_font_overlay_set() and
1882 * elm_font_overlay_unset() on all Elementary application windows.
1886 * This applies all font overlays set to all objects in the UI.
1888 EAPI void elm_font_overlay_all_apply(void);
1891 * Translate a font (family) name string in fontconfig's font names
1892 * syntax into an @c Elm_Font_Properties struct.
1894 * @param font The font name and styles string
1895 * @return the font properties struct
1899 * @note The reverse translation can be achived with
1900 * elm_font_fontconfig_name_get(), for one style only (single font
1901 * instance, not family).
1903 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1906 * Free font properties return by elm_font_properties_get().
1908 * @param efp the font properties struct
1912 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1915 * Translate a font name, bound to a style, into fontconfig's font names
1918 * @param name The font (family) name
1919 * @param style The given style (may be @c NULL)
1921 * @return the font name and style string
1925 * @note The reverse translation can be achived with
1926 * elm_font_properties_get(), for one style only (single font
1927 * instance, not family).
1929 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1932 * Free the font string return by elm_font_fontconfig_name_get().
1934 * @param efp the font properties struct
1938 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1941 * Create a font hash table of available system fonts.
1943 * One must call it with @p list being the return value of
1944 * evas_font_available_list(). The hash will be indexed by font
1945 * (family) names, being its values @c Elm_Font_Properties blobs.
1947 * @param list The list of available system fonts, as returned by
1948 * evas_font_available_list().
1949 * @return the font hash.
1953 * @note The user is supposed to get it populated at least with 3
1954 * default font families (Sans, Serif, Monospace), which should be
1955 * present on most systems.
1957 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1960 * Free the hash return by elm_font_available_hash_add().
1962 * @param hash the hash to be freed.
1966 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1973 * @defgroup Fingers Fingers
1975 * Elementary is designed to be finger-friendly for touchscreens,
1976 * and so in addition to scaling for display resolution, it can
1977 * also scale based on finger "resolution" (or size). You can then
1978 * customize the granularity of the areas meant to receive clicks
1981 * Different profiles may have pre-set values for finger sizes.
1983 * @ref general_functions_example_page "This" example contemplates
1984 * some of these functions.
1990 * Get the configured "finger size"
1992 * @return The finger size
1994 * This gets the globally configured finger size, <b>in pixels</b>
1998 EAPI Evas_Coord elm_finger_size_get(void);
2001 * Set the configured finger size
2003 * This sets the globally configured finger size in pixels
2005 * @param size The finger size
2008 EAPI void elm_finger_size_set(Evas_Coord size);
2011 * Set the configured finger size for all applications on the display
2013 * This sets the globally configured finger size in pixels for all
2014 * applications on the display
2016 * @param size The finger size
2019 EAPI void elm_finger_size_all_set(Evas_Coord size);
2026 * @defgroup Focus Focus
2028 * An Elementary application has, at all times, one (and only one)
2029 * @b focused object. This is what determines where the input
2030 * events go to within the application's window. Also, focused
2031 * objects can be decorated differently, in order to signal to the
2032 * user where the input is, at a given moment.
2034 * Elementary applications also have the concept of <b>focus
2035 * chain</b>: one can cycle through all the windows' focusable
2036 * objects by input (tab key) or programmatically. The default
2037 * focus chain for an application is the one define by the order in
2038 * which the widgets where added in code. One will cycle through
2039 * top level widgets, and, for each one containg sub-objects, cycle
2040 * through them all, before returning to the level
2041 * above. Elementary also allows one to set @b custom focus chains
2042 * for their applications.
2044 * Besides the focused decoration a widget may exhibit, when it
2045 * gets focus, Elementary has a @b global focus highlight object
2046 * that can be enabled for a window. If one chooses to do so, this
2047 * extra highlight effect will surround the current focused object,
2050 * @note Some Elementary widgets are @b unfocusable, after
2051 * creation, by their very nature: they are not meant to be
2052 * interacted with input events, but are there just for visual
2055 * @ref general_functions_example_page "This" example contemplates
2056 * some of these functions.
2060 * Get the enable status of the focus highlight
2062 * This gets whether the highlight on focused objects is enabled or not
2065 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2068 * Set the enable status of the focus highlight
2070 * Set whether to show or not the highlight on focused objects
2071 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2074 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2077 * Get the enable status of the highlight animation
2079 * Get whether the focus highlight, if enabled, will animate its switch from
2080 * one object to the next
2083 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2086 * Set the enable status of the highlight animation
2088 * Set whether the focus highlight, if enabled, will animate its switch from
2089 * one object to the next
2090 * @param animate Enable animation if EINA_TRUE, disable otherwise
2093 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2096 * Get the whether an Elementary object has the focus or not.
2098 * @param obj The Elementary object to get the information from
2099 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2100 * not (and on errors).
2102 * @see elm_object_focus_set()
2106 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2109 * Set/unset focus to a given Elementary object.
2111 * @param obj The Elementary object to operate on.
2112 * @param enable @c EINA_TRUE Set focus to a given object,
2113 * @c EINA_FALSE Unset focus to a given object.
2115 * @note When you set focus to this object, if it can handle focus, will
2116 * take the focus away from the one who had it previously and will, for
2117 * now on, be the one receiving input events. Unsetting focus will remove
2118 * the focus from @p obj, passing it back to the previous element in the
2121 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2125 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2128 * Make a given Elementary object the focused one.
2130 * @param obj The Elementary object to make focused.
2132 * @note This object, if it can handle focus, will take the focus
2133 * away from the one who had it previously and will, for now on, be
2134 * the one receiving input events.
2136 * @see elm_object_focus_get()
2137 * @deprecated use elm_object_focus_set() instead.
2141 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2144 * Remove the focus from an Elementary object
2146 * @param obj The Elementary to take focus from
2148 * This removes the focus from @p obj, passing it back to the
2149 * previous element in the focus chain list.
2151 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2152 * @deprecated use elm_object_focus_set() instead.
2156 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2159 * Set the ability for an Element object to be focused
2161 * @param obj The Elementary object to operate on
2162 * @param enable @c EINA_TRUE if the object can be focused, @c
2163 * EINA_FALSE if not (and on errors)
2165 * This sets whether the object @p obj is able to take focus or
2166 * not. Unfocusable objects do nothing when programmatically
2167 * focused, being the nearest focusable parent object the one
2168 * really getting focus. Also, when they receive mouse input, they
2169 * will get the event, but not take away the focus from where it
2174 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2177 * Get whether an Elementary object is focusable or not
2179 * @param obj The Elementary object to operate on
2180 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2181 * EINA_FALSE if not (and on errors)
2183 * @note Objects which are meant to be interacted with by input
2184 * events are created able to be focused, by default. All the
2189 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * Set custom focus chain.
2194 * This function overwrites any previous custom focus chain within
2195 * the list of objects. The previous list will be deleted and this list
2196 * will be managed by elementary. After it is set, don't modify it.
2198 * @note On focus cycle, only will be evaluated children of this container.
2200 * @param obj The container object
2201 * @param objs Chain of objects to pass focus
2204 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2207 * Unset a custom focus chain on a given Elementary widget
2209 * @param obj The container object to remove focus chain from
2211 * Any focus chain previously set on @p obj (for its child objects)
2212 * is removed entirely after this call.
2216 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 * Get custom focus chain
2221 * @param obj The container object
2224 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2227 * Append object to custom focus chain.
2229 * @note If relative_child equal to NULL or not in custom chain, the object
2230 * will be added in end.
2232 * @note On focus cycle, only will be evaluated children of this container.
2234 * @param obj The container object
2235 * @param child The child to be added in custom chain
2236 * @param relative_child The relative object to position the child
2239 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2242 * Prepend object to custom focus chain.
2244 * @note If relative_child equal to NULL or not in custom chain, the object
2245 * will be added in begin.
2247 * @note On focus cycle, only will be evaluated children of this container.
2249 * @param obj The container object
2250 * @param child The child to be added in custom chain
2251 * @param relative_child The relative object to position the child
2254 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2257 * Give focus to next object in object tree.
2259 * Give focus to next object in focus chain of one object sub-tree.
2260 * If the last object of chain already have focus, the focus will go to the
2261 * first object of chain.
2263 * @param obj The object root of sub-tree
2264 * @param dir Direction to cycle the focus
2268 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2271 * Give focus to near object in one direction.
2273 * Give focus to near object in direction of one object.
2274 * If none focusable object in given direction, the focus will not change.
2276 * @param obj The reference object
2277 * @param x Horizontal component of direction to focus
2278 * @param y Vertical component of direction to focus
2282 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2285 * Make the elementary object and its children to be unfocusable
2288 * @param obj The Elementary object to operate on
2289 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2290 * @c EINA_FALSE for focusable.
2292 * This sets whether the object @p obj and its children objects
2293 * are able to take focus or not. If the tree is set as unfocusable,
2294 * newest focused object which is not in this tree will get focus.
2295 * This API can be helpful for an object to be deleted.
2296 * When an object will be deleted soon, it and its children may not
2297 * want to get focus (by focus reverting or by other focus controls).
2298 * Then, just use this API before deleting.
2300 * @see elm_object_tree_unfocusable_get()
2304 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2307 * Get whether an Elementary object and its children are unfocusable or not.
2309 * @param obj The Elementary object to get the information from
2310 * @return @c EINA_TRUE, if the tree is unfocussable,
2311 * @c EINA_FALSE if not (and on errors).
2313 * @see elm_object_tree_unfocusable_set()
2317 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2320 * @defgroup Scrolling Scrolling
2322 * These are functions setting how scrollable views in Elementary
2323 * widgets should behave on user interaction.
2329 * Get whether scrollers should bounce when they reach their
2330 * viewport's edge during a scroll.
2332 * @return the thumb scroll bouncing state
2334 * This is the default behavior for touch screens, in general.
2335 * @ingroup Scrolling
2337 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2340 * Set whether scrollers should bounce when they reach their
2341 * viewport's edge during a scroll.
2343 * @param enabled the thumb scroll bouncing state
2345 * @see elm_thumbscroll_bounce_enabled_get()
2346 * @ingroup Scrolling
2348 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2351 * Set whether scrollers should bounce when they reach their
2352 * viewport's edge during a scroll, for all Elementary application
2355 * @param enabled the thumb scroll bouncing state
2357 * @see elm_thumbscroll_bounce_enabled_get()
2358 * @ingroup Scrolling
2360 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2363 * Get the amount of inertia a scroller will impose at bounce
2366 * @return the thumb scroll bounce friction
2368 * @ingroup Scrolling
2370 EAPI double elm_scroll_bounce_friction_get(void);
2373 * Set the amount of inertia a scroller will impose at bounce
2376 * @param friction the thumb scroll bounce friction
2378 * @see elm_thumbscroll_bounce_friction_get()
2379 * @ingroup Scrolling
2381 EAPI void elm_scroll_bounce_friction_set(double friction);
2384 * Set the amount of inertia a scroller will impose at bounce
2385 * animations, for all Elementary application windows.
2387 * @param friction the thumb scroll bounce friction
2389 * @see elm_thumbscroll_bounce_friction_get()
2390 * @ingroup Scrolling
2392 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2395 * Get the amount of inertia a <b>paged</b> scroller will impose at
2396 * page fitting animations.
2398 * @return the page scroll friction
2400 * @ingroup Scrolling
2402 EAPI double elm_scroll_page_scroll_friction_get(void);
2405 * Set the amount of inertia a <b>paged</b> scroller will impose at
2406 * page fitting animations.
2408 * @param friction the page scroll friction
2410 * @see elm_thumbscroll_page_scroll_friction_get()
2411 * @ingroup Scrolling
2413 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2416 * Set the amount of inertia a <b>paged</b> scroller will impose at
2417 * page fitting animations, for all Elementary application windows.
2419 * @param friction the page scroll friction
2421 * @see elm_thumbscroll_page_scroll_friction_get()
2422 * @ingroup Scrolling
2424 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2427 * Get the amount of inertia a scroller will impose at region bring
2430 * @return the bring in scroll friction
2432 * @ingroup Scrolling
2434 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2437 * Set the amount of inertia a scroller will impose at region bring
2440 * @param friction the bring in scroll friction
2442 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2443 * @ingroup Scrolling
2445 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2448 * Set the amount of inertia a scroller will impose at region bring
2449 * animations, for all Elementary application windows.
2451 * @param friction the bring in scroll friction
2453 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2454 * @ingroup Scrolling
2456 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2459 * Get the amount of inertia scrollers will impose at animations
2460 * triggered by Elementary widgets' zooming API.
2462 * @return the zoom friction
2464 * @ingroup Scrolling
2466 EAPI double elm_scroll_zoom_friction_get(void);
2469 * Set the amount of inertia scrollers will impose at animations
2470 * triggered by Elementary widgets' zooming API.
2472 * @param friction the zoom friction
2474 * @see elm_thumbscroll_zoom_friction_get()
2475 * @ingroup Scrolling
2477 EAPI void elm_scroll_zoom_friction_set(double friction);
2480 * Set the amount of inertia scrollers will impose at animations
2481 * triggered by Elementary widgets' zooming API, for all Elementary
2482 * application windows.
2484 * @param friction the zoom friction
2486 * @see elm_thumbscroll_zoom_friction_get()
2487 * @ingroup Scrolling
2489 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2492 * Get whether scrollers should be draggable from any point in their
2495 * @return the thumb scroll state
2497 * @note This is the default behavior for touch screens, in general.
2498 * @note All other functions namespaced with "thumbscroll" will only
2499 * have effect if this mode is enabled.
2501 * @ingroup Scrolling
2503 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2506 * Set whether scrollers should be draggable from any point in their
2509 * @param enabled the thumb scroll state
2511 * @see elm_thumbscroll_enabled_get()
2512 * @ingroup Scrolling
2514 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2517 * Set whether scrollers should be draggable from any point in their
2518 * views, for all Elementary application windows.
2520 * @param enabled the thumb scroll state
2522 * @see elm_thumbscroll_enabled_get()
2523 * @ingroup Scrolling
2525 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2528 * Get the number of pixels one should travel while dragging a
2529 * scroller's view to actually trigger scrolling.
2531 * @return the thumb scroll threshould
2533 * One would use higher values for touch screens, in general, because
2534 * of their inherent imprecision.
2535 * @ingroup Scrolling
2537 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2540 * Set the number of pixels one should travel while dragging a
2541 * scroller's view to actually trigger scrolling.
2543 * @param threshold the thumb scroll threshould
2545 * @see elm_thumbscroll_threshould_get()
2546 * @ingroup Scrolling
2548 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2551 * Set the number of pixels one should travel while dragging a
2552 * scroller's view to actually trigger scrolling, for all Elementary
2553 * application windows.
2555 * @param threshold the thumb scroll threshould
2557 * @see elm_thumbscroll_threshould_get()
2558 * @ingroup Scrolling
2560 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2563 * Get the minimum speed of mouse cursor movement which will trigger
2564 * list self scrolling animation after a mouse up event
2567 * @return the thumb scroll momentum threshould
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2574 * Set the minimum speed of mouse cursor movement which will trigger
2575 * list self scrolling animation after a mouse up event
2578 * @param threshold the thumb scroll momentum threshould
2580 * @see elm_thumbscroll_momentum_threshould_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2586 * Set the minimum speed of mouse cursor movement which will trigger
2587 * list self scrolling animation after a mouse up event
2588 * (pixels/second), for all Elementary application windows.
2590 * @param threshold the thumb scroll momentum threshould
2592 * @see elm_thumbscroll_momentum_threshould_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2598 * Get the amount of inertia a scroller will impose at self scrolling
2601 * @return the thumb scroll friction
2603 * @ingroup Scrolling
2605 EAPI double elm_scroll_thumbscroll_friction_get(void);
2608 * Set the amount of inertia a scroller will impose at self scrolling
2611 * @param friction the thumb scroll friction
2613 * @see elm_thumbscroll_friction_get()
2614 * @ingroup Scrolling
2616 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2619 * Set the amount of inertia a scroller will impose at self scrolling
2620 * animations, for all Elementary application windows.
2622 * @param friction the thumb scroll friction
2624 * @see elm_thumbscroll_friction_get()
2625 * @ingroup Scrolling
2627 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2630 * Get the amount of lag between your actual mouse cursor dragging
2631 * movement and a scroller's view movement itself, while pushing it
2632 * into bounce state manually.
2634 * @return the thumb scroll border friction
2636 * @ingroup Scrolling
2638 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2641 * Set the amount of lag between your actual mouse cursor dragging
2642 * movement and a scroller's view movement itself, while pushing it
2643 * into bounce state manually.
2645 * @param friction the thumb scroll border friction. @c 0.0 for
2646 * perfect synchrony between two movements, @c 1.0 for maximum
2649 * @see elm_thumbscroll_border_friction_get()
2650 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2657 * Set the amount of lag between your actual mouse cursor dragging
2658 * movement and a scroller's view movement itself, while pushing it
2659 * into bounce state manually, for all Elementary application windows.
2661 * @param friction the thumb scroll border friction. @c 0.0 for
2662 * perfect synchrony between two movements, @c 1.0 for maximum
2665 * @see elm_thumbscroll_border_friction_get()
2666 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2668 * @ingroup Scrolling
2670 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2677 * @defgroup Scrollhints Scrollhints
2679 * Objects when inside a scroller can scroll, but this may not always be
2680 * desirable in certain situations. This allows an object to hint to itself
2681 * and parents to "not scroll" in one of 2 ways. If any child object of a
2682 * scroller has pushed a scroll freeze or hold then it affects all parent
2683 * scrollers until all children have released them.
2685 * 1. To hold on scrolling. This means just flicking and dragging may no
2686 * longer scroll, but pressing/dragging near an edge of the scroller will
2687 * still scroll. This is automatically used by the entry object when
2690 * 2. To totally freeze scrolling. This means it stops. until
2697 * Push the scroll hold by 1
2699 * This increments the scroll hold count by one. If it is more than 0 it will
2700 * take effect on the parents of the indicated object.
2702 * @param obj The object
2703 * @ingroup Scrollhints
2705 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 * Pop the scroll hold by 1
2710 * This decrements the scroll hold count by one. If it is more than 0 it will
2711 * take effect on the parents of the indicated object.
2713 * @param obj The object
2714 * @ingroup Scrollhints
2716 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719 * Push the scroll freeze by 1
2721 * This increments the scroll freeze count by one. If it is more
2722 * than 0 it will take effect on the parents of the indicated
2725 * @param obj The object
2726 * @ingroup Scrollhints
2728 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * Pop the scroll freeze by 1
2733 * This decrements the scroll freeze count by one. If it is more
2734 * than 0 it will take effect on the parents of the indicated
2737 * @param obj The object
2738 * @ingroup Scrollhints
2740 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2743 * Lock the scrolling of the given widget (and thus all parents)
2745 * This locks the given object from scrolling in the X axis (and implicitly
2746 * also locks all parent scrollers too from doing the same).
2748 * @param obj The object
2749 * @param lock The lock state (1 == locked, 0 == unlocked)
2750 * @ingroup Scrollhints
2752 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2755 * Lock the scrolling of the given widget (and thus all parents)
2757 * This locks the given object from scrolling in the Y axis (and implicitly
2758 * also locks all parent scrollers too from doing the same).
2760 * @param obj The object
2761 * @param lock The lock state (1 == locked, 0 == unlocked)
2762 * @ingroup Scrollhints
2764 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2767 * Get the scrolling lock of the given widget
2769 * This gets the lock for X axis scrolling.
2771 * @param obj The object
2772 * @ingroup Scrollhints
2774 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 * Get the scrolling lock of the given widget
2779 * This gets the lock for X axis scrolling.
2781 * @param obj The object
2782 * @ingroup Scrollhints
2784 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 * Send a signal to the widget edje object.
2793 * This function sends a signal to the edje object of the obj. An
2794 * edje program can respond to a signal by specifying matching
2795 * 'signal' and 'source' fields.
2797 * @param obj The object
2798 * @param emission The signal's name.
2799 * @param source The signal's source.
2802 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2805 * Add a callback for a signal emitted by widget edje object.
2807 * This function connects a callback function to a signal emitted by the
2808 * edje object of the obj.
2809 * Globs can occur in either the emission or source name.
2811 * @param obj The object
2812 * @param emission The signal's name.
2813 * @param source The signal's source.
2814 * @param func The callback function to be executed when the signal is
2816 * @param data A pointer to data to pass in to the callback function.
2819 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2822 * Remove a signal-triggered callback from a widget edje object.
2824 * This function removes a callback, previoulsy attached to a
2825 * signal emitted by the edje object of the obj. The parameters
2826 * emission, source and func must match exactly those passed to a
2827 * previous call to elm_object_signal_callback_add(). The data
2828 * pointer that was passed to this call will be returned.
2830 * @param obj The object
2831 * @param emission The signal's name.
2832 * @param source The signal's source.
2833 * @param func The callback function to be executed when the signal is
2835 * @return The data pointer
2838 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2841 * Add a callback for input events (key up, key down, mouse wheel)
2842 * on a given Elementary widget
2844 * @param obj The widget to add an event callback on
2845 * @param func The callback function to be executed when the event
2847 * @param data Data to pass in to @p func
2849 * Every widget in an Elementary interface set to receive focus,
2850 * with elm_object_focus_allow_set(), will propagate @b all of its
2851 * key up, key down and mouse wheel input events up to its parent
2852 * object, and so on. All of the focusable ones in this chain which
2853 * had an event callback set, with this call, will be able to treat
2854 * those events. There are two ways of making the propagation of
2855 * these event upwards in the tree of widgets to @b cease:
2856 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2857 * the event was @b not processed, so the propagation will go on.
2858 * - The @c event_info pointer passed to @p func will contain the
2859 * event's structure and, if you OR its @c event_flags inner
2860 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2861 * one has already handled it, thus killing the event's
2864 * @note Your event callback will be issued on those events taking
2865 * place only if no other child widget of @obj has consumed the
2868 * @note Not to be confused with @c
2869 * evas_object_event_callback_add(), which will add event callbacks
2870 * per type on general Evas objects (no event propagation
2871 * infrastructure taken in account).
2873 * @note Not to be confused with @c
2874 * elm_object_signal_callback_add(), which will add callbacks to @b
2875 * signals coming from a widget's theme, not input events.
2877 * @note Not to be confused with @c
2878 * edje_object_signal_callback_add(), which does the same as
2879 * elm_object_signal_callback_add(), but directly on an Edje
2882 * @note Not to be confused with @c
2883 * evas_object_smart_callback_add(), which adds callbacks to smart
2884 * objects' <b>smart events</b>, and not input events.
2886 * @see elm_object_event_callback_del()
2890 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2893 * Remove an event callback from a widget.
2895 * This function removes a callback, previoulsy attached to event emission
2897 * The parameters func and data must match exactly those passed to
2898 * a previous call to elm_object_event_callback_add(). The data pointer that
2899 * was passed to this call will be returned.
2901 * @param obj The object
2902 * @param func The callback function to be executed when the event is
2904 * @param data Data to pass in to the callback function.
2905 * @return The data pointer
2908 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2911 * Adjust size of an element for finger usage.
2913 * @param times_w How many fingers should fit horizontally
2914 * @param w Pointer to the width size to adjust
2915 * @param times_h How many fingers should fit vertically
2916 * @param h Pointer to the height size to adjust
2918 * This takes width and height sizes (in pixels) as input and a
2919 * size multiple (which is how many fingers you want to place
2920 * within the area, being "finger" the size set by
2921 * elm_finger_size_set()), and adjusts the size to be large enough
2922 * to accommodate the resulting size -- if it doesn't already
2923 * accommodate it. On return the @p w and @p h sizes pointed to by
2924 * these parameters will be modified, on those conditions.
2926 * @note This is kind of a low level Elementary call, most useful
2927 * on size evaluation times for widgets. An external user wouldn't
2928 * be calling, most of the time.
2932 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2935 * Get the duration for occuring long press event.
2937 * @return Timeout for long press event
2938 * @ingroup Longpress
2940 EAPI double elm_longpress_timeout_get(void);
2943 * Set the duration for occuring long press event.
2945 * @param lonpress_timeout Timeout for long press event
2946 * @ingroup Longpress
2948 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2951 * @defgroup Debug Debug
2952 * don't use it unless you are sure
2958 * Print Tree object hierarchy in stdout
2960 * @param obj The root object
2963 EAPI void elm_object_tree_dump(const Evas_Object *top);
2966 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2968 * @param obj The root object
2969 * @param file The path of output file
2972 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2979 * @defgroup Theme Theme
2981 * Elementary uses Edje to theme its widgets, naturally. But for the most
2982 * part this is hidden behind a simpler interface that lets the user set
2983 * extensions and choose the style of widgets in a much easier way.
2985 * Instead of thinking in terms of paths to Edje files and their groups
2986 * each time you want to change the appearance of a widget, Elementary
2987 * works so you can add any theme file with extensions or replace the
2988 * main theme at one point in the application, and then just set the style
2989 * of widgets with elm_object_style_set() and related functions. Elementary
2990 * will then look in its list of themes for a matching group and apply it,
2991 * and when the theme changes midway through the application, all widgets
2992 * will be updated accordingly.
2994 * There are three concepts you need to know to understand how Elementary
2995 * theming works: default theme, extensions and overlays.
2997 * Default theme, obviously enough, is the one that provides the default
2998 * look of all widgets. End users can change the theme used by Elementary
2999 * by setting the @c ELM_THEME environment variable before running an
3000 * application, or globally for all programs using the @c elementary_config
3001 * utility. Applications can change the default theme using elm_theme_set(),
3002 * but this can go against the user wishes, so it's not an adviced practice.
3004 * Ideally, applications should find everything they need in the already
3005 * provided theme, but there may be occasions when that's not enough and
3006 * custom styles are required to correctly express the idea. For this
3007 * cases, Elementary has extensions.
3009 * Extensions allow the application developer to write styles of its own
3010 * to apply to some widgets. This requires knowledge of how each widget
3011 * is themed, as extensions will always replace the entire group used by
3012 * the widget, so important signals and parts need to be there for the
3013 * object to behave properly (see documentation of Edje for details).
3014 * Once the theme for the extension is done, the application needs to add
3015 * it to the list of themes Elementary will look into, using
3016 * elm_theme_extension_add(), and set the style of the desired widgets as
3017 * he would normally with elm_object_style_set().
3019 * Overlays, on the other hand, can replace the look of all widgets by
3020 * overriding the default style. Like extensions, it's up to the application
3021 * developer to write the theme for the widgets it wants, the difference
3022 * being that when looking for the theme, Elementary will check first the
3023 * list of overlays, then the set theme and lastly the list of extensions,
3024 * so with overlays it's possible to replace the default view and every
3025 * widget will be affected. This is very much alike to setting the whole
3026 * theme for the application and will probably clash with the end user
3027 * options, not to mention the risk of ending up with not matching styles
3028 * across the program. Unless there's a very special reason to use them,
3029 * overlays should be avoided for the resons exposed before.
3031 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3032 * keeps one default internally and every function that receives one of
3033 * these can be called with NULL to refer to this default (except for
3034 * elm_theme_free()). It's possible to create a new instance of a
3035 * ::Elm_Theme to set other theme for a specific widget (and all of its
3036 * children), but this is as discouraged, if not even more so, than using
3037 * overlays. Don't use this unless you really know what you are doing.
3039 * But to be less negative about things, you can look at the following
3041 * @li @ref theme_example_01 "Using extensions"
3042 * @li @ref theme_example_02 "Using overlays"
3047 * @typedef Elm_Theme
3049 * Opaque handler for the list of themes Elementary looks for when
3050 * rendering widgets.
3052 * Stay out of this unless you really know what you are doing. For most
3053 * cases, sticking to the default is all a developer needs.
3055 typedef struct _Elm_Theme Elm_Theme;
3058 * Create a new specific theme
3060 * This creates an empty specific theme that only uses the default theme. A
3061 * specific theme has its own private set of extensions and overlays too
3062 * (which are empty by default). Specific themes do not fall back to themes
3063 * of parent objects. They are not intended for this use. Use styles, overlays
3064 * and extensions when needed, but avoid specific themes unless there is no
3065 * other way (example: you want to have a preview of a new theme you are
3066 * selecting in a "theme selector" window. The preview is inside a scroller
3067 * and should display what the theme you selected will look like, but not
3068 * actually apply it yet. The child of the scroller will have a specific
3069 * theme set to show this preview before the user decides to apply it to all
3072 EAPI Elm_Theme *elm_theme_new(void);
3074 * Free a specific theme
3076 * @param th The theme to free
3078 * This frees a theme created with elm_theme_new().
3080 EAPI void elm_theme_free(Elm_Theme *th);
3082 * Copy the theme fom the source to the destination theme
3084 * @param th The source theme to copy from
3085 * @param thdst The destination theme to copy data to
3087 * This makes a one-time static copy of all the theme config, extensions
3088 * and overlays from @p th to @p thdst. If @p th references a theme, then
3089 * @p thdst is also set to reference it, with all the theme settings,
3090 * overlays and extensions that @p th had.
3092 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3094 * Tell the source theme to reference the ref theme
3096 * @param th The theme that will do the referencing
3097 * @param thref The theme that is the reference source
3099 * This clears @p th to be empty and then sets it to refer to @p thref
3100 * so @p th acts as an override to @p thref, but where its overrides
3101 * don't apply, it will fall through to @p thref for configuration.
3103 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3105 * Return the theme referred to
3107 * @param th The theme to get the reference from
3108 * @return The referenced theme handle
3110 * This gets the theme set as the reference theme by elm_theme_ref_set().
3111 * If no theme is set as a reference, NULL is returned.
3113 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3115 * Return the default theme
3117 * @return The default theme handle
3119 * This returns the internal default theme setup handle that all widgets
3120 * use implicitly unless a specific theme is set. This is also often use
3121 * as a shorthand of NULL.
3123 EAPI Elm_Theme *elm_theme_default_get(void);
3125 * Prepends a theme overlay to the list of overlays
3127 * @param th The theme to add to, or if NULL, the default theme
3128 * @param item The Edje file path to be used
3130 * Use this if your application needs to provide some custom overlay theme
3131 * (An Edje file that replaces some default styles of widgets) where adding
3132 * new styles, or changing system theme configuration is not possible. Do
3133 * NOT use this instead of a proper system theme configuration. Use proper
3134 * configuration files, profiles, environment variables etc. to set a theme
3135 * so that the theme can be altered by simple confiugration by a user. Using
3136 * this call to achieve that effect is abusing the API and will create lots
3139 * @see elm_theme_extension_add()
3141 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3143 * Delete a theme overlay from the list of overlays
3145 * @param th The theme to delete from, or if NULL, the default theme
3146 * @param item The name of the theme overlay
3148 * @see elm_theme_overlay_add()
3150 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3152 * Appends a theme extension to the list of extensions.
3154 * @param th The theme to add to, or if NULL, the default theme
3155 * @param item The Edje file path to be used
3157 * This is intended when an application needs more styles of widgets or new
3158 * widget themes that the default does not provide (or may not provide). The
3159 * application has "extended" usage by coming up with new custom style names
3160 * for widgets for specific uses, but as these are not "standard", they are
3161 * not guaranteed to be provided by a default theme. This means the
3162 * application is required to provide these extra elements itself in specific
3163 * Edje files. This call adds one of those Edje files to the theme search
3164 * path to be search after the default theme. The use of this call is
3165 * encouraged when default styles do not meet the needs of the application.
3166 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3168 * @see elm_object_style_set()
3170 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3172 * Deletes a theme extension from the list of extensions.
3174 * @param th The theme to delete from, or if NULL, the default theme
3175 * @param item The name of the theme extension
3177 * @see elm_theme_extension_add()
3179 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3181 * Set the theme search order for the given theme
3183 * @param th The theme to set the search order, or if NULL, the default theme
3184 * @param theme Theme search string
3186 * This sets the search string for the theme in path-notation from first
3187 * theme to search, to last, delimited by the : character. Example:
3189 * "shiny:/path/to/file.edj:default"
3191 * See the ELM_THEME environment variable for more information.
3193 * @see elm_theme_get()
3194 * @see elm_theme_list_get()
3196 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3198 * Return the theme search order
3200 * @param th The theme to get the search order, or if NULL, the default theme
3201 * @return The internal search order path
3203 * This function returns a colon separated string of theme elements as
3204 * returned by elm_theme_list_get().
3206 * @see elm_theme_set()
3207 * @see elm_theme_list_get()
3209 EAPI const char *elm_theme_get(Elm_Theme *th);
3211 * Return a list of theme elements to be used in a theme.
3213 * @param th Theme to get the list of theme elements from.
3214 * @return The internal list of theme elements
3216 * This returns the internal list of theme elements (will only be valid as
3217 * long as the theme is not modified by elm_theme_set() or theme is not
3218 * freed by elm_theme_free(). This is a list of strings which must not be
3219 * altered as they are also internal. If @p th is NULL, then the default
3220 * theme element list is returned.
3222 * A theme element can consist of a full or relative path to a .edj file,
3223 * or a name, without extension, for a theme to be searched in the known
3224 * theme paths for Elemementary.
3226 * @see elm_theme_set()
3227 * @see elm_theme_get()
3229 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3231 * Return the full patrh for a theme element
3233 * @param f The theme element name
3234 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3235 * @return The full path to the file found.
3237 * This returns a string you should free with free() on success, NULL on
3238 * failure. This will search for the given theme element, and if it is a
3239 * full or relative path element or a simple searchable name. The returned
3240 * path is the full path to the file, if searched, and the file exists, or it
3241 * is simply the full path given in the element or a resolved path if
3242 * relative to home. The @p in_search_path boolean pointed to is set to
3243 * EINA_TRUE if the file was a searchable file andis in the search path,
3244 * and EINA_FALSE otherwise.
3246 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3248 * Flush the current theme.
3250 * @param th Theme to flush
3252 * This flushes caches that let elementary know where to find theme elements
3253 * in the given theme. If @p th is NULL, then the default theme is flushed.
3254 * Call this function if source theme data has changed in such a way as to
3255 * make any caches Elementary kept invalid.
3257 EAPI void elm_theme_flush(Elm_Theme *th);
3259 * This flushes all themes (default and specific ones).
3261 * This will flush all themes in the current application context, by calling
3262 * elm_theme_flush() on each of them.
3264 EAPI void elm_theme_full_flush(void);
3266 * Set the theme for all elementary using applications on the current display
3268 * @param theme The name of the theme to use. Format same as the ELM_THEME
3269 * environment variable.
3271 EAPI void elm_theme_all_set(const char *theme);
3273 * Return a list of theme elements in the theme search path
3275 * @return A list of strings that are the theme element names.
3277 * This lists all available theme files in the standard Elementary search path
3278 * for theme elements, and returns them in alphabetical order as theme
3279 * element names in a list of strings. Free this with
3280 * elm_theme_name_available_list_free() when you are done with the list.
3282 EAPI Eina_List *elm_theme_name_available_list_new(void);
3284 * Free the list returned by elm_theme_name_available_list_new()
3286 * This frees the list of themes returned by
3287 * elm_theme_name_available_list_new(). Once freed the list should no longer
3288 * be used. a new list mys be created.
3290 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3292 * Set a specific theme to be used for this object and its children
3294 * @param obj The object to set the theme on
3295 * @param th The theme to set
3297 * This sets a specific theme that will be used for the given object and any
3298 * child objects it has. If @p th is NULL then the theme to be used is
3299 * cleared and the object will inherit its theme from its parent (which
3300 * ultimately will use the default theme if no specific themes are set).
3302 * Use special themes with great care as this will annoy users and make
3303 * configuration difficult. Avoid any custom themes at all if it can be
3306 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3308 * Get the specific theme to be used
3310 * @param obj The object to get the specific theme from
3311 * @return The specifc theme set.
3313 * This will return a specific theme set, or NULL if no specific theme is
3314 * set on that object. It will not return inherited themes from parents, only
3315 * the specific theme set for that specific object. See elm_object_theme_set()
3316 * for more information.
3318 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3324 /** @defgroup Win Win
3326 * @image html img/widget/win/preview-00.png
3327 * @image latex img/widget/win/preview-00.eps
3329 * The window class of Elementary. Contains functions to manipulate
3330 * windows. The Evas engine used to render the window contents is specified
3331 * in the system or user elementary config files (whichever is found last),
3332 * and can be overridden with the ELM_ENGINE environment variable for
3333 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3334 * compilation setup and modules actually installed at runtime) are (listed
3335 * in order of best supported and most likely to be complete and work to
3338 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3339 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3341 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3343 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3345 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3347 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3348 * rendering using SDL as the buffer)
3349 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3350 * GDI with software)
3351 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3352 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3353 * grayscale using dedicated 8bit software engine in X11)
3354 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3355 * X11 using 16bit software engine)
3356 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3357 * (Windows CE rendering via GDI with 16bit software renderer)
3358 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3359 * buffer with 16bit software renderer)
3361 * All engines use a simple string to select the engine to render, EXCEPT
3362 * the "shot" engine. This actually encodes the output of the virtual
3363 * screenshot and how long to delay in the engine string. The engine string
3364 * is encoded in the following way:
3366 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3368 * Where options are separated by a ":" char if more than one option is
3369 * given, with delay, if provided being the first option and file the last
3370 * (order is important). The delay specifies how long to wait after the
3371 * window is shown before doing the virtual "in memory" rendering and then
3372 * save the output to the file specified by the file option (and then exit).
3373 * If no delay is given, the default is 0.5 seconds. If no file is given the
3374 * default output file is "out.png". Repeat option is for continous
3375 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3376 * fixed to "out001.png" Some examples of using the shot engine:
3378 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3379 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3380 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3381 * ELM_ENGINE="shot:delay=2.0" elementary_test
3382 * ELM_ENGINE="shot:" elementary_test
3384 * Signals that you can add callbacks for are:
3386 * @li "delete,request": the user requested to close the window. See
3387 * elm_win_autodel_set().
3388 * @li "focus,in": window got focus
3389 * @li "focus,out": window lost focus
3390 * @li "moved": window that holds the canvas was moved
3393 * @li @ref win_example_01
3398 * Defines the types of window that can be created
3400 * These are hints set on the window so that a running Window Manager knows
3401 * how the window should be handled and/or what kind of decorations it
3404 * Currently, only the X11 backed engines use them.
3406 typedef enum _Elm_Win_Type
3408 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3409 window. Almost every window will be created with this
3411 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3412 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3413 window holding desktop icons. */
3414 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3415 be kept on top of any other window by the Window
3417 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3419 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3420 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3422 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3423 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3424 entry in a menubar is clicked. Typically used
3425 with elm_win_override_set(). This hint exists
3426 for completion only, as the EFL way of
3427 implementing a menu would not normally use a
3428 separate window for its contents. */
3429 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3430 triggered by right-clicking an object. */
3431 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3432 explanatory text that typically appear after the
3433 mouse cursor hovers over an object for a while.
3434 Typically used with elm_win_override_set() and also
3435 not very commonly used in the EFL. */
3436 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3437 battery life or a new E-Mail received. */
3438 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3439 usually used in the EFL. */
3440 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3441 object being dragged across different windows, or even
3442 applications. Typically used with
3443 elm_win_override_set(). */
3444 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3445 buffer. No actual window is created for this
3446 type, instead the window and all of its
3447 contents will be rendered to an image buffer.
3448 This allows to have children window inside a
3449 parent one just like any other object would
3450 be, and do other things like applying @c
3451 Evas_Map effects to it. This is the only type
3452 of window that requires the @c parent
3453 parameter of elm_win_add() to be a valid @c
3458 * The differents layouts that can be requested for the virtual keyboard.
3460 * When the application window is being managed by Illume, it may request
3461 * any of the following layouts for the virtual keyboard.
3463 typedef enum _Elm_Win_Keyboard_Mode
3465 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3466 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3467 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3468 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3469 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3470 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3471 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3472 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3473 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3474 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3475 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3476 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3477 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3478 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3479 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3480 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3481 } Elm_Win_Keyboard_Mode;
3484 * Available commands that can be sent to the Illume manager.
3486 * When running under an Illume session, a window may send commands to the
3487 * Illume manager to perform different actions.
3489 typedef enum _Elm_Illume_Command
3491 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3493 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3495 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3497 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3498 } Elm_Illume_Command;
3501 * Adds a window object. If this is the first window created, pass NULL as
3504 * @param parent Parent object to add the window to, or NULL
3505 * @param name The name of the window
3506 * @param type The window type, one of #Elm_Win_Type.
3508 * The @p parent paramter can be @c NULL for every window @p type except
3509 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3510 * which the image object will be created.
3512 * @return The created object, or NULL on failure
3514 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3516 * Add @p subobj as a resize object of window @p obj.
3519 * Setting an object as a resize object of the window means that the
3520 * @p subobj child's size and position will be controlled by the window
3521 * directly. That is, the object will be resized to match the window size
3522 * and should never be moved or resized manually by the developer.
3524 * In addition, resize objects of the window control what the minimum size
3525 * of it will be, as well as whether it can or not be resized by the user.
3527 * For the end user to be able to resize a window by dragging the handles
3528 * or borders provided by the Window Manager, or using any other similar
3529 * mechanism, all of the resize objects in the window should have their
3530 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3532 * @param obj The window object
3533 * @param subobj The resize object to add
3535 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3537 * Delete @p subobj as a resize object of window @p obj.
3539 * This function removes the object @p subobj from the resize objects of
3540 * the window @p obj. It will not delete the object itself, which will be
3541 * left unmanaged and should be deleted by the developer, manually handled
3542 * or set as child of some other container.
3544 * @param obj The window object
3545 * @param subobj The resize object to add
3547 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3549 * Set the title of the window
3551 * @param obj The window object
3552 * @param title The title to set
3554 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3556 * Get the title of the window
3558 * The returned string is an internal one and should not be freed or
3559 * modified. It will also be rendered invalid if a new title is set or if
3560 * the window is destroyed.
3562 * @param obj The window object
3565 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567 * Set the window's autodel state.
3569 * When closing the window in any way outside of the program control, like
3570 * pressing the X button in the titlebar or using a command from the
3571 * Window Manager, a "delete,request" signal is emitted to indicate that
3572 * this event occurred and the developer can take any action, which may
3573 * include, or not, destroying the window object.
3575 * When the @p autodel parameter is set, the window will be automatically
3576 * destroyed when this event occurs, after the signal is emitted.
3577 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3578 * and is up to the program to do so when it's required.
3580 * @param obj The window object
3581 * @param autodel If true, the window will automatically delete itself when
3584 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3586 * Get the window's autodel state.
3588 * @param obj The window object
3589 * @return If the window will automatically delete itself when closed
3591 * @see elm_win_autodel_set()
3593 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3595 * Activate a window object.
3597 * This function sends a request to the Window Manager to activate the
3598 * window pointed by @p obj. If honored by the WM, the window will receive
3599 * the keyboard focus.
3601 * @note This is just a request that a Window Manager may ignore, so calling
3602 * this function does not ensure in any way that the window will be the
3603 * active one after it.
3605 * @param obj The window object
3607 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3609 * Lower a window object.
3611 * Places the window pointed by @p obj at the bottom of the stack, so that
3612 * no other window is covered by it.
3614 * If elm_win_override_set() is not set, the Window Manager may ignore this
3617 * @param obj The window object
3619 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3621 * Raise a window object.
3623 * Places the window pointed by @p obj at the top of the stack, so that it's
3624 * not covered by any other window.
3626 * If elm_win_override_set() is not set, the Window Manager may ignore this
3629 * @param obj The window object
3631 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3633 * Set the borderless state of a window.
3635 * This function requests the Window Manager to not draw any decoration
3636 * around the window.
3638 * @param obj The window object
3639 * @param borderless If true, the window is borderless
3641 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3643 * Get the borderless state of a window.
3645 * @param obj The window object
3646 * @return If true, the window is borderless
3648 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3650 * Set the shaped state of a window.
3652 * Shaped windows, when supported, will render the parts of the window that
3653 * has no content, transparent.
3655 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3656 * background object or cover the entire window in any other way, or the
3657 * parts of the canvas that have no data will show framebuffer artifacts.
3659 * @param obj The window object
3660 * @param shaped If true, the window is shaped
3662 * @see elm_win_alpha_set()
3664 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3666 * Get the shaped state of a window.
3668 * @param obj The window object
3669 * @return If true, the window is shaped
3671 * @see elm_win_shaped_set()
3673 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3675 * Set the alpha channel state of a window.
3677 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3678 * possibly making parts of the window completely or partially transparent.
3679 * This is also subject to the underlying system supporting it, like for
3680 * example, running under a compositing manager. If no compositing is
3681 * available, enabling this option will instead fallback to using shaped
3682 * windows, with elm_win_shaped_set().
3684 * @param obj The window object
3685 * @param alpha If true, the window has an alpha channel
3687 * @see elm_win_alpha_set()
3689 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3691 * Get the transparency state of a window.
3693 * @param obj The window object
3694 * @return If true, the window is transparent
3696 * @see elm_win_transparent_set()
3698 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 * Set the transparency state of a window.
3702 * Use elm_win_alpha_set() instead.
3704 * @param obj The window object
3705 * @param transparent If true, the window is transparent
3707 * @see elm_win_alpha_set()
3709 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3711 * Get the alpha channel state of a window.
3713 * @param obj The window object
3714 * @return If true, the window has an alpha channel
3716 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718 * Set the override state of a window.
3720 * A window with @p override set to EINA_TRUE will not be managed by the
3721 * Window Manager. This means that no decorations of any kind will be shown
3722 * for it, moving and resizing must be handled by the application, as well
3723 * as the window visibility.
3725 * This should not be used for normal windows, and even for not so normal
3726 * ones, it should only be used when there's a good reason and with a lot
3727 * of care. Mishandling override windows may result situations that
3728 * disrupt the normal workflow of the end user.
3730 * @param obj The window object
3731 * @param override If true, the window is overridden
3733 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3735 * Get the override state of a window.
3737 * @param obj The window object
3738 * @return If true, the window is overridden
3740 * @see elm_win_override_set()
3742 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 * Set the fullscreen state of a window.
3746 * @param obj The window object
3747 * @param fullscreen If true, the window is fullscreen
3749 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3751 * Get the fullscreen state of a window.
3753 * @param obj The window object
3754 * @return If true, the window is fullscreen
3756 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3758 * Set the maximized state of a window.
3760 * @param obj The window object
3761 * @param maximized If true, the window is maximized
3763 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3765 * Get the maximized state of a window.
3767 * @param obj The window object
3768 * @return If true, the window is maximized
3770 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 * Set the iconified state of a window.
3774 * @param obj The window object
3775 * @param iconified If true, the window is iconified
3777 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3779 * Get the iconified state of a window.
3781 * @param obj The window object
3782 * @return If true, the window is iconified
3784 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 * Set the layer of the window.
3788 * What this means exactly will depend on the underlying engine used.
3790 * In the case of X11 backed engines, the value in @p layer has the
3791 * following meanings:
3792 * @li < 3: The window will be placed below all others.
3793 * @li > 5: The window will be placed above all others.
3794 * @li other: The window will be placed in the default layer.
3796 * @param obj The window object
3797 * @param layer The layer of the window
3799 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3801 * Get the layer of the window.
3803 * @param obj The window object
3804 * @return The layer of the window
3806 * @see elm_win_layer_set()
3808 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810 * Set the rotation of the window.
3812 * Most engines only work with multiples of 90.
3814 * This function is used to set the orientation of the window @p obj to
3815 * match that of the screen. The window itself will be resized to adjust
3816 * to the new geometry of its contents. If you want to keep the window size,
3817 * see elm_win_rotation_with_resize_set().
3819 * @param obj The window object
3820 * @param rotation The rotation of the window, in degrees (0-360),
3821 * counter-clockwise.
3823 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3825 * Rotates the window and resizes it.
3827 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3828 * that they fit inside the current window geometry.
3830 * @param obj The window object
3831 * @param layer The rotation of the window in degrees (0-360),
3832 * counter-clockwise.
3834 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3836 * Get the rotation of the window.
3838 * @param obj The window object
3839 * @return The rotation of the window in degrees (0-360)
3841 * @see elm_win_rotation_set()
3842 * @see elm_win_rotation_with_resize_set()
3844 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3846 * Set the sticky state of the window.
3848 * Hints the Window Manager that the window in @p obj should be left fixed
3849 * at its position even when the virtual desktop it's on moves or changes.
3851 * @param obj The window object
3852 * @param sticky If true, the window's sticky state is enabled
3854 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3856 * Get the sticky state of the window.
3858 * @param obj The window object
3859 * @return If true, the window's sticky state is enabled
3861 * @see elm_win_sticky_set()
3863 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3865 * Set if this window is an illume conformant window
3867 * @param obj The window object
3868 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3870 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3872 * Get if this window is an illume conformant window
3874 * @param obj The window object
3875 * @return A boolean if this window is illume conformant or not
3877 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879 * Set a window to be an illume quickpanel window
3881 * By default window objects are not quickpanel windows.
3883 * @param obj The window object
3884 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3886 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3888 * Get if this window is a quickpanel or not
3890 * @param obj The window object
3891 * @return A boolean if this window is a quickpanel or not
3893 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895 * Set the major priority of a quickpanel window
3897 * @param obj The window object
3898 * @param priority The major priority for this quickpanel
3900 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3902 * Get the major priority of a quickpanel window
3904 * @param obj The window object
3905 * @return The major priority of this quickpanel
3907 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909 * Set the minor priority of a quickpanel window
3911 * @param obj The window object
3912 * @param priority The minor priority for this quickpanel
3914 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3916 * Get the minor priority of a quickpanel window
3918 * @param obj The window object
3919 * @return The minor priority of this quickpanel
3921 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923 * Set which zone this quickpanel should appear in
3925 * @param obj The window object
3926 * @param zone The requested zone for this quickpanel
3928 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3930 * Get which zone this quickpanel should appear in
3932 * @param obj The window object
3933 * @return The requested zone for this quickpanel
3935 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Set the window to be skipped by keyboard focus
3939 * This sets the window to be skipped by normal keyboard input. This means
3940 * a window manager will be asked to not focus this window as well as omit
3941 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3943 * Call this and enable it on a window BEFORE you show it for the first time,
3944 * otherwise it may have no effect.
3946 * Use this for windows that have only output information or might only be
3947 * interacted with by the mouse or fingers, and never for typing input.
3948 * Be careful that this may have side-effects like making the window
3949 * non-accessible in some cases unless the window is specially handled. Use
3952 * @param obj The window object
3953 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3955 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3957 * Send a command to the windowing environment
3959 * This is intended to work in touchscreen or small screen device
3960 * environments where there is a more simplistic window management policy in
3961 * place. This uses the window object indicated to select which part of the
3962 * environment to control (the part that this window lives in), and provides
3963 * a command and an optional parameter structure (use NULL for this if not
3966 * @param obj The window object that lives in the environment to control
3967 * @param command The command to send
3968 * @param params Optional parameters for the command
3970 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3972 * Get the inlined image object handle
3974 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3975 * then the window is in fact an evas image object inlined in the parent
3976 * canvas. You can get this object (be careful to not manipulate it as it
3977 * is under control of elementary), and use it to do things like get pixel
3978 * data, save the image to a file, etc.
3980 * @param obj The window object to get the inlined image from
3981 * @return The inlined image object, or NULL if none exists
3983 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3985 * Set the enabled status for the focus highlight in a window
3987 * This function will enable or disable the focus highlight only for the
3988 * given window, regardless of the global setting for it
3990 * @param obj The window where to enable the highlight
3991 * @param enabled The enabled value for the highlight
3993 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3995 * Get the enabled value of the focus highlight for this window
3997 * @param obj The window in which to check if the focus highlight is enabled
3999 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4001 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4003 * Set the style for the focus highlight on this window
4005 * Sets the style to use for theming the highlight of focused objects on
4006 * the given window. If @p style is NULL, the default will be used.
4008 * @param obj The window where to set the style
4009 * @param style The style to set
4011 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4013 * Get the style set for the focus highlight object
4015 * Gets the style set for this windows highilght object, or NULL if none
4018 * @param obj The window to retrieve the highlights style from
4020 * @return The style set or NULL if none was. Default is used in that case.
4022 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4024 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4025 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4026 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4027 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4028 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4029 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4030 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4032 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4033 * (blank mouse, private mouse obj, defaultmouse)
4037 * Sets the keyboard mode of the window.
4039 * @param obj The window object
4040 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4042 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4044 * Gets the keyboard mode of the window.
4046 * @param obj The window object
4047 * @return The mode, one of #Elm_Win_Keyboard_Mode
4049 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 * Sets whether the window is a keyboard.
4053 * @param obj The window object
4054 * @param is_keyboard If true, the window is a virtual keyboard
4056 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4058 * Gets whether the window is a keyboard.
4060 * @param obj The window object
4061 * @return If the window is a virtual keyboard
4063 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4066 * Get the screen position of a window.
4068 * @param obj The window object
4069 * @param x The int to store the x coordinate to
4070 * @param y The int to store the y coordinate to
4072 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4078 * @defgroup Inwin Inwin
4080 * @image html img/widget/inwin/preview-00.png
4081 * @image latex img/widget/inwin/preview-00.eps
4082 * @image html img/widget/inwin/preview-01.png
4083 * @image latex img/widget/inwin/preview-01.eps
4084 * @image html img/widget/inwin/preview-02.png
4085 * @image latex img/widget/inwin/preview-02.eps
4087 * An inwin is a window inside a window that is useful for a quick popup.
4088 * It does not hover.
4090 * It works by creating an object that will occupy the entire window, so it
4091 * must be created using an @ref Win "elm_win" as parent only. The inwin
4092 * object can be hidden or restacked below every other object if it's
4093 * needed to show what's behind it without destroying it. If this is done,
4094 * the elm_win_inwin_activate() function can be used to bring it back to
4095 * full visibility again.
4097 * There are three styles available in the default theme. These are:
4098 * @li default: The inwin is sized to take over most of the window it's
4100 * @li minimal: The size of the inwin will be the minimum necessary to show
4102 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4103 * possible, but it's sized vertically the most it needs to fit its\
4106 * Some examples of Inwin can be found in the following:
4107 * @li @ref inwin_example_01
4112 * Adds an inwin to the current window
4114 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4115 * Never call this function with anything other than the top-most window
4116 * as its parameter, unless you are fond of undefined behavior.
4118 * After creating the object, the widget will set itself as resize object
4119 * for the window with elm_win_resize_object_add(), so when shown it will
4120 * appear to cover almost the entire window (how much of it depends on its
4121 * content and the style used). It must not be added into other container
4122 * objects and it needs not be moved or resized manually.
4124 * @param parent The parent object
4125 * @return The new object or NULL if it cannot be created
4127 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4129 * Activates an inwin object, ensuring its visibility
4131 * This function will make sure that the inwin @p obj is completely visible
4132 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4133 * to the front. It also sets the keyboard focus to it, which will be passed
4136 * The object's theme will also receive the signal "elm,action,show" with
4139 * @param obj The inwin to activate
4141 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Set the content of an inwin object.
4145 * Once the content object is set, a previously set one will be deleted.
4146 * If you want to keep that old content object, use the
4147 * elm_win_inwin_content_unset() function.
4149 * @param obj The inwin object
4150 * @param content The object to set as content
4152 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4154 * Get the content of an inwin object.
4156 * Return the content object which is set for this widget.
4158 * The returned object is valid as long as the inwin is still alive and no
4159 * other content is set on it. Deleting the object will notify the inwin
4160 * about it and this one will be left empty.
4162 * If you need to remove an inwin's content to be reused somewhere else,
4163 * see elm_win_inwin_content_unset().
4165 * @param obj The inwin object
4166 * @return The content that is being used
4168 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4170 * Unset the content of an inwin object.
4172 * Unparent and return the content object which was set for this widget.
4174 * @param obj The inwin object
4175 * @return The content that was being used
4177 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4181 /* X specific calls - won't work on non-x engines (return 0) */
4184 * Get the Ecore_X_Window of an Evas_Object
4186 * @param obj The object
4188 * @return The Ecore_X_Window of @p obj
4192 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4194 /* smart callbacks called:
4195 * "delete,request" - the user requested to delete the window
4196 * "focus,in" - window got focus
4197 * "focus,out" - window lost focus
4198 * "moved" - window that holds the canvas was moved
4204 * @image html img/widget/bg/preview-00.png
4205 * @image latex img/widget/bg/preview-00.eps
4207 * @brief Background object, used for setting a solid color, image or Edje
4208 * group as background to a window or any container object.
4210 * The bg object is used for setting a solid background to a window or
4211 * packing into any container object. It works just like an image, but has
4212 * some properties useful to a background, like setting it to tiled,
4213 * centered, scaled or stretched.
4215 * Here is some sample code using it:
4216 * @li @ref bg_01_example_page
4217 * @li @ref bg_02_example_page
4218 * @li @ref bg_03_example_page
4222 typedef enum _Elm_Bg_Option
4224 ELM_BG_OPTION_CENTER, /**< center the background */
4225 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4226 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4227 ELM_BG_OPTION_TILE /**< tile background at its original size */
4231 * Add a new background to the parent
4233 * @param parent The parent object
4234 * @return The new object or NULL if it cannot be created
4238 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4241 * Set the file (image or edje) used for the background
4243 * @param obj The bg object
4244 * @param file The file path
4245 * @param group Optional key (group in Edje) within the file
4247 * This sets the image file used in the background object. The image (or edje)
4248 * will be stretched (retaining aspect if its an image file) to completely fill
4249 * the bg object. This may mean some parts are not visible.
4251 * @note Once the image of @p obj is set, a previously set one will be deleted,
4252 * even if @p file is NULL.
4256 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4259 * Get the file (image or edje) used for the background
4261 * @param obj The bg object
4262 * @param file The file path
4263 * @param group Optional key (group in Edje) within the file
4267 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4270 * Set the option used for the background image
4272 * @param obj The bg object
4273 * @param option The desired background option (TILE, SCALE)
4275 * This sets the option used for manipulating the display of the background
4276 * image. The image can be tiled or scaled.
4280 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4283 * Get the option used for the background image
4285 * @param obj The bg object
4286 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4290 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 * Set the option used for the background color
4294 * @param obj The bg object
4299 * This sets the color used for the background rectangle. Its range goes
4304 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4306 * Get the option used for the background color
4308 * @param obj The bg object
4315 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4318 * Set the overlay object used for the background object.
4320 * @param obj The bg object
4321 * @param overlay The overlay object
4323 * This provides a way for elm_bg to have an 'overlay' that will be on top
4324 * of the bg. Once the over object is set, a previously set one will be
4325 * deleted, even if you set the new one to NULL. If you want to keep that
4326 * old content object, use the elm_bg_overlay_unset() function.
4331 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4334 * Get the overlay object used for the background object.
4336 * @param obj The bg object
4337 * @return The content that is being used
4339 * Return the content object which is set for this widget
4343 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4346 * Get the overlay object used for the background object.
4348 * @param obj The bg object
4349 * @return The content that was being used
4351 * Unparent and return the overlay object which was set for this widget
4355 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4358 * Set the size of the pixmap representation of the image.
4360 * This option just makes sense if an image is going to be set in the bg.
4362 * @param obj The bg object
4363 * @param w The new width of the image pixmap representation.
4364 * @param h The new height of the image pixmap representation.
4366 * This function sets a new size for pixmap representation of the given bg
4367 * image. It allows the image to be loaded already in the specified size,
4368 * reducing the memory usage and load time when loading a big image with load
4369 * size set to a smaller size.
4371 * NOTE: this is just a hint, the real size of the pixmap may differ
4372 * depending on the type of image being loaded, being bigger than requested.
4376 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4377 /* smart callbacks called:
4381 * @defgroup Icon Icon
4383 * @image html img/widget/icon/preview-00.png
4384 * @image latex img/widget/icon/preview-00.eps
4386 * An object that provides standard icon images (delete, edit, arrows, etc.)
4387 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4389 * The icon image requested can be in the elementary theme, or in the
4390 * freedesktop.org paths. It's possible to set the order of preference from
4391 * where the image will be used.
4393 * This API is very similar to @ref Image, but with ready to use images.
4395 * Default images provided by the theme are described below.
4397 * The first list contains icons that were first intended to be used in
4398 * toolbars, but can be used in many other places too:
4414 * Now some icons that were designed to be used in menus (but again, you can
4415 * use them anywhere else):
4420 * @li menu/arrow_down
4421 * @li menu/arrow_left
4422 * @li menu/arrow_right
4431 * And here we have some media player specific icons:
4432 * @li media_player/forward
4433 * @li media_player/info
4434 * @li media_player/next
4435 * @li media_player/pause
4436 * @li media_player/play
4437 * @li media_player/prev
4438 * @li media_player/rewind
4439 * @li media_player/stop
4441 * Signals that you can add callbacks for are:
4443 * "clicked" - This is called when a user has clicked the icon
4445 * An example of usage for this API follows:
4446 * @li @ref tutorial_icon
4454 typedef enum _Elm_Icon_Type
4461 * @enum _Elm_Icon_Lookup_Order
4462 * @typedef Elm_Icon_Lookup_Order
4464 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4465 * theme, FDO paths, or both?
4469 typedef enum _Elm_Icon_Lookup_Order
4471 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4472 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4473 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4474 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4475 } Elm_Icon_Lookup_Order;
4478 * Add a new icon object to the parent.
4480 * @param parent The parent object
4481 * @return The new object or NULL if it cannot be created
4483 * @see elm_icon_file_set()
4487 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4489 * Set the file that will be used as icon.
4491 * @param obj The icon object
4492 * @param file The path to file that will be used as icon image
4493 * @param group The group that the icon belongs to in edje file
4495 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4497 * @note The icon image set by this function can be changed by
4498 * elm_icon_standard_set().
4500 * @see elm_icon_file_get()
4504 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4506 * Set a location in memory to be used as an icon
4508 * @param obj The icon object
4509 * @param img The binary data that will be used as an image
4510 * @param size The size of binary data @p img
4511 * @param format Optional format of @p img to pass to the image loader
4512 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4514 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4516 * @note The icon image set by this function can be changed by
4517 * elm_icon_standard_set().
4521 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);
4523 * Get the file that will be used as icon.
4525 * @param obj The icon object
4526 * @param file The path to file that will be used as icon icon image
4527 * @param group The group that the icon belongs to in edje file
4529 * @see elm_icon_file_set()
4533 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4534 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4536 * Set the icon by icon standards names.
4538 * @param obj The icon object
4539 * @param name The icon name
4541 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4543 * For example, freedesktop.org defines standard icon names such as "home",
4544 * "network", etc. There can be different icon sets to match those icon
4545 * keys. The @p name given as parameter is one of these "keys", and will be
4546 * used to look in the freedesktop.org paths and elementary theme. One can
4547 * change the lookup order with elm_icon_order_lookup_set().
4549 * If name is not found in any of the expected locations and it is the
4550 * absolute path of an image file, this image will be used.
4552 * @note The icon image set by this function can be changed by
4553 * elm_icon_file_set().
4555 * @see elm_icon_standard_get()
4556 * @see elm_icon_file_set()
4560 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4562 * Get the icon name set by icon standard names.
4564 * @param obj The icon object
4565 * @return The icon name
4567 * If the icon image was set using elm_icon_file_set() instead of
4568 * elm_icon_standard_set(), then this function will return @c NULL.
4570 * @see elm_icon_standard_set()
4574 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set the smooth effect for an icon object.
4578 * @param obj The icon object
4579 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4580 * otherwise. Default is @c EINA_TRUE.
4582 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4583 * scaling provides a better resulting image, but is slower.
4585 * The smooth scaling should be disabled when making animations that change
4586 * the icon size, since they will be faster. Animations that don't require
4587 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4588 * is already scaled, since the scaled icon image will be cached).
4590 * @see elm_icon_smooth_get()
4594 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4596 * Get the smooth effect for an icon object.
4598 * @param obj The icon object
4599 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4601 * @see elm_icon_smooth_set()
4605 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4607 * Disable scaling of this object.
4609 * @param obj The icon object.
4610 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4611 * otherwise. Default is @c EINA_FALSE.
4613 * This function disables scaling of the icon object through the function
4614 * elm_object_scale_set(). However, this does not affect the object
4615 * size/resize in any way. For that effect, take a look at
4616 * elm_icon_scale_set().
4618 * @see elm_icon_no_scale_get()
4619 * @see elm_icon_scale_set()
4620 * @see elm_object_scale_set()
4624 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4626 * Get whether scaling is disabled on the object.
4628 * @param obj The icon object
4629 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4631 * @see elm_icon_no_scale_set()
4635 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637 * Set if the object is (up/down) resizable.
4639 * @param obj The icon object
4640 * @param scale_up A bool to set if the object is resizable up. Default is
4642 * @param scale_down A bool to set if the object is resizable down. Default
4645 * This function limits the icon object resize ability. If @p scale_up is set to
4646 * @c EINA_FALSE, the object can't have its height or width resized to a value
4647 * higher than the original icon size. Same is valid for @p scale_down.
4649 * @see elm_icon_scale_get()
4653 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4655 * Get if the object is (up/down) resizable.
4657 * @param obj The icon object
4658 * @param scale_up A bool to set if the object is resizable up
4659 * @param scale_down A bool to set if the object is resizable down
4661 * @see elm_icon_scale_set()
4665 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4667 * Get the object's image size
4669 * @param obj The icon object
4670 * @param w A pointer to store the width in
4671 * @param h A pointer to store the height in
4675 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4677 * Set if the icon fill the entire object area.
4679 * @param obj The icon object
4680 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4681 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4683 * When the icon object is resized to a different aspect ratio from the
4684 * original icon image, the icon image will still keep its aspect. This flag
4685 * tells how the image should fill the object's area. They are: keep the
4686 * entire icon inside the limits of height and width of the object (@p
4687 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4688 * of the object, and the icon will fill the entire object (@p fill_outside
4691 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4692 * retain property to false. Thus, the icon image will always keep its
4693 * original aspect ratio.
4695 * @see elm_icon_fill_outside_get()
4696 * @see elm_image_fill_outside_set()
4700 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4702 * Get if the object is filled outside.
4704 * @param obj The icon object
4705 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4707 * @see elm_icon_fill_outside_set()
4711 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4713 * Set the prescale size for the icon.
4715 * @param obj The icon object
4716 * @param size The prescale size. This value is used for both width and
4719 * This function sets a new size for pixmap representation of the given
4720 * icon. It allows the icon to be loaded already in the specified size,
4721 * reducing the memory usage and load time when loading a big icon with load
4722 * size set to a smaller size.
4724 * It's equivalent to the elm_bg_load_size_set() function for bg.
4726 * @note this is just a hint, the real size of the pixmap may differ
4727 * depending on the type of icon being loaded, being bigger than requested.
4729 * @see elm_icon_prescale_get()
4730 * @see elm_bg_load_size_set()
4734 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4736 * Get the prescale size for the icon.
4738 * @param obj The icon object
4739 * @return The prescale size
4741 * @see elm_icon_prescale_set()
4745 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4747 * Sets the icon lookup order used by elm_icon_standard_set().
4749 * @param obj The icon object
4750 * @param order The icon lookup order (can be one of
4751 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4752 * or ELM_ICON_LOOKUP_THEME)
4754 * @see elm_icon_order_lookup_get()
4755 * @see Elm_Icon_Lookup_Order
4759 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4761 * Gets the icon lookup order.
4763 * @param obj The icon object
4764 * @return The icon lookup order
4766 * @see elm_icon_order_lookup_set()
4767 * @see Elm_Icon_Lookup_Order
4771 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4773 * Get if the icon supports animation or not.
4775 * @param obj The icon object
4776 * @return @c EINA_TRUE if the icon supports animation,
4777 * @c EINA_FALSE otherwise.
4779 * Return if this elm icon's image can be animated. Currently Evas only
4780 * supports gif animation. If the return value is EINA_FALSE, other
4781 * elm_icon_animated_XXX APIs won't work.
4784 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4786 * Set animation mode of the icon.
4788 * @param obj The icon object
4789 * @param anim @c EINA_TRUE if the object do animation job,
4790 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4792 * Even though elm icon's file can be animated,
4793 * sometimes appication developer want to just first page of image.
4794 * In that time, don't call this function, because default value is EINA_FALSE
4795 * Only when you want icon support anition,
4796 * use this function and set animated to EINA_TURE
4799 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4801 * Get animation mode of the icon.
4803 * @param obj The icon object
4804 * @return The animation mode of the icon object
4805 * @see elm_icon_animated_set
4808 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810 * Set animation play mode of the icon.
4812 * @param obj The icon object
4813 * @param play @c EINA_TRUE the object play animation images,
4814 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4816 * If you want to play elm icon's animation, you set play to EINA_TURE.
4817 * For example, you make gif player using this set/get API and click event.
4819 * 1. Click event occurs
4820 * 2. Check play flag using elm_icon_animaged_play_get
4821 * 3. If elm icon was playing, set play to EINA_FALSE.
4822 * Then animation will be stopped and vice versa
4825 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4827 * Get animation play mode of the icon.
4829 * @param obj The icon object
4830 * @return The play mode of the icon object
4832 * @see elm_icon_animated_lay_get
4835 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4842 * @defgroup Image Image
4844 * @image html img/widget/image/preview-00.png
4845 * @image latex img/widget/image/preview-00.eps
4848 * An object that allows one to load an image file to it. It can be used
4849 * anywhere like any other elementary widget.
4851 * This widget provides most of the functionality provided from @ref Bg or @ref
4852 * Icon, but with a slightly different API (use the one that fits better your
4855 * The features not provided by those two other image widgets are:
4856 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4857 * @li change the object orientation with elm_image_orient_set();
4858 * @li and turning the image editable with elm_image_editable_set().
4860 * Signals that you can add callbacks for are:
4862 * @li @c "clicked" - This is called when a user has clicked the image
4864 * An example of usage for this API follows:
4865 * @li @ref tutorial_image
4874 * @enum _Elm_Image_Orient
4875 * @typedef Elm_Image_Orient
4877 * Possible orientation options for elm_image_orient_set().
4879 * @image html elm_image_orient_set.png
4880 * @image latex elm_image_orient_set.eps width=\textwidth
4884 typedef enum _Elm_Image_Orient
4886 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4887 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4888 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4889 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4890 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4891 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4892 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4893 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4897 * Add a new image to the parent.
4899 * @param parent The parent object
4900 * @return The new object or NULL if it cannot be created
4902 * @see elm_image_file_set()
4906 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4908 * Set the file that will be used as image.
4910 * @param obj The image object
4911 * @param file The path to file that will be used as image
4912 * @param group The group that the image belongs in edje file (if it's an
4915 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4917 * @see elm_image_file_get()
4921 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4923 * Get the file that will be used as image.
4925 * @param obj The image object
4926 * @param file The path to file
4927 * @param group The group that the image belongs in edje file
4929 * @see elm_image_file_set()
4933 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4935 * Set the smooth effect for an image.
4937 * @param obj The image object
4938 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4939 * otherwise. Default is @c EINA_TRUE.
4941 * Set the scaling algorithm to be used when scaling the image. Smooth
4942 * scaling provides a better resulting image, but is slower.
4944 * The smooth scaling should be disabled when making animations that change
4945 * the image size, since it will be faster. Animations that don't require
4946 * resizing of the image can keep the smooth scaling enabled (even if the
4947 * image is already scaled, since the scaled image will be cached).
4949 * @see elm_image_smooth_get()
4953 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4955 * Get the smooth effect for an image.
4957 * @param obj The image object
4958 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4960 * @see elm_image_smooth_get()
4964 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4966 * Gets the current size of the image.
4968 * @param obj The image object.
4969 * @param w Pointer to store width, or NULL.
4970 * @param h Pointer to store height, or NULL.
4972 * This is the real size of the image, not the size of the object.
4974 * On error, neither w or h will be written.
4978 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4980 * Disable scaling of this object.
4982 * @param obj The image object.
4983 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4984 * otherwise. Default is @c EINA_FALSE.
4986 * This function disables scaling of the elm_image widget through the
4987 * function elm_object_scale_set(). However, this does not affect the widget
4988 * size/resize in any way. For that effect, take a look at
4989 * elm_image_scale_set().
4991 * @see elm_image_no_scale_get()
4992 * @see elm_image_scale_set()
4993 * @see elm_object_scale_set()
4997 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4999 * Get whether scaling is disabled on the object.
5001 * @param obj The image object
5002 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5004 * @see elm_image_no_scale_set()
5008 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5010 * Set if the object is (up/down) resizable.
5012 * @param obj The image object
5013 * @param scale_up A bool to set if the object is resizable up. Default is
5015 * @param scale_down A bool to set if the object is resizable down. Default
5018 * This function limits the image resize ability. If @p scale_up is set to
5019 * @c EINA_FALSE, the object can't have its height or width resized to a value
5020 * higher than the original image size. Same is valid for @p scale_down.
5022 * @see elm_image_scale_get()
5026 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5028 * Get if the object is (up/down) resizable.
5030 * @param obj The image object
5031 * @param scale_up A bool to set if the object is resizable up
5032 * @param scale_down A bool to set if the object is resizable down
5034 * @see elm_image_scale_set()
5038 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5040 * Set if the image fill the entire object area when keeping the aspect ratio.
5042 * @param obj The image object
5043 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5044 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5046 * When the image should keep its aspect ratio even if resized to another
5047 * aspect ratio, there are two possibilities to resize it: keep the entire
5048 * image inside the limits of height and width of the object (@p fill_outside
5049 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5050 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5052 * @note This option will have no effect if
5053 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5055 * @see elm_image_fill_outside_get()
5056 * @see elm_image_aspect_ratio_retained_set()
5060 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5062 * Get if the object is filled outside
5064 * @param obj The image object
5065 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5067 * @see elm_image_fill_outside_set()
5071 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 * Set the prescale size for the image
5075 * @param obj The image object
5076 * @param size The prescale size. This value is used for both width and
5079 * This function sets a new size for pixmap representation of the given
5080 * image. It allows the image to be loaded already in the specified size,
5081 * reducing the memory usage and load time when loading a big image with load
5082 * size set to a smaller size.
5084 * It's equivalent to the elm_bg_load_size_set() function for bg.
5086 * @note this is just a hint, the real size of the pixmap may differ
5087 * depending on the type of image being loaded, being bigger than requested.
5089 * @see elm_image_prescale_get()
5090 * @see elm_bg_load_size_set()
5094 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5096 * Get the prescale size for the image
5098 * @param obj The image object
5099 * @return The prescale size
5101 * @see elm_image_prescale_set()
5105 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5107 * Set the image orientation.
5109 * @param obj The image object
5110 * @param orient The image orientation
5111 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5112 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5113 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5114 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5115 * Default is #ELM_IMAGE_ORIENT_NONE.
5117 * This function allows to rotate or flip the given image.
5119 * @see elm_image_orient_get()
5120 * @see @ref Elm_Image_Orient
5124 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5126 * Get the image orientation.
5128 * @param obj The image object
5129 * @return The image orientation
5130 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5131 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5132 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5133 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5135 * @see elm_image_orient_set()
5136 * @see @ref Elm_Image_Orient
5140 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 * Make the image 'editable'.
5144 * @param obj Image object.
5145 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5147 * This means the image is a valid drag target for drag and drop, and can be
5148 * cut or pasted too.
5152 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5154 * Make the image 'editable'.
5156 * @param obj Image object.
5157 * @return Editability.
5159 * This means the image is a valid drag target for drag and drop, and can be
5160 * cut or pasted too.
5164 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166 * Get the basic Evas_Image object from this object (widget).
5168 * @param obj The image object to get the inlined image from
5169 * @return The inlined image object, or NULL if none exists
5171 * This function allows one to get the underlying @c Evas_Object of type
5172 * Image from this elementary widget. It can be useful to do things like get
5173 * the pixel data, save the image to a file, etc.
5175 * @note Be careful to not manipulate it, as it is under control of
5180 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5182 * Set whether the original aspect ratio of the image should be kept on resize.
5184 * @param obj The image object.
5185 * @param retained @c EINA_TRUE if the image should retain the aspect,
5186 * @c EINA_FALSE otherwise.
5188 * The original aspect ratio (width / height) of the image is usually
5189 * distorted to match the object's size. Enabling this option will retain
5190 * this original aspect, and the way that the image is fit into the object's
5191 * area depends on the option set by elm_image_fill_outside_set().
5193 * @see elm_image_aspect_ratio_retained_get()
5194 * @see elm_image_fill_outside_set()
5198 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5200 * Get if the object retains the original aspect ratio.
5202 * @param obj The image object.
5203 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5208 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 /* smart callbacks called:
5211 * "clicked" - the user clicked the image
5219 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5221 typedef enum _Elm_GLView_Mode
5223 ELM_GLVIEW_ALPHA = 1,
5224 ELM_GLVIEW_DEPTH = 2,
5225 ELM_GLVIEW_STENCIL = 4
5229 * Defines a policy for the glview resizing.
5231 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5233 typedef enum _Elm_GLView_Resize_Policy
5235 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5236 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5237 } Elm_GLView_Resize_Policy;
5239 typedef enum _Elm_GLView_Render_Policy
5241 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5242 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5243 } Elm_GLView_Render_Policy;
5248 * A simple GLView widget that allows GL rendering.
5250 * Signals that you can add callbacks for are:
5256 * Add a new glview to the parent
5258 * @param parent The parent object
5259 * @return The new object or NULL if it cannot be created
5263 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5266 * Sets the size of the glview
5268 * @param obj The glview object
5269 * @param width width of the glview object
5270 * @param height height of the glview object
5274 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5277 * Gets the size of the glview.
5279 * @param obj The glview object
5280 * @param width width of the glview object
5281 * @param height height of the glview object
5283 * Note that this function returns the actual image size of the
5284 * glview. This means that when the scale policy is set to
5285 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5290 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5293 * Gets the gl api struct for gl rendering
5295 * @param obj The glview object
5296 * @return The api object or NULL if it cannot be created
5300 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5303 * Set the mode of the GLView. Supports Three simple modes.
5305 * @param obj The glview object
5306 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5307 * @return True if set properly.
5311 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5314 * Set the resize policy for the glview object.
5316 * @param obj The glview object.
5317 * @param policy The scaling policy.
5319 * By default, the resize policy is set to
5320 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5321 * destroys the previous surface and recreates the newly specified
5322 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5323 * however, glview only scales the image object and not the underlying
5328 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5331 * Set the render policy for the glview object.
5333 * @param obj The glview object.
5334 * @param policy The render policy.
5336 * By default, the render policy is set to
5337 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5338 * that during the render loop, glview is only redrawn if it needs
5339 * to be redrawn. (i.e. When it is visible) If the policy is set to
5340 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5341 * whether it is visible/need redrawing or not.
5345 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5348 * Set the init function that runs once in the main loop.
5350 * @param obj The glview object.
5351 * @param func The init function to be registered.
5353 * The registered init function gets called once during the render loop.
5357 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5360 * Set the render function that runs in the main loop.
5362 * @param obj The glview object.
5363 * @param func The delete function to be registered.
5365 * The registered del function gets called when GLView object is deleted.
5369 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5372 * Set the resize function that gets called when resize happens.
5374 * @param obj The glview object.
5375 * @param func The resize function to be registered.
5379 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5382 * Set the render function that runs in the main loop.
5384 * @param obj The glview object.
5385 * @param func The render function to be registered.
5389 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5392 * Notifies that there has been changes in the GLView.
5394 * @param obj The glview object.
5398 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5408 * @image html img/widget/box/preview-00.png
5409 * @image latex img/widget/box/preview-00.eps width=\textwidth
5411 * @image html img/box.png
5412 * @image latex img/box.eps width=\textwidth
5414 * A box arranges objects in a linear fashion, governed by a layout function
5415 * that defines the details of this arrangement.
5417 * By default, the box will use an internal function to set the layout to
5418 * a single row, either vertical or horizontal. This layout is affected
5419 * by a number of parameters, such as the homogeneous flag set by
5420 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5421 * elm_box_align_set() and the hints set to each object in the box.
5423 * For this default layout, it's possible to change the orientation with
5424 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5425 * placing its elements ordered from top to bottom. When horizontal is set,
5426 * the order will go from left to right. If the box is set to be
5427 * homogeneous, every object in it will be assigned the same space, that
5428 * of the largest object. Padding can be used to set some spacing between
5429 * the cell given to each object. The alignment of the box, set with
5430 * elm_box_align_set(), determines how the bounding box of all the elements
5431 * will be placed within the space given to the box widget itself.
5433 * The size hints of each object also affect how they are placed and sized
5434 * within the box. evas_object_size_hint_min_set() will give the minimum
5435 * size the object can have, and the box will use it as the basis for all
5436 * latter calculations. Elementary widgets set their own minimum size as
5437 * needed, so there's rarely any need to use it manually.
5439 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5440 * used to tell whether the object will be allocated the minimum size it
5441 * needs or if the space given to it should be expanded. It's important
5442 * to realize that expanding the size given to the object is not the same
5443 * thing as resizing the object. It could very well end being a small
5444 * widget floating in a much larger empty space. If not set, the weight
5445 * for objects will normally be 0.0 for both axis, meaning the widget will
5446 * not be expanded. To take as much space possible, set the weight to
5447 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5449 * Besides how much space each object is allocated, it's possible to control
5450 * how the widget will be placed within that space using
5451 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5452 * for both axis, meaning the object will be centered, but any value from
5453 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5454 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5455 * is -1.0, means the object will be resized to fill the entire space it
5458 * In addition, customized functions to define the layout can be set, which
5459 * allow the application developer to organize the objects within the box
5460 * in any number of ways.
5462 * The special elm_box_layout_transition() function can be used
5463 * to switch from one layout to another, animating the motion of the
5464 * children of the box.
5466 * @note Objects should not be added to box objects using _add() calls.
5468 * Some examples on how to use boxes follow:
5469 * @li @ref box_example_01
5470 * @li @ref box_example_02
5475 * @typedef Elm_Box_Transition
5477 * Opaque handler containing the parameters to perform an animated
5478 * transition of the layout the box uses.
5480 * @see elm_box_transition_new()
5481 * @see elm_box_layout_set()
5482 * @see elm_box_layout_transition()
5484 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5487 * Add a new box to the parent
5489 * By default, the box will be in vertical mode and non-homogeneous.
5491 * @param parent The parent object
5492 * @return The new object or NULL if it cannot be created
5494 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5496 * Set the horizontal orientation
5498 * By default, box object arranges their contents vertically from top to
5500 * By calling this function with @p horizontal as EINA_TRUE, the box will
5501 * become horizontal, arranging contents from left to right.
5503 * @note This flag is ignored if a custom layout function is set.
5505 * @param obj The box object
5506 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5507 * EINA_FALSE = vertical)
5509 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5511 * Get the horizontal orientation
5513 * @param obj The box object
5514 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5516 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5518 * Set the box to arrange its children homogeneously
5520 * If enabled, homogeneous layout makes all items the same size, according
5521 * to the size of the largest of its children.
5523 * @note This flag is ignored if a custom layout function is set.
5525 * @param obj The box object
5526 * @param homogeneous The homogeneous flag
5528 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5530 * Get whether the box is using homogeneous mode or not
5532 * @param obj The box object
5533 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5535 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5536 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5537 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5539 * Add an object to the beginning of the pack list
5541 * Pack @p subobj into the box @p obj, placing it first in the list of
5542 * children objects. The actual position the object will get on screen
5543 * depends on the layout used. If no custom layout is set, it will be at
5544 * the top or left, depending if the box is vertical or horizontal,
5547 * @param obj The box object
5548 * @param subobj The object to add to the box
5550 * @see elm_box_pack_end()
5551 * @see elm_box_pack_before()
5552 * @see elm_box_pack_after()
5553 * @see elm_box_unpack()
5554 * @see elm_box_unpack_all()
5555 * @see elm_box_clear()
5557 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5559 * Add an object at the end of the pack list
5561 * Pack @p subobj into the box @p obj, placing it last in the list of
5562 * children objects. The actual position the object will get on screen
5563 * depends on the layout used. If no custom layout is set, it will be at
5564 * the bottom or right, depending if the box is vertical or horizontal,
5567 * @param obj The box object
5568 * @param subobj The object to add to the box
5570 * @see elm_box_pack_start()
5571 * @see elm_box_pack_before()
5572 * @see elm_box_pack_after()
5573 * @see elm_box_unpack()
5574 * @see elm_box_unpack_all()
5575 * @see elm_box_clear()
5577 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5579 * Adds an object to the box before the indicated object
5581 * This will add the @p subobj to the box indicated before the object
5582 * indicated with @p before. If @p before is not already in the box, results
5583 * are undefined. Before means either to the left of the indicated object or
5584 * above it depending on orientation.
5586 * @param obj The box object
5587 * @param subobj The object to add to the box
5588 * @param before The object before which to add it
5590 * @see elm_box_pack_start()
5591 * @see elm_box_pack_end()
5592 * @see elm_box_pack_after()
5593 * @see elm_box_unpack()
5594 * @see elm_box_unpack_all()
5595 * @see elm_box_clear()
5597 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5599 * Adds an object to the box after the indicated object
5601 * This will add the @p subobj to the box indicated after the object
5602 * indicated with @p after. If @p after is not already in the box, results
5603 * are undefined. After means either to the right of the indicated object or
5604 * below it depending on orientation.
5606 * @param obj The box object
5607 * @param subobj The object to add to the box
5608 * @param after The object after which to add it
5610 * @see elm_box_pack_start()
5611 * @see elm_box_pack_end()
5612 * @see elm_box_pack_before()
5613 * @see elm_box_unpack()
5614 * @see elm_box_unpack_all()
5615 * @see elm_box_clear()
5617 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5619 * Clear the box of all children
5621 * Remove all the elements contained by the box, deleting the respective
5624 * @param obj The box object
5626 * @see elm_box_unpack()
5627 * @see elm_box_unpack_all()
5629 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5633 * Remove the object given by @p subobj from the box @p obj without
5636 * @param obj The box object
5638 * @see elm_box_unpack_all()
5639 * @see elm_box_clear()
5641 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5643 * Remove all items from the box, without deleting them
5645 * Clear the box from all children, but don't delete the respective objects.
5646 * If no other references of the box children exist, the objects will never
5647 * be deleted, and thus the application will leak the memory. Make sure
5648 * when using this function that you hold a reference to all the objects
5649 * in the box @p obj.
5651 * @param obj The box object
5653 * @see elm_box_clear()
5654 * @see elm_box_unpack()
5656 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5658 * Retrieve a list of the objects packed into the box
5660 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5661 * The order of the list corresponds to the packing order the box uses.
5663 * You must free this list with eina_list_free() once you are done with it.
5665 * @param obj The box object
5667 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669 * Set the space (padding) between the box's elements.
5671 * Extra space in pixels that will be added between a box child and its
5672 * neighbors after its containing cell has been calculated. This padding
5673 * is set for all elements in the box, besides any possible padding that
5674 * individual elements may have through their size hints.
5676 * @param obj The box object
5677 * @param horizontal The horizontal space between elements
5678 * @param vertical The vertical space between elements
5680 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5682 * Get the space (padding) between the box's elements.
5684 * @param obj The box object
5685 * @param horizontal The horizontal space between elements
5686 * @param vertical The vertical space between elements
5688 * @see elm_box_padding_set()
5690 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5692 * Set the alignment of the whole bouding box of contents.
5694 * Sets how the bounding box containing all the elements of the box, after
5695 * their sizes and position has been calculated, will be aligned within
5696 * the space given for the whole box widget.
5698 * @param obj The box object
5699 * @param horizontal The horizontal alignment of elements
5700 * @param vertical The vertical alignment of elements
5702 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5704 * Get the alignment of the whole bouding box of contents.
5706 * @param obj The box object
5707 * @param horizontal The horizontal alignment of elements
5708 * @param vertical The vertical alignment of elements
5710 * @see elm_box_align_set()
5712 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5715 * Set the layout defining function to be used by the box
5717 * Whenever anything changes that requires the box in @p obj to recalculate
5718 * the size and position of its elements, the function @p cb will be called
5719 * to determine what the layout of the children will be.
5721 * Once a custom function is set, everything about the children layout
5722 * is defined by it. The flags set by elm_box_horizontal_set() and
5723 * elm_box_homogeneous_set() no longer have any meaning, and the values
5724 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5725 * layout function to decide if they are used and how. These last two
5726 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5727 * passed to @p cb. The @c Evas_Object the function receives is not the
5728 * Elementary widget, but the internal Evas Box it uses, so none of the
5729 * functions described here can be used on it.
5731 * Any of the layout functions in @c Evas can be used here, as well as the
5732 * special elm_box_layout_transition().
5734 * The final @p data argument received by @p cb is the same @p data passed
5735 * here, and the @p free_data function will be called to free it
5736 * whenever the box is destroyed or another layout function is set.
5738 * Setting @p cb to NULL will revert back to the default layout function.
5740 * @param obj The box object
5741 * @param cb The callback function used for layout
5742 * @param data Data that will be passed to layout function
5743 * @param free_data Function called to free @p data
5745 * @see elm_box_layout_transition()
5747 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);
5749 * Special layout function that animates the transition from one layout to another
5751 * Normally, when switching the layout function for a box, this will be
5752 * reflected immediately on screen on the next render, but it's also
5753 * possible to do this through an animated transition.
5755 * This is done by creating an ::Elm_Box_Transition and setting the box
5756 * layout to this function.
5760 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5761 * evas_object_box_layout_vertical, // start
5762 * NULL, // data for initial layout
5763 * NULL, // free function for initial data
5764 * evas_object_box_layout_horizontal, // end
5765 * NULL, // data for final layout
5766 * NULL, // free function for final data
5767 * anim_end, // will be called when animation ends
5768 * NULL); // data for anim_end function\
5769 * elm_box_layout_set(box, elm_box_layout_transition, t,
5770 * elm_box_transition_free);
5773 * @note This function can only be used with elm_box_layout_set(). Calling
5774 * it directly will not have the expected results.
5776 * @see elm_box_transition_new
5777 * @see elm_box_transition_free
5778 * @see elm_box_layout_set
5780 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5782 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5784 * If you want to animate the change from one layout to another, you need
5785 * to set the layout function of the box to elm_box_layout_transition(),
5786 * passing as user data to it an instance of ::Elm_Box_Transition with the
5787 * necessary information to perform this animation. The free function to
5788 * set for the layout is elm_box_transition_free().
5790 * The parameters to create an ::Elm_Box_Transition sum up to how long
5791 * will it be, in seconds, a layout function to describe the initial point,
5792 * another for the final position of the children and one function to be
5793 * called when the whole animation ends. This last function is useful to
5794 * set the definitive layout for the box, usually the same as the end
5795 * layout for the animation, but could be used to start another transition.
5797 * @param start_layout The layout function that will be used to start the animation
5798 * @param start_layout_data The data to be passed the @p start_layout function
5799 * @param start_layout_free_data Function to free @p start_layout_data
5800 * @param end_layout The layout function that will be used to end the animation
5801 * @param end_layout_free_data The data to be passed the @p end_layout function
5802 * @param end_layout_free_data Function to free @p end_layout_data
5803 * @param transition_end_cb Callback function called when animation ends
5804 * @param transition_end_data Data to be passed to @p transition_end_cb
5805 * @return An instance of ::Elm_Box_Transition
5807 * @see elm_box_transition_new
5808 * @see elm_box_layout_transition
5810 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);
5812 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5814 * This function is mostly useful as the @c free_data parameter in
5815 * elm_box_layout_set() when elm_box_layout_transition().
5817 * @param data The Elm_Box_Transition instance to be freed.
5819 * @see elm_box_transition_new
5820 * @see elm_box_layout_transition
5822 EAPI void elm_box_transition_free(void *data);
5829 * @defgroup Button Button
5831 * @image html img/widget/button/preview-00.png
5832 * @image latex img/widget/button/preview-00.eps
5833 * @image html img/widget/button/preview-01.png
5834 * @image latex img/widget/button/preview-01.eps
5835 * @image html img/widget/button/preview-02.png
5836 * @image latex img/widget/button/preview-02.eps
5838 * This is a push-button. Press it and run some function. It can contain
5839 * a simple label and icon object and it also has an autorepeat feature.
5841 * This widgets emits the following signals:
5842 * @li "clicked": the user clicked the button (press/release).
5843 * @li "repeated": the user pressed the button without releasing it.
5844 * @li "pressed": button was pressed.
5845 * @li "unpressed": button was released after being pressed.
5846 * In all three cases, the @c event parameter of the callback will be
5849 * Also, defined in the default theme, the button has the following styles
5851 * @li default: a normal button.
5852 * @li anchor: Like default, but the button fades away when the mouse is not
5853 * over it, leaving only the text or icon.
5854 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5855 * continuous look across its options.
5856 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5858 * Follow through a complete example @ref button_example_01 "here".
5862 * Add a new button to the parent's canvas
5864 * @param parent The parent object
5865 * @return The new object or NULL if it cannot be created
5867 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5869 * Set the label used in the button
5871 * The passed @p label can be NULL to clean any existing text in it and
5872 * leave the button as an icon only object.
5874 * @param obj The button object
5875 * @param label The text will be written on the button
5876 * @deprecated use elm_object_text_set() instead.
5878 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5880 * Get the label set for the button
5882 * The string returned is an internal pointer and should not be freed or
5883 * altered. It will also become invalid when the button is destroyed.
5884 * The string returned, if not NULL, is a stringshare, so if you need to
5885 * keep it around even after the button is destroyed, you can use
5886 * eina_stringshare_ref().
5888 * @param obj The button object
5889 * @return The text set to the label, or NULL if nothing is set
5890 * @deprecated use elm_object_text_set() instead.
5892 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5894 * Set the icon used for the button
5896 * Setting a new icon will delete any other that was previously set, making
5897 * any reference to them invalid. If you need to maintain the previous
5898 * object alive, unset it first with elm_button_icon_unset().
5900 * @param obj The button object
5901 * @param icon The icon object for the button
5903 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5905 * Get the icon used for the button
5907 * Return the icon object which is set for this widget. If the button is
5908 * destroyed or another icon is set, the returned object will be deleted
5909 * and any reference to it will be invalid.
5911 * @param obj The button object
5912 * @return The icon object that is being used
5914 * @see elm_button_icon_unset()
5916 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5918 * Remove the icon set without deleting it and return the object
5920 * This function drops the reference the button holds of the icon object
5921 * and returns this last object. It is used in case you want to remove any
5922 * icon, or set another one, without deleting the actual object. The button
5923 * will be left without an icon set.
5925 * @param obj The button object
5926 * @return The icon object that was being used
5928 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5930 * Turn on/off the autorepeat event generated when the button is kept pressed
5932 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5933 * signal when they are clicked.
5935 * When on, keeping a button pressed will continuously emit a @c repeated
5936 * signal until the button is released. The time it takes until it starts
5937 * emitting the signal is given by
5938 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5939 * new emission by elm_button_autorepeat_gap_timeout_set().
5941 * @param obj The button object
5942 * @param on A bool to turn on/off the event
5944 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5946 * Get whether the autorepeat feature is enabled
5948 * @param obj The button object
5949 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5951 * @see elm_button_autorepeat_set()
5953 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5955 * Set the initial timeout before the autorepeat event is generated
5957 * Sets the timeout, in seconds, since the button is pressed until the
5958 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5959 * won't be any delay and the even will be fired the moment the button is
5962 * @param obj The button object
5963 * @param t Timeout in seconds
5965 * @see elm_button_autorepeat_set()
5966 * @see elm_button_autorepeat_gap_timeout_set()
5968 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5970 * Get the initial timeout before the autorepeat event is generated
5972 * @param obj The button object
5973 * @return Timeout in seconds
5975 * @see elm_button_autorepeat_initial_timeout_set()
5977 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 * Set the interval between each generated autorepeat event
5981 * After the first @c repeated event is fired, all subsequent ones will
5982 * follow after a delay of @p t seconds for each.
5984 * @param obj The button object
5985 * @param t Interval in seconds
5987 * @see elm_button_autorepeat_initial_timeout_set()
5989 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5991 * Get the interval between each generated autorepeat event
5993 * @param obj The button object
5994 * @return Interval in seconds
5996 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6002 * @defgroup File_Selector_Button File Selector Button
6004 * @image html img/widget/fileselector_button/preview-00.png
6005 * @image latex img/widget/fileselector_button/preview-00.eps
6006 * @image html img/widget/fileselector_button/preview-01.png
6007 * @image latex img/widget/fileselector_button/preview-01.eps
6008 * @image html img/widget/fileselector_button/preview-02.png
6009 * @image latex img/widget/fileselector_button/preview-02.eps
6011 * This is a button that, when clicked, creates an Elementary
6012 * window (or inner window) <b> with a @ref Fileselector "file
6013 * selector widget" within</b>. When a file is chosen, the (inner)
6014 * window is closed and the button emits a signal having the
6015 * selected file as it's @c event_info.
6017 * This widget encapsulates operations on its internal file
6018 * selector on its own API. There is less control over its file
6019 * selector than that one would have instatiating one directly.
6021 * The following styles are available for this button:
6024 * @li @c "hoversel_vertical"
6025 * @li @c "hoversel_vertical_entry"
6027 * Smart callbacks one can register to:
6028 * - @c "file,chosen" - the user has selected a path, whose string
6029 * pointer comes as the @c event_info data (a stringshared
6032 * Here is an example on its usage:
6033 * @li @ref fileselector_button_example
6035 * @see @ref File_Selector_Entry for a similar widget.
6040 * Add a new file selector button widget to the given parent
6041 * Elementary (container) object
6043 * @param parent The parent object
6044 * @return a new file selector button widget handle or @c NULL, on
6047 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6050 * Set the label for a given file selector button widget
6052 * @param obj The file selector button widget
6053 * @param label The text label to be displayed on @p obj
6055 * @deprecated use elm_object_text_set() instead.
6057 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6060 * Get the label set for a given file selector button widget
6062 * @param obj The file selector button widget
6063 * @return The button label
6065 * @deprecated use elm_object_text_set() instead.
6067 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6070 * Set the icon on a given file selector button widget
6072 * @param obj The file selector button widget
6073 * @param icon The icon object for the button
6075 * Once the icon object is set, a previously set one will be
6076 * deleted. If you want to keep the latter, use the
6077 * elm_fileselector_button_icon_unset() function.
6079 * @see elm_fileselector_button_icon_get()
6081 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6084 * Get the icon set for a given file selector button widget
6086 * @param obj The file selector button widget
6087 * @return The icon object currently set on @p obj or @c NULL, if
6090 * @see elm_fileselector_button_icon_set()
6092 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6095 * Unset the icon used in a given file selector button widget
6097 * @param obj The file selector button widget
6098 * @return The icon object that was being used on @p obj or @c
6101 * Unparent and return the icon object which was set for this
6104 * @see elm_fileselector_button_icon_set()
6106 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 * Set the title for a given file selector button widget's window
6111 * @param obj The file selector button widget
6112 * @param title The title string
6114 * This will change the window's title, when the file selector pops
6115 * out after a click on the button. Those windows have the default
6116 * (unlocalized) value of @c "Select a file" as titles.
6118 * @note It will only take any effect if the file selector
6119 * button widget is @b not under "inwin mode".
6121 * @see elm_fileselector_button_window_title_get()
6123 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6126 * Get the title set for a given file selector button widget's
6129 * @param obj The file selector button widget
6130 * @return Title of the file selector button's window
6132 * @see elm_fileselector_button_window_title_get() for more details
6134 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6137 * Set the size of a given file selector button widget's window,
6138 * holding the file selector itself.
6140 * @param obj The file selector button widget
6141 * @param width The window's width
6142 * @param height The window's height
6144 * @note it will only take any effect if the file selector button
6145 * widget is @b not under "inwin mode". The default size for the
6146 * window (when applicable) is 400x400 pixels.
6148 * @see elm_fileselector_button_window_size_get()
6150 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6153 * Get the size of a given file selector button widget's window,
6154 * holding the file selector itself.
6156 * @param obj The file selector button widget
6157 * @param width Pointer into which to store the width value
6158 * @param height Pointer into which to store the height value
6160 * @note Use @c NULL pointers on the size values you're not
6161 * interested in: they'll be ignored by the function.
6163 * @see elm_fileselector_button_window_size_set(), for more details
6165 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6168 * Set the initial file system path for a given file selector
6171 * @param obj The file selector button widget
6172 * @param path The path string
6174 * It must be a <b>directory</b> path, which will have the contents
6175 * displayed initially in the file selector's view, when invoked
6176 * from @p obj. The default initial path is the @c "HOME"
6177 * environment variable's value.
6179 * @see elm_fileselector_button_path_get()
6181 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6184 * Get the initial file system path set for a given file selector
6187 * @param obj The file selector button widget
6188 * @return path The path string
6190 * @see elm_fileselector_button_path_set() for more details
6192 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195 * Enable/disable a tree view in the given file selector button
6196 * widget's internal file selector
6198 * @param obj The file selector button widget
6199 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6202 * This has the same effect as elm_fileselector_expandable_set(),
6203 * but now applied to a file selector button's internal file
6206 * @note There's no way to put a file selector button's internal
6207 * file selector in "grid mode", as one may do with "pure" file
6210 * @see elm_fileselector_expandable_get()
6212 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6215 * Get whether tree view is enabled for the given file selector
6216 * button widget's internal file selector
6218 * @param obj The file selector button widget
6219 * @return @c EINA_TRUE if @p obj widget's internal file selector
6220 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6222 * @see elm_fileselector_expandable_set() for more details
6224 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6227 * Set whether a given file selector button widget's internal file
6228 * selector is to display folders only or the directory contents,
6231 * @param obj The file selector button widget
6232 * @param only @c EINA_TRUE to make @p obj widget's internal file
6233 * selector only display directories, @c EINA_FALSE to make files
6234 * to be displayed in it too
6236 * This has the same effect as elm_fileselector_folder_only_set(),
6237 * but now applied to a file selector button's internal file
6240 * @see elm_fileselector_folder_only_get()
6242 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6245 * Get whether a given file selector button widget's internal file
6246 * selector is displaying folders only or the directory contents,
6249 * @param obj The file selector button widget
6250 * @return @c EINA_TRUE if @p obj widget's internal file
6251 * selector is only displaying directories, @c EINA_FALSE if files
6252 * are being displayed in it too (and on errors)
6254 * @see elm_fileselector_button_folder_only_set() for more details
6256 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6259 * Enable/disable the file name entry box where the user can type
6260 * in a name for a file, in a given file selector button widget's
6261 * internal file selector.
6263 * @param obj The file selector button widget
6264 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6265 * file selector a "saving dialog", @c EINA_FALSE otherwise
6267 * This has the same effect as elm_fileselector_is_save_set(),
6268 * but now applied to a file selector button's internal file
6271 * @see elm_fileselector_is_save_get()
6273 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6276 * Get whether the given file selector button widget's internal
6277 * file selector is in "saving dialog" mode
6279 * @param obj The file selector button widget
6280 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6281 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6284 * @see elm_fileselector_button_is_save_set() for more details
6286 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 * Set whether a given file selector button widget's internal file
6290 * selector will raise an Elementary "inner window", instead of a
6291 * dedicated Elementary window. By default, it won't.
6293 * @param obj The file selector button widget
6294 * @param value @c EINA_TRUE to make it use an inner window, @c
6295 * EINA_TRUE to make it use a dedicated window
6297 * @see elm_win_inwin_add() for more information on inner windows
6298 * @see elm_fileselector_button_inwin_mode_get()
6300 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6303 * Get whether a given file selector button widget's internal file
6304 * selector will raise an Elementary "inner window", instead of a
6305 * dedicated Elementary window.
6307 * @param obj The file selector button widget
6308 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6309 * if it will use a dedicated window
6311 * @see elm_fileselector_button_inwin_mode_set() for more details
6313 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6320 * @defgroup File_Selector_Entry File Selector Entry
6322 * @image html img/widget/fileselector_entry/preview-00.png
6323 * @image latex img/widget/fileselector_entry/preview-00.eps
6325 * This is an entry made to be filled with or display a <b>file
6326 * system path string</b>. Besides the entry itself, the widget has
6327 * a @ref File_Selector_Button "file selector button" on its side,
6328 * which will raise an internal @ref Fileselector "file selector widget",
6329 * when clicked, for path selection aided by file system
6332 * This file selector may appear in an Elementary window or in an
6333 * inner window. When a file is chosen from it, the (inner) window
6334 * is closed and the selected file's path string is exposed both as
6335 * an smart event and as the new text on the entry.
6337 * This widget encapsulates operations on its internal file
6338 * selector on its own API. There is less control over its file
6339 * selector than that one would have instatiating one directly.
6341 * Smart callbacks one can register to:
6342 * - @c "changed" - The text within the entry was changed
6343 * - @c "activated" - The entry has had editing finished and
6344 * changes are to be "committed"
6345 * - @c "press" - The entry has been clicked
6346 * - @c "longpressed" - The entry has been clicked (and held) for a
6348 * - @c "clicked" - The entry has been clicked
6349 * - @c "clicked,double" - The entry has been double clicked
6350 * - @c "focused" - The entry has received focus
6351 * - @c "unfocused" - The entry has lost focus
6352 * - @c "selection,paste" - A paste action has occurred on the
6354 * - @c "selection,copy" - A copy action has occurred on the entry
6355 * - @c "selection,cut" - A cut action has occurred on the entry
6356 * - @c "unpressed" - The file selector entry's button was released
6357 * after being pressed.
6358 * - @c "file,chosen" - The user has selected a path via the file
6359 * selector entry's internal file selector, whose string pointer
6360 * comes as the @c event_info data (a stringshared string)
6362 * Here is an example on its usage:
6363 * @li @ref fileselector_entry_example
6365 * @see @ref File_Selector_Button for a similar widget.
6370 * Add a new file selector entry widget to the given parent
6371 * Elementary (container) object
6373 * @param parent The parent object
6374 * @return a new file selector entry widget handle or @c NULL, on
6377 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6380 * Set the label for a given file selector entry widget's button
6382 * @param obj The file selector entry widget
6383 * @param label The text label to be displayed on @p obj widget's
6386 * @deprecated use elm_object_text_set() instead.
6388 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6391 * Get the label set for a given file selector entry widget's button
6393 * @param obj The file selector entry widget
6394 * @return The widget button's label
6396 * @deprecated use elm_object_text_set() instead.
6398 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 * Set the icon on a given file selector entry widget's button
6403 * @param obj The file selector entry widget
6404 * @param icon The icon object for the entry's button
6406 * Once the icon object is set, a previously set one will be
6407 * deleted. If you want to keep the latter, use the
6408 * elm_fileselector_entry_button_icon_unset() function.
6410 * @see elm_fileselector_entry_button_icon_get()
6412 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6415 * Get the icon set for a given file selector entry widget's button
6417 * @param obj The file selector entry widget
6418 * @return The icon object currently set on @p obj widget's button
6419 * or @c NULL, if none is
6421 * @see elm_fileselector_entry_button_icon_set()
6423 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6426 * Unset the icon used in a given file selector entry widget's
6429 * @param obj The file selector entry widget
6430 * @return The icon object that was being used on @p obj widget's
6431 * button or @c NULL, on errors
6433 * Unparent and return the icon object which was set for this
6436 * @see elm_fileselector_entry_button_icon_set()
6438 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6441 * Set the title for a given file selector entry widget's window
6443 * @param obj The file selector entry widget
6444 * @param title The title string
6446 * This will change the window's title, when the file selector pops
6447 * out after a click on the entry's button. Those windows have the
6448 * default (unlocalized) value of @c "Select a file" as titles.
6450 * @note It will only take any effect if the file selector
6451 * entry widget is @b not under "inwin mode".
6453 * @see elm_fileselector_entry_window_title_get()
6455 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6458 * Get the title set for a given file selector entry widget's
6461 * @param obj The file selector entry widget
6462 * @return Title of the file selector entry's window
6464 * @see elm_fileselector_entry_window_title_get() for more details
6466 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6469 * Set the size of a given file selector entry widget's window,
6470 * holding the file selector itself.
6472 * @param obj The file selector entry widget
6473 * @param width The window's width
6474 * @param height The window's height
6476 * @note it will only take any effect if the file selector entry
6477 * widget is @b not under "inwin mode". The default size for the
6478 * window (when applicable) is 400x400 pixels.
6480 * @see elm_fileselector_entry_window_size_get()
6482 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6485 * Get the size of a given file selector entry widget's window,
6486 * holding the file selector itself.
6488 * @param obj The file selector entry widget
6489 * @param width Pointer into which to store the width value
6490 * @param height Pointer into which to store the height value
6492 * @note Use @c NULL pointers on the size values you're not
6493 * interested in: they'll be ignored by the function.
6495 * @see elm_fileselector_entry_window_size_set(), for more details
6497 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6500 * Set the initial file system path and the entry's path string for
6501 * a given file selector entry widget
6503 * @param obj The file selector entry widget
6504 * @param path The path string
6506 * It must be a <b>directory</b> path, which will have the contents
6507 * displayed initially in the file selector's view, when invoked
6508 * from @p obj. The default initial path is the @c "HOME"
6509 * environment variable's value.
6511 * @see elm_fileselector_entry_path_get()
6513 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6516 * Get the entry's path string for a given file selector entry
6519 * @param obj The file selector entry widget
6520 * @return path The path string
6522 * @see elm_fileselector_entry_path_set() for more details
6524 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6527 * Enable/disable a tree view in the given file selector entry
6528 * widget's internal file selector
6530 * @param obj The file selector entry widget
6531 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6534 * This has the same effect as elm_fileselector_expandable_set(),
6535 * but now applied to a file selector entry's internal file
6538 * @note There's no way to put a file selector entry's internal
6539 * file selector in "grid mode", as one may do with "pure" file
6542 * @see elm_fileselector_expandable_get()
6544 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6547 * Get whether tree view is enabled for the given file selector
6548 * entry widget's internal file selector
6550 * @param obj The file selector entry widget
6551 * @return @c EINA_TRUE if @p obj widget's internal file selector
6552 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6554 * @see elm_fileselector_expandable_set() for more details
6556 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * Set whether a given file selector entry widget's internal file
6560 * selector is to display folders only or the directory contents,
6563 * @param obj The file selector entry widget
6564 * @param only @c EINA_TRUE to make @p obj widget's internal file
6565 * selector only display directories, @c EINA_FALSE to make files
6566 * to be displayed in it too
6568 * This has the same effect as elm_fileselector_folder_only_set(),
6569 * but now applied to a file selector entry's internal file
6572 * @see elm_fileselector_folder_only_get()
6574 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6577 * Get whether a given file selector entry widget's internal file
6578 * selector is displaying folders only or the directory contents,
6581 * @param obj The file selector entry widget
6582 * @return @c EINA_TRUE if @p obj widget's internal file
6583 * selector is only displaying directories, @c EINA_FALSE if files
6584 * are being displayed in it too (and on errors)
6586 * @see elm_fileselector_entry_folder_only_set() for more details
6588 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6591 * Enable/disable the file name entry box where the user can type
6592 * in a name for a file, in a given file selector entry widget's
6593 * internal file selector.
6595 * @param obj The file selector entry widget
6596 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6597 * file selector a "saving dialog", @c EINA_FALSE otherwise
6599 * This has the same effect as elm_fileselector_is_save_set(),
6600 * but now applied to a file selector entry's internal file
6603 * @see elm_fileselector_is_save_get()
6605 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6608 * Get whether the given file selector entry widget's internal
6609 * file selector is in "saving dialog" mode
6611 * @param obj The file selector entry widget
6612 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6613 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6616 * @see elm_fileselector_entry_is_save_set() for more details
6618 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6621 * Set whether a given file selector entry widget's internal file
6622 * selector will raise an Elementary "inner window", instead of a
6623 * dedicated Elementary window. By default, it won't.
6625 * @param obj The file selector entry widget
6626 * @param value @c EINA_TRUE to make it use an inner window, @c
6627 * EINA_TRUE to make it use a dedicated window
6629 * @see elm_win_inwin_add() for more information on inner windows
6630 * @see elm_fileselector_entry_inwin_mode_get()
6632 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6635 * Get whether a given file selector entry widget's internal file
6636 * selector will raise an Elementary "inner window", instead of a
6637 * dedicated Elementary window.
6639 * @param obj The file selector entry widget
6640 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6641 * if it will use a dedicated window
6643 * @see elm_fileselector_entry_inwin_mode_set() for more details
6645 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 * Set the initial file system path for a given file selector entry
6651 * @param obj The file selector entry widget
6652 * @param path The path string
6654 * It must be a <b>directory</b> path, which will have the contents
6655 * displayed initially in the file selector's view, when invoked
6656 * from @p obj. The default initial path is the @c "HOME"
6657 * environment variable's value.
6659 * @see elm_fileselector_entry_path_get()
6661 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6664 * Get the parent directory's path to the latest file selection on
6665 * a given filer selector entry widget
6667 * @param obj The file selector object
6668 * @return The (full) path of the directory of the last selection
6669 * on @p obj widget, a @b stringshared string
6671 * @see elm_fileselector_entry_path_set()
6673 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 * @defgroup Scroller Scroller
6682 * A scroller holds a single object and "scrolls it around". This means that
6683 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6684 * region around, allowing to move through a much larger object that is
6685 * contained in the scroller. The scroiller will always have a small minimum
6686 * size by default as it won't be limited by the contents of the scroller.
6688 * Signals that you can add callbacks for are:
6689 * @li "edge,left" - the left edge of the content has been reached
6690 * @li "edge,right" - the right edge of the content has been reached
6691 * @li "edge,top" - the top edge of the content has been reached
6692 * @li "edge,bottom" - the bottom edge of the content has been reached
6693 * @li "scroll" - the content has been scrolled (moved)
6694 * @li "scroll,anim,start" - scrolling animation has started
6695 * @li "scroll,anim,stop" - scrolling animation has stopped
6696 * @li "scroll,drag,start" - dragging the contents around has started
6697 * @li "scroll,drag,stop" - dragging the contents around has stopped
6698 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6701 * @note When Elemementary is in embedded mode the scrollbars will not be
6702 * dragable, they appear merely as indicators of how much has been scrolled.
6703 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6704 * fingerscroll) won't work.
6706 * In @ref tutorial_scroller you'll find an example of how to use most of
6711 * @brief Type that controls when scrollbars should appear.
6713 * @see elm_scroller_policy_set()
6715 typedef enum _Elm_Scroller_Policy
6717 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6718 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6719 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6720 ELM_SCROLLER_POLICY_LAST
6721 } Elm_Scroller_Policy;
6723 * @brief Add a new scroller to the parent
6725 * @param parent The parent object
6726 * @return The new object or NULL if it cannot be created
6728 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6730 * @brief Set the content of the scroller widget (the object to be scrolled around).
6732 * @param obj The scroller object
6733 * @param content The new content object
6735 * Once the content object is set, a previously set one will be deleted.
6736 * If you want to keep that old content object, use the
6737 * elm_scroller_content_unset() function.
6739 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6741 * @brief Get the content of the scroller widget
6743 * @param obj The slider object
6744 * @return The content that is being used
6746 * Return the content object which is set for this widget
6748 * @see elm_scroller_content_set()
6750 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6752 * @brief Unset the content of the scroller widget
6754 * @param obj The slider object
6755 * @return The content that was being used
6757 * Unparent and return the content object which was set for this widget
6759 * @see elm_scroller_content_set()
6761 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6763 * @brief Set custom theme elements for the scroller
6765 * @param obj The scroller object
6766 * @param widget The widget name to use (default is "scroller")
6767 * @param base The base name to use (default is "base")
6769 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6771 * @brief Make the scroller minimum size limited to the minimum size of the content
6773 * @param obj The scroller object
6774 * @param w Enable limiting minimum size horizontally
6775 * @param h Enable limiting minimum size vertically
6777 * By default the scroller will be as small as its design allows,
6778 * irrespective of its content. This will make the scroller minimum size the
6779 * right size horizontally and/or vertically to perfectly fit its content in
6782 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6784 * @brief Show a specific virtual region within the scroller content object
6786 * @param obj The scroller object
6787 * @param x X coordinate of the region
6788 * @param y Y coordinate of the region
6789 * @param w Width of the region
6790 * @param h Height of the region
6792 * This will ensure all (or part if it does not fit) of the designated
6793 * region in the virtual content object (0, 0 starting at the top-left of the
6794 * virtual content object) is shown within the scroller.
6796 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);
6798 * @brief Set the scrollbar visibility policy
6800 * @param obj The scroller object
6801 * @param policy_h Horizontal scrollbar policy
6802 * @param policy_v Vertical scrollbar policy
6804 * This sets the scrollbar visibility policy for the given scroller.
6805 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6806 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6807 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6808 * respectively for the horizontal and vertical scrollbars.
6810 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6812 * @brief Gets scrollbar visibility policy
6814 * @param obj The scroller object
6815 * @param policy_h Horizontal scrollbar policy
6816 * @param policy_v Vertical scrollbar policy
6818 * @see elm_scroller_policy_set()
6820 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6822 * @brief Get the currently visible content region
6824 * @param obj The scroller object
6825 * @param x X coordinate of the region
6826 * @param y Y coordinate of the region
6827 * @param w Width of the region
6828 * @param h Height of the region
6830 * This gets the current region in the content object that is visible through
6831 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6832 * w, @p h values pointed to.
6834 * @note All coordinates are relative to the content.
6836 * @see elm_scroller_region_show()
6838 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);
6840 * @brief Get the size of the content object
6842 * @param obj The scroller object
6843 * @param w Width return
6844 * @param h Height return
6846 * This gets the size of the content object of the scroller.
6848 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6850 * @brief Set bouncing behavior
6852 * @param obj The scroller object
6853 * @param h_bounce Will the scroller bounce horizontally or not
6854 * @param v_bounce Will the scroller bounce vertically or not
6856 * When scrolling, the scroller may "bounce" when reaching an edge of the
6857 * content object. This is a visual way to indicate the end has been reached.
6858 * This is enabled by default for both axis. This will set if it is enabled
6859 * for that axis with the boolean parameters for each axis.
6861 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6863 * @brief Get the bounce mode
6865 * @param obj The Scroller object
6866 * @param h_bounce Allow bounce horizontally
6867 * @param v_bounce Allow bounce vertically
6869 * @see elm_scroller_bounce_set()
6871 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6873 * @brief Set scroll page size relative to viewport size.
6875 * @param obj The scroller object
6876 * @param h_pagerel The horizontal page relative size
6877 * @param v_pagerel The vertical page relative size
6879 * The scroller is capable of limiting scrolling by the user to "pages". That
6880 * is to jump by and only show a "whole page" at a time as if the continuous
6881 * area of the scroller content is split into page sized pieces. This sets
6882 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6883 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6884 * axis. This is mutually exclusive with page size
6885 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6886 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6887 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6890 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6892 * @brief Set scroll page size.
6894 * @param obj The scroller object
6895 * @param h_pagesize The horizontal page size
6896 * @param v_pagesize The vertical page size
6898 * This sets the page size to an absolute fixed value, with 0 turning it off
6901 * @see elm_scroller_page_relative_set()
6903 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6905 * @brief Get scroll current page number.
6907 * @param obj The scroller object
6908 * @param h_pagenumber The horizoptal page number
6909 * @param v_pagenumber The vertical page number
6911 * The page number starts from 0. 0 is the first page.
6912 * Current page means the page which meet the top-left of the viewport.
6913 * If there are two or more pages in the viewport, it returns the number of page
6914 * which meet the top-left of the viewport.
6916 * @see elm_scroller_last_page_get()
6917 * @see elm_scroller_page_show()
6918 * @see elm_scroller_page_brint_in()
6920 EAPI void elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6922 * @brief Get scroll last page number.
6924 * @param obj The scroller object
6925 * @param h_pagenumber The horizoptal page number
6926 * @param v_pagenumber The vertical page number
6928 * The page number starts from 0. 0 is the first page.
6929 * This returns the last page number among the pages.
6931 * @see elm_scroller_current_page_get()
6932 * @see elm_scroller_page_show()
6933 * @see elm_scroller_page_brint_in()
6935 EAPI void elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6937 * Show a specific virtual region within the scroller content object by page number.
6939 * @param obj The scroller object
6940 * @param h_pagenumber The horizoptal page number
6941 * @param v_pagenumber The vertical page number
6943 * 0, 0 of the indicated page is located at the top-left of the viewport.
6944 * This will jump to the page directly without animation.
6949 * sc = elm_scroller_add(win);
6950 * elm_scroller_content_set(sc, content);
6951 * elm_scroller_page_relative_set(sc, 1, 0);
6952 * elm_scroller_current_page_get(sc, &h_page, &v_page);
6953 * elm_scroller_page_show(sc, h_page + 1, v_page);
6956 * @see elm_scroller_page_bring_in()
6958 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6960 * Show a specific virtual region within the scroller content object by page number.
6962 * @param obj The scroller object
6963 * @param h_pagenumber The horizoptal page number
6964 * @param v_pagenumber The vertical page number
6966 * 0, 0 of the indicated page is located at the top-left of the viewport.
6967 * This will slide to the page with animation.
6972 * sc = elm_scroller_add(win);
6973 * elm_scroller_content_set(sc, content);
6974 * elm_scroller_page_relative_set(sc, 1, 0);
6975 * elm_scroller_last_page_get(sc, &h_page, &v_page);
6976 * elm_scroller_page_bring_in(sc, h_page, v_page);
6979 * @see elm_scroller_page_show()
6981 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6983 * @brief Show a specific virtual region within the scroller content object.
6985 * @param obj The scroller object
6986 * @param x X coordinate of the region
6987 * @param y Y coordinate of the region
6988 * @param w Width of the region
6989 * @param h Height of the region
6991 * This will ensure all (or part if it does not fit) of the designated
6992 * region in the virtual content object (0, 0 starting at the top-left of the
6993 * virtual content object) is shown within the scroller. Unlike
6994 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6995 * to this location (if configuration in general calls for transitions). It
6996 * may not jump immediately to the new location and make take a while and
6997 * show other content along the way.
6999 * @see elm_scroller_region_show()
7001 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);
7003 * @brief Set event propagation on a scroller
7005 * @param obj The scroller object
7006 * @param propagation If propagation is enabled or not
7008 * This enables or disabled event propagation from the scroller content to
7009 * the scroller and its parent. By default event propagation is disabled.
7011 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7013 * @brief Get event propagation for a scroller
7015 * @param obj The scroller object
7016 * @return The propagation state
7018 * This gets the event propagation for a scroller.
7020 * @see elm_scroller_propagate_events_set()
7022 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7028 * @defgroup Label Label
7030 * @image html img/widget/label/preview-00.png
7031 * @image latex img/widget/label/preview-00.eps
7033 * @brief Widget to display text, with simple html-like markup.
7035 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7036 * text doesn't fit the geometry of the label it will be ellipsized or be
7037 * cut. Elementary provides several themes for this widget:
7038 * @li default - No animation
7039 * @li marker - Centers the text in the label and make it bold by default
7040 * @li slide_long - The entire text appears from the right of the screen and
7041 * slides until it disappears in the left of the screen(reappering on the
7043 * @li slide_short - The text appears in the left of the label and slides to
7044 * the right to show the overflow. When all of the text has been shown the
7045 * position is reset.
7046 * @li slide_bounce - The text appears in the left of the label and slides to
7047 * the right to show the overflow. When all of the text has been shown the
7048 * animation reverses, moving the text to the left.
7050 * Custom themes can of course invent new markup tags and style them any way
7053 * See @ref tutorial_label for a demonstration of how to use a label widget.
7057 * @brief Add a new label to the parent
7059 * @param parent The parent object
7060 * @return The new object or NULL if it cannot be created
7062 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7064 * @brief Set the label on the label object
7066 * @param obj The label object
7067 * @param label The label will be used on the label object
7068 * @deprecated See elm_object_text_set()
7070 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 */
7072 * @brief Get the label used on the label object
7074 * @param obj The label object
7075 * @return The string inside the label
7076 * @deprecated See elm_object_text_get()
7078 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7080 * @brief Set the wrapping behavior of the label
7082 * @param obj The label object
7083 * @param wrap To wrap text or not
7085 * By default no wrapping is done. Possible values for @p wrap are:
7086 * @li ELM_WRAP_NONE - No wrapping
7087 * @li ELM_WRAP_CHAR - wrap between characters
7088 * @li ELM_WRAP_WORD - wrap between words
7089 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7091 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7093 * @brief Get the wrapping behavior of the label
7095 * @param obj The label object
7098 * @see elm_label_line_wrap_set()
7100 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7102 * @brief Set wrap width of the label
7104 * @param obj The label object
7105 * @param w The wrap width in pixels at a minimum where words need to wrap
7107 * This function sets the maximum width size hint of the label.
7109 * @warning This is only relevant if the label is inside a container.
7111 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7113 * @brief Get wrap width of the label
7115 * @param obj The label object
7116 * @return The wrap width in pixels at a minimum where words need to wrap
7118 * @see elm_label_wrap_width_set()
7120 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7122 * @brief Set wrap height of the label
7124 * @param obj The label object
7125 * @param h The wrap height in pixels at a minimum where words need to wrap
7127 * This function sets the maximum height size hint of the label.
7129 * @warning This is only relevant if the label is inside a container.
7131 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7133 * @brief get wrap width of the label
7135 * @param obj The label object
7136 * @return The wrap height in pixels at a minimum where words need to wrap
7138 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7140 * @brief Set the font size on the label object.
7142 * @param obj The label object
7143 * @param size font size
7145 * @warning NEVER use this. It is for hyper-special cases only. use styles
7146 * instead. e.g. "big", "medium", "small" - or better name them by use:
7147 * "title", "footnote", "quote" etc.
7149 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7151 * @brief Set the text color on the label object
7153 * @param obj The label object
7154 * @param r Red property background color of The label object
7155 * @param g Green property background color of The label object
7156 * @param b Blue property background color of The label object
7157 * @param a Alpha property background color of The label object
7159 * @warning NEVER use this. It is for hyper-special cases only. use styles
7160 * instead. e.g. "big", "medium", "small" - or better name them by use:
7161 * "title", "footnote", "quote" etc.
7163 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);
7165 * @brief Set the text align on the label object
7167 * @param obj The label object
7168 * @param align align mode ("left", "center", "right")
7170 * @warning NEVER use this. It is for hyper-special cases only. use styles
7171 * instead. e.g. "big", "medium", "small" - or better name them by use:
7172 * "title", "footnote", "quote" etc.
7174 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7176 * @brief Set background color of the label
7178 * @param obj The label object
7179 * @param r Red property background color of The label object
7180 * @param g Green property background color of The label object
7181 * @param b Blue property background color of The label object
7182 * @param a Alpha property background alpha of The label object
7184 * @warning NEVER use this. It is for hyper-special cases only. use styles
7185 * instead. e.g. "big", "medium", "small" - or better name them by use:
7186 * "title", "footnote", "quote" etc.
7188 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);
7190 * @brief Set the ellipsis behavior of the label
7192 * @param obj The label object
7193 * @param ellipsis To ellipsis text or not
7195 * If set to true and the text doesn't fit in the label an ellipsis("...")
7196 * will be shown at the end of the widget.
7198 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7199 * choosen wrap method was ELM_WRAP_WORD.
7201 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7203 * @brief Set the text slide of the label
7205 * @param obj The label object
7206 * @param slide To start slide or stop
7208 * If set to true the text of the label will slide throught the length of
7211 * @warning This only work with the themes "slide_short", "slide_long" and
7214 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7216 * @brief Get the text slide mode of the label
7218 * @param obj The label object
7219 * @return slide slide mode value
7221 * @see elm_label_slide_set()
7223 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7225 * @brief Set the slide duration(speed) of the label
7227 * @param obj The label object
7228 * @return The duration in seconds in moving text from slide begin position
7229 * to slide end position
7231 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7233 * @brief Get the slide duration(speed) of the label
7235 * @param obj The label object
7236 * @return The duration time in moving text from slide begin position to slide end position
7238 * @see elm_label_slide_duration_set()
7240 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7246 * @defgroup Toggle Toggle
7248 * @image html img/widget/toggle/preview-00.png
7249 * @image latex img/widget/toggle/preview-00.eps
7251 * @brief A toggle is a slider which can be used to toggle between
7252 * two values. It has two states: on and off.
7254 * Signals that you can add callbacks for are:
7255 * @li "changed" - Whenever the toggle value has been changed. Is not called
7256 * until the toggle is released by the cursor (assuming it
7257 * has been triggered by the cursor in the first place).
7259 * @ref tutorial_toggle show how to use a toggle.
7263 * @brief Add a toggle to @p parent.
7265 * @param parent The parent object
7267 * @return The toggle object
7269 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7271 * @brief Sets the label to be displayed with the toggle.
7273 * @param obj The toggle object
7274 * @param label The label to be displayed
7276 * @deprecated use elm_object_text_set() instead.
7278 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7280 * @brief Gets the label of the toggle
7282 * @param obj toggle object
7283 * @return The label of the toggle
7285 * @deprecated use elm_object_text_get() instead.
7287 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7289 * @brief Set the icon used for the toggle
7291 * @param obj The toggle object
7292 * @param icon The icon object for the button
7294 * Once the icon object is set, a previously set one will be deleted
7295 * If you want to keep that old content object, use the
7296 * elm_toggle_icon_unset() function.
7298 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7300 * @brief Get the icon used for the toggle
7302 * @param obj The toggle object
7303 * @return The icon object that is being used
7305 * Return the icon object which is set for this widget.
7307 * @see elm_toggle_icon_set()
7309 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7311 * @brief Unset the icon used for the toggle
7313 * @param obj The toggle object
7314 * @return The icon object that was being used
7316 * Unparent and return the icon object which was set for this widget.
7318 * @see elm_toggle_icon_set()
7320 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7322 * @brief Sets the labels to be associated with the on and off states of the toggle.
7324 * @param obj The toggle object
7325 * @param onlabel The label displayed when the toggle is in the "on" state
7326 * @param offlabel The label displayed when the toggle is in the "off" state
7328 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7330 * @brief Gets the labels associated with the on and off states of the toggle.
7332 * @param obj The toggle object
7333 * @param onlabel A char** to place the onlabel of @p obj into
7334 * @param offlabel A char** to place the offlabel of @p obj into
7336 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7338 * @brief Sets the state of the toggle to @p state.
7340 * @param obj The toggle object
7341 * @param state The state of @p obj
7343 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7345 * @brief Gets the state of the toggle to @p state.
7347 * @param obj The toggle object
7348 * @return The state of @p obj
7350 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7352 * @brief Sets the state pointer of the toggle to @p statep.
7354 * @param obj The toggle object
7355 * @param statep The state pointer of @p obj
7357 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7363 * @defgroup Frame Frame
7365 * @image html img/widget/frame/preview-00.png
7366 * @image latex img/widget/frame/preview-00.eps
7368 * @brief Frame is a widget that holds some content and has a title.
7370 * The default look is a frame with a title, but Frame supports multple
7378 * @li outdent_bottom
7380 * Of all this styles only default shows the title. Frame emits no signals.
7382 * For a detailed example see the @ref tutorial_frame.
7387 * @brief Add a new frame to the parent
7389 * @param parent The parent object
7390 * @return The new object or NULL if it cannot be created
7392 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7394 * @brief Set the frame label
7396 * @param obj The frame object
7397 * @param label The label of this frame object
7399 * @deprecated use elm_object_text_set() instead.
7401 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7403 * @brief Get the frame label
7405 * @param obj The frame object
7407 * @return The label of this frame objet or NULL if unable to get frame
7409 * @deprecated use elm_object_text_get() instead.
7411 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7413 * @brief Set the content of the frame widget
7415 * Once the content object is set, a previously set one will be deleted.
7416 * If you want to keep that old content object, use the
7417 * elm_frame_content_unset() function.
7419 * @param obj The frame object
7420 * @param content The content will be filled in this frame object
7422 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7424 * @brief Get the content of the frame widget
7426 * Return the content object which is set for this widget
7428 * @param obj The frame object
7429 * @return The content that is being used
7431 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7433 * @brief Unset the content of the frame widget
7435 * Unparent and return the content object which was set for this widget
7437 * @param obj The frame object
7438 * @return The content that was being used
7440 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7446 * @defgroup Table Table
7448 * A container widget to arrange other widgets in a table where items can
7449 * also span multiple columns or rows - even overlap (and then be raised or
7450 * lowered accordingly to adjust stacking if they do overlap).
7452 * The followin are examples of how to use a table:
7453 * @li @ref tutorial_table_01
7454 * @li @ref tutorial_table_02
7459 * @brief Add a new table to the parent
7461 * @param parent The parent object
7462 * @return The new object or NULL if it cannot be created
7464 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7466 * @brief Set the homogeneous layout in the table
7468 * @param obj The layout object
7469 * @param homogeneous A boolean to set if the layout is homogeneous in the
7470 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7472 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7474 * @brief Get the current table homogeneous mode.
7476 * @param obj The table object
7477 * @return A boolean to indicating if the layout is homogeneous in the table
7478 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7480 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7482 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7484 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7486 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7488 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7490 * @brief Set padding between cells.
7492 * @param obj The layout object.
7493 * @param horizontal set the horizontal padding.
7494 * @param vertical set the vertical padding.
7496 * Default value is 0.
7498 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7500 * @brief Get padding between cells.
7502 * @param obj The layout object.
7503 * @param horizontal set the horizontal padding.
7504 * @param vertical set the vertical padding.
7506 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7508 * @brief Add a subobject on the table with the coordinates passed
7510 * @param obj The table object
7511 * @param subobj The subobject to be added to the table
7512 * @param x Row number
7513 * @param y Column number
7517 * @note All positioning inside the table is relative to rows and columns, so
7518 * a value of 0 for x and y, means the top left cell of the table, and a
7519 * value of 1 for w and h means @p subobj only takes that 1 cell.
7521 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7523 * @brief Remove child from table.
7525 * @param obj The table object
7526 * @param subobj The subobject
7528 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7530 * @brief Faster way to remove all child objects from a table object.
7532 * @param obj The table object
7533 * @param clear If true, will delete children, else just remove from table.
7535 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7537 * @brief Set the packing location of an existing child of the table
7539 * @param subobj The subobject to be modified in the table
7540 * @param x Row number
7541 * @param y Column number
7545 * Modifies the position of an object already in the table.
7547 * @note All positioning inside the table is relative to rows and columns, so
7548 * a value of 0 for x and y, means the top left cell of the table, and a
7549 * value of 1 for w and h means @p subobj only takes that 1 cell.
7551 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7553 * @brief Get the packing location of an existing child of the table
7555 * @param subobj The subobject to be modified in the table
7556 * @param x Row number
7557 * @param y Column number
7561 * @see elm_table_pack_set()
7563 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7569 * @defgroup Gengrid Gengrid (Generic grid)
7571 * This widget aims to position objects in a grid layout while
7572 * actually creating and rendering only the visible ones, using the
7573 * same idea as the @ref Genlist "genlist": the user defines a @b
7574 * class for each item, specifying functions that will be called at
7575 * object creation, deletion, etc. When those items are selected by
7576 * the user, a callback function is issued. Users may interact with
7577 * a gengrid via the mouse (by clicking on items to select them and
7578 * clicking on the grid's viewport and swiping to pan the whole
7579 * view) or via the keyboard, navigating through item with the
7582 * @section Gengrid_Layouts Gengrid layouts
7584 * Gengrids may layout its items in one of two possible layouts:
7588 * When in "horizontal mode", items will be placed in @b columns,
7589 * from top to bottom and, when the space for a column is filled,
7590 * another one is started on the right, thus expanding the grid
7591 * horizontally, making for horizontal scrolling. When in "vertical
7592 * mode" , though, items will be placed in @b rows, from left to
7593 * right and, when the space for a row is filled, another one is
7594 * started below, thus expanding the grid vertically (and making
7595 * for vertical scrolling).
7597 * @section Gengrid_Items Gengrid items
7599 * An item in a gengrid can have 0 or more text labels (they can be
7600 * regular text or textblock Evas objects - that's up to the style
7601 * to determine), 0 or more icons (which are simply objects
7602 * swallowed into the gengrid item's theming Edje object) and 0 or
7603 * more <b>boolean states</b>, which have the behavior left to the
7604 * user to define. The Edje part names for each of these properties
7605 * will be looked up, in the theme file for the gengrid, under the
7606 * Edje (string) data items named @c "labels", @c "icons" and @c
7607 * "states", respectively. For each of those properties, if more
7608 * than one part is provided, they must have names listed separated
7609 * by spaces in the data fields. For the default gengrid item
7610 * theme, we have @b one label part (@c "elm.text"), @b two icon
7611 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7614 * A gengrid item may be at one of several styles. Elementary
7615 * provides one by default - "default", but this can be extended by
7616 * system or application custom themes/overlays/extensions (see
7617 * @ref Theme "themes" for more details).
7619 * @section Gengrid_Item_Class Gengrid item classes
7621 * In order to have the ability to add and delete items on the fly,
7622 * gengrid implements a class (callback) system where the
7623 * application provides a structure with information about that
7624 * type of item (gengrid may contain multiple different items with
7625 * different classes, states and styles). Gengrid will call the
7626 * functions in this struct (methods) when an item is "realized"
7627 * (i.e., created dynamically, while the user is scrolling the
7628 * grid). All objects will simply be deleted when no longer needed
7629 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7630 * contains the following members:
7631 * - @c item_style - This is a constant string and simply defines
7632 * the name of the item style. It @b must be specified and the
7633 * default should be @c "default".
7634 * - @c func.label_get - This function is called when an item
7635 * object is actually created. The @c data parameter will point to
7636 * the same data passed to elm_gengrid_item_append() and related
7637 * item creation functions. The @c obj parameter is the gengrid
7638 * object itself, while the @c part one is the name string of one
7639 * of the existing text parts in the Edje group implementing the
7640 * item's theme. This function @b must return a strdup'()ed string,
7641 * as the caller will free() it when done. See
7642 * #Elm_Gengrid_Item_Label_Get_Cb.
7643 * - @c func.icon_get - This function is called when an item object
7644 * is actually created. The @c data parameter will point to the
7645 * same data passed to elm_gengrid_item_append() and related item
7646 * creation functions. The @c obj parameter is the gengrid object
7647 * itself, while the @c part one is the name string of one of the
7648 * existing (icon) swallow parts in the Edje group implementing the
7649 * item's theme. It must return @c NULL, when no icon is desired,
7650 * or a valid object handle, otherwise. The object will be deleted
7651 * by the gengrid on its deletion or when the item is "unrealized".
7652 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7653 * - @c func.state_get - This function is called when an item
7654 * object is actually created. The @c data parameter will point to
7655 * the same data passed to elm_gengrid_item_append() and related
7656 * item creation functions. The @c obj parameter is the gengrid
7657 * object itself, while the @c part one is the name string of one
7658 * of the state parts in the Edje group implementing the item's
7659 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7660 * true/on. Gengrids will emit a signal to its theming Edje object
7661 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7662 * "source" arguments, respectively, when the state is true (the
7663 * default is false), where @c XXX is the name of the (state) part.
7664 * See #Elm_Gengrid_Item_State_Get_Cb.
7665 * - @c func.del - This is called when elm_gengrid_item_del() is
7666 * called on an item or elm_gengrid_clear() is called on the
7667 * gengrid. This is intended for use when gengrid items are
7668 * deleted, so any data attached to the item (e.g. its data
7669 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7671 * @section Gengrid_Usage_Hints Usage hints
7673 * If the user wants to have multiple items selected at the same
7674 * time, elm_gengrid_multi_select_set() will permit it. If the
7675 * gengrid is single-selection only (the default), then
7676 * elm_gengrid_select_item_get() will return the selected item or
7677 * @c NULL, if none is selected. If the gengrid is under
7678 * multi-selection, then elm_gengrid_selected_items_get() will
7679 * return a list (that is only valid as long as no items are
7680 * modified (added, deleted, selected or unselected) of child items
7683 * If an item changes (internal (boolean) state, label or icon
7684 * changes), then use elm_gengrid_item_update() to have gengrid
7685 * update the item with the new state. A gengrid will re-"realize"
7686 * the item, thus calling the functions in the
7687 * #Elm_Gengrid_Item_Class set for that item.
7689 * To programmatically (un)select an item, use
7690 * elm_gengrid_item_selected_set(). To get its selected state use
7691 * elm_gengrid_item_selected_get(). To make an item disabled
7692 * (unable to be selected and appear differently) use
7693 * elm_gengrid_item_disabled_set() to set this and
7694 * elm_gengrid_item_disabled_get() to get the disabled state.
7696 * Grid cells will only have their selection smart callbacks called
7697 * when firstly getting selected. Any further clicks will do
7698 * nothing, unless you enable the "always select mode", with
7699 * elm_gengrid_always_select_mode_set(), thus making every click to
7700 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7701 * turn off the ability to select items entirely in the widget and
7702 * they will neither appear selected nor call the selection smart
7705 * Remember that you can create new styles and add your own theme
7706 * augmentation per application with elm_theme_extension_add(). If
7707 * you absolutely must have a specific style that overrides any
7708 * theme the user or system sets up you can use
7709 * elm_theme_overlay_add() to add such a file.
7711 * @section Gengrid_Smart_Events Gengrid smart events
7713 * Smart events that you can add callbacks for are:
7714 * - @c "activated" - The user has double-clicked or pressed
7715 * (enter|return|spacebar) on an item. The @c event_info parameter
7716 * is the gengrid item that was activated.
7717 * - @c "clicked,double" - The user has double-clicked an item.
7718 * The @c event_info parameter is the gengrid item that was double-clicked.
7719 * - @c "selected" - The user has made an item selected. The
7720 * @c event_info parameter is the gengrid item that was selected.
7721 * - @c "unselected" - The user has made an item unselected. The
7722 * @c event_info parameter is the gengrid item that was unselected.
7723 * - @c "realized" - This is called when the item in the gengrid
7724 * has its implementing Evas object instantiated, de facto. @c
7725 * event_info is the gengrid item that was created. The object
7726 * may be deleted at any time, so it is highly advised to the
7727 * caller @b not to use the object pointer returned from
7728 * elm_gengrid_item_object_get(), because it may point to freed
7730 * - @c "unrealized" - This is called when the implementing Evas
7731 * object for this item is deleted. @c event_info is the gengrid
7732 * item that was deleted.
7733 * - @c "changed" - Called when an item is added, removed, resized
7734 * or moved and when the gengrid is resized or gets "horizontal"
7736 * - @c "drag,start,up" - Called when the item in the gengrid has
7737 * been dragged (not scrolled) up.
7738 * - @c "drag,start,down" - Called when the item in the gengrid has
7739 * been dragged (not scrolled) down.
7740 * - @c "drag,start,left" - Called when the item in the gengrid has
7741 * been dragged (not scrolled) left.
7742 * - @c "drag,start,right" - Called when the item in the gengrid has
7743 * been dragged (not scrolled) right.
7744 * - @c "drag,stop" - Called when the item in the gengrid has
7745 * stopped being dragged.
7746 * - @c "drag" - Called when the item in the gengrid is being
7748 * - @c "scroll" - called when the content has been scrolled
7750 * - @c "scroll,drag,start" - called when dragging the content has
7752 * - @c "scroll,drag,stop" - called when dragging the content has
7755 * List of gendrid examples:
7756 * @li @ref gengrid_example
7760 * @addtogroup Gengrid
7764 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7765 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7766 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7767 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7768 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. */
7769 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. */
7770 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7772 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7773 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7774 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7775 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7778 * @struct _Elm_Gengrid_Item_Class
7780 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7783 struct _Elm_Gengrid_Item_Class
7785 const char *item_style;
7786 struct _Elm_Gengrid_Item_Class_Func
7788 Elm_Gengrid_Item_Label_Get_Cb label_get;
7789 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7790 Elm_Gengrid_Item_State_Get_Cb state_get;
7791 Elm_Gengrid_Item_Del_Cb del;
7793 }; /**< #Elm_Gengrid_Item_Class member definitions */
7796 * Add a new gengrid widget to the given parent Elementary
7797 * (container) object
7799 * @param parent The parent object
7800 * @return a new gengrid widget handle or @c NULL, on errors
7802 * This function inserts a new gengrid widget on the canvas.
7804 * @see elm_gengrid_item_size_set()
7805 * @see elm_gengrid_horizontal_set()
7806 * @see elm_gengrid_item_append()
7807 * @see elm_gengrid_item_del()
7808 * @see elm_gengrid_clear()
7812 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7815 * Set the size for the items of a given gengrid widget
7817 * @param obj The gengrid object.
7818 * @param w The items' width.
7819 * @param h The items' height;
7821 * A gengrid, after creation, has still no information on the size
7822 * to give to each of its cells. So, you most probably will end up
7823 * with squares one @ref Fingers "finger" wide, the default
7824 * size. Use this function to force a custom size for you items,
7825 * making them as big as you wish.
7827 * @see elm_gengrid_item_size_get()
7831 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7834 * Get the size set for the items of a given gengrid widget
7836 * @param obj The gengrid object.
7837 * @param w Pointer to a variable where to store the items' width.
7838 * @param h Pointer to a variable where to store the items' height.
7840 * @note Use @c NULL pointers on the size values you're not
7841 * interested in: they'll be ignored by the function.
7843 * @see elm_gengrid_item_size_get() for more details
7847 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7850 * Set the items grid's alignment within a given gengrid widget
7852 * @param obj The gengrid object.
7853 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7854 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7856 * This sets the alignment of the whole grid of items of a gengrid
7857 * within its given viewport. By default, those values are both
7858 * 0.5, meaning that the gengrid will have its items grid placed
7859 * exactly in the middle of its viewport.
7861 * @note If given alignment values are out of the cited ranges,
7862 * they'll be changed to the nearest boundary values on the valid
7865 * @see elm_gengrid_align_get()
7869 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7872 * Get the items grid's alignment values within a given gengrid
7875 * @param obj The gengrid object.
7876 * @param align_x Pointer to a variable where to store the
7877 * horizontal alignment.
7878 * @param align_y Pointer to a variable where to store the vertical
7881 * @note Use @c NULL pointers on the alignment values you're not
7882 * interested in: they'll be ignored by the function.
7884 * @see elm_gengrid_align_set() for more details
7888 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7891 * Set whether a given gengrid widget is or not able have items
7894 * @param obj The gengrid object
7895 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7896 * @c EINA_FALSE to turn it off
7898 * If a gengrid is set to allow reordering, a click held for more
7899 * than 0.5 over a given item will highlight it specially,
7900 * signalling the gengrid has entered the reordering state. From
7901 * that time on, the user will be able to, while still holding the
7902 * mouse button down, move the item freely in the gengrid's
7903 * viewport, replacing to said item to the locations it goes to.
7904 * The replacements will be animated and, whenever the user
7905 * releases the mouse button, the item being replaced gets a new
7906 * definitive place in the grid.
7908 * @see elm_gengrid_reorder_mode_get()
7912 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7915 * Get whether a given gengrid widget is or not able have items
7918 * @param obj The gengrid object
7919 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7922 * @see elm_gengrid_reorder_mode_set() for more details
7926 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7929 * Append a new item in a given gengrid widget.
7931 * @param obj The gengrid object.
7932 * @param gic The item class for the item.
7933 * @param data The item data.
7934 * @param func Convenience function called when the item is
7936 * @param func_data Data to be passed to @p func.
7937 * @return A handle to the item added or @c NULL, on errors.
7939 * This adds an item to the beginning of the gengrid.
7941 * @see elm_gengrid_item_prepend()
7942 * @see elm_gengrid_item_insert_before()
7943 * @see elm_gengrid_item_insert_after()
7944 * @see elm_gengrid_item_del()
7948 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);
7951 * Prepend a new item in a given gengrid widget.
7953 * @param obj The gengrid object.
7954 * @param gic The item class for the item.
7955 * @param data The item data.
7956 * @param func Convenience function called when the item is
7958 * @param func_data Data to be passed to @p func.
7959 * @return A handle to the item added or @c NULL, on errors.
7961 * This adds an item to the end of the gengrid.
7963 * @see elm_gengrid_item_append()
7964 * @see elm_gengrid_item_insert_before()
7965 * @see elm_gengrid_item_insert_after()
7966 * @see elm_gengrid_item_del()
7970 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);
7973 * Insert an item before another in a gengrid widget
7975 * @param obj The gengrid object.
7976 * @param gic The item class for the item.
7977 * @param data The item data.
7978 * @param relative The item to place this new one before.
7979 * @param func Convenience function called when the item is
7981 * @param func_data Data to be passed to @p func.
7982 * @return A handle to the item added or @c NULL, on errors.
7984 * This inserts an item before another in the gengrid.
7986 * @see elm_gengrid_item_append()
7987 * @see elm_gengrid_item_prepend()
7988 * @see elm_gengrid_item_insert_after()
7989 * @see elm_gengrid_item_del()
7993 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);
7996 * Insert an item after another in a gengrid widget
7998 * @param obj The gengrid object.
7999 * @param gic The item class for the item.
8000 * @param data The item data.
8001 * @param relative The item to place this new one after.
8002 * @param func Convenience function called when the item is
8004 * @param func_data Data to be passed to @p func.
8005 * @return A handle to the item added or @c NULL, on errors.
8007 * This inserts an item after another in the gengrid.
8009 * @see elm_gengrid_item_append()
8010 * @see elm_gengrid_item_prepend()
8011 * @see elm_gengrid_item_insert_after()
8012 * @see elm_gengrid_item_del()
8016 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);
8018 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);
8020 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);
8023 * Set whether items on a given gengrid widget are to get their
8024 * selection callbacks issued for @b every subsequent selection
8025 * click on them or just for the first click.
8027 * @param obj The gengrid object
8028 * @param always_select @c EINA_TRUE to make items "always
8029 * selected", @c EINA_FALSE, otherwise
8031 * By default, grid items will only call their selection callback
8032 * function when firstly getting selected, any subsequent further
8033 * clicks will do nothing. With this call, you make those
8034 * subsequent clicks also to issue the selection callbacks.
8036 * @note <b>Double clicks</b> will @b always be reported on items.
8038 * @see elm_gengrid_always_select_mode_get()
8042 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8045 * Get whether items on a given gengrid widget have their selection
8046 * callbacks issued for @b every subsequent selection click on them
8047 * or just for the first click.
8049 * @param obj The gengrid object.
8050 * @return @c EINA_TRUE if the gengrid items are "always selected",
8051 * @c EINA_FALSE, otherwise
8053 * @see elm_gengrid_always_select_mode_set() for more details
8057 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8060 * Set whether items on a given gengrid widget can be selected or not.
8062 * @param obj The gengrid object
8063 * @param no_select @c EINA_TRUE to make items selectable,
8064 * @c EINA_FALSE otherwise
8066 * This will make items in @p obj selectable or not. In the latter
8067 * case, any user interacion on the gendrid items will neither make
8068 * them appear selected nor them call their selection callback
8071 * @see elm_gengrid_no_select_mode_get()
8075 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8078 * Get whether items on a given gengrid widget can be selected or
8081 * @param obj The gengrid object
8082 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8085 * @see elm_gengrid_no_select_mode_set() for more details
8089 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8092 * Enable or disable multi-selection in a given gengrid widget
8094 * @param obj The gengrid object.
8095 * @param multi @c EINA_TRUE, to enable multi-selection,
8096 * @c EINA_FALSE to disable it.
8098 * Multi-selection is the ability for one to have @b more than one
8099 * item selected, on a given gengrid, simultaneously. When it is
8100 * enabled, a sequence of clicks on different items will make them
8101 * all selected, progressively. A click on an already selected item
8102 * will unselect it. If interecting via the keyboard,
8103 * multi-selection is enabled while holding the "Shift" key.
8105 * @note By default, multi-selection is @b disabled on gengrids
8107 * @see elm_gengrid_multi_select_get()
8111 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8114 * Get whether multi-selection is enabled or disabled for a given
8117 * @param obj The gengrid object.
8118 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8119 * EINA_FALSE otherwise
8121 * @see elm_gengrid_multi_select_set() for more details
8125 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8128 * Enable or disable bouncing effect for a given gengrid widget
8130 * @param obj The gengrid object
8131 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8132 * @c EINA_FALSE to disable it
8133 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8134 * @c EINA_FALSE to disable it
8136 * The bouncing effect occurs whenever one reaches the gengrid's
8137 * edge's while panning it -- it will scroll past its limits a
8138 * little bit and return to the edge again, in a animated for,
8141 * @note By default, gengrids have bouncing enabled on both axis
8143 * @see elm_gengrid_bounce_get()
8147 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8150 * Get whether bouncing effects are enabled or disabled, for a
8151 * given gengrid widget, on each axis
8153 * @param obj The gengrid object
8154 * @param h_bounce Pointer to a variable where to store the
8155 * horizontal bouncing flag.
8156 * @param v_bounce Pointer to a variable where to store the
8157 * vertical bouncing flag.
8159 * @see elm_gengrid_bounce_set() for more details
8163 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8166 * Set a given gengrid widget's scrolling page size, relative to
8167 * its viewport size.
8169 * @param obj The gengrid object
8170 * @param h_pagerel The horizontal page (relative) size
8171 * @param v_pagerel The vertical page (relative) size
8173 * The gengrid's scroller is capable of binding scrolling by the
8174 * user to "pages". It means that, while scrolling and, specially
8175 * after releasing the mouse button, the grid will @b snap to the
8176 * nearest displaying page's area. When page sizes are set, the
8177 * grid's continuous content area is split into (equal) page sized
8180 * This function sets the size of a page <b>relatively to the
8181 * viewport dimensions</b> of the gengrid, for each axis. A value
8182 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8183 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8184 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8185 * 1.0. Values beyond those will make it behave behave
8186 * inconsistently. If you only want one axis to snap to pages, use
8187 * the value @c 0.0 for the other one.
8189 * There is a function setting page size values in @b absolute
8190 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8191 * is mutually exclusive to this one.
8193 * @see elm_gengrid_page_relative_get()
8197 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8200 * Get a given gengrid widget's scrolling page size, relative to
8201 * its viewport size.
8203 * @param obj The gengrid object
8204 * @param h_pagerel Pointer to a variable where to store the
8205 * horizontal page (relative) size
8206 * @param v_pagerel Pointer to a variable where to store the
8207 * vertical page (relative) size
8209 * @see elm_gengrid_page_relative_set() for more details
8213 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8216 * Set a given gengrid widget's scrolling page size
8218 * @param obj The gengrid object
8219 * @param h_pagerel The horizontal page size, in pixels
8220 * @param v_pagerel The vertical page size, in pixels
8222 * The gengrid's scroller is capable of binding scrolling by the
8223 * user to "pages". It means that, while scrolling and, specially
8224 * after releasing the mouse button, the grid will @b snap to the
8225 * nearest displaying page's area. When page sizes are set, the
8226 * grid's continuous content area is split into (equal) page sized
8229 * This function sets the size of a page of the gengrid, in pixels,
8230 * for each axis. Sane usable values are, between @c 0 and the
8231 * dimensions of @p obj, for each axis. Values beyond those will
8232 * make it behave behave inconsistently. If you only want one axis
8233 * to snap to pages, use the value @c 0 for the other one.
8235 * There is a function setting page size values in @b relative
8236 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8237 * use is mutually exclusive to this one.
8241 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8244 * Set for what direction a given gengrid widget will expand while
8245 * placing its items.
8247 * @param obj The gengrid object.
8248 * @param setting @c EINA_TRUE to make the gengrid expand
8249 * horizontally, @c EINA_FALSE to expand vertically.
8251 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8252 * in @b columns, from top to bottom and, when the space for a
8253 * column is filled, another one is started on the right, thus
8254 * expanding the grid horizontally. When in "vertical mode"
8255 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8256 * to right and, when the space for a row is filled, another one is
8257 * started below, thus expanding the grid vertically.
8259 * @see elm_gengrid_horizontal_get()
8263 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8266 * Get for what direction a given gengrid widget will expand while
8267 * placing its items.
8269 * @param obj The gengrid object.
8270 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8271 * @c EINA_FALSE if it's set to expand vertically.
8273 * @see elm_gengrid_horizontal_set() for more detais
8277 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8280 * Get the first item in a given gengrid widget
8282 * @param obj The gengrid object
8283 * @return The first item's handle or @c NULL, if there are no
8284 * items in @p obj (and on errors)
8286 * This returns the first item in the @p obj's internal list of
8289 * @see elm_gengrid_last_item_get()
8293 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8296 * Get the last item in a given gengrid widget
8298 * @param obj The gengrid object
8299 * @return The last item's handle or @c NULL, if there are no
8300 * items in @p obj (and on errors)
8302 * This returns the last item in the @p obj's internal list of
8305 * @see elm_gengrid_first_item_get()
8309 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8312 * Get the @b next item in a gengrid widget's internal list of items,
8313 * given a handle to one of those items.
8315 * @param item The gengrid item to fetch next from
8316 * @return The item after @p item, or @c NULL if there's none (and
8319 * This returns the item placed after the @p item, on the container
8322 * @see elm_gengrid_item_prev_get()
8326 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8329 * Get the @b previous item in a gengrid widget's internal list of items,
8330 * given a handle to one of those items.
8332 * @param item The gengrid item to fetch previous from
8333 * @return The item before @p item, or @c NULL if there's none (and
8336 * This returns the item placed before the @p item, on the container
8339 * @see elm_gengrid_item_next_get()
8343 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8346 * Get the gengrid object's handle which contains a given gengrid
8349 * @param item The item to fetch the container from
8350 * @return The gengrid (parent) object
8352 * This returns the gengrid object itself that an item belongs to.
8356 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8359 * Remove a gengrid item from the its parent, deleting it.
8361 * @param item The item to be removed.
8362 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8364 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8369 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8372 * Update the contents of a given gengrid item
8374 * @param item The gengrid item
8376 * This updates an item by calling all the item class functions
8377 * again to get the icons, labels and states. Use this when the
8378 * original item data has changed and you want thta changes to be
8383 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8384 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8385 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8388 * Return the data associated to a given gengrid item
8390 * @param item The gengrid item.
8391 * @return the data associated to this item.
8393 * This returns the @c data value passed on the
8394 * elm_gengrid_item_append() and related item addition calls.
8396 * @see elm_gengrid_item_append()
8397 * @see elm_gengrid_item_data_set()
8401 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8404 * Set the data associated to a given gengrid item
8406 * @param item The gengrid item
8407 * @param data The new data pointer to set on it
8409 * This @b overrides the @c data value passed on the
8410 * elm_gengrid_item_append() and related item addition calls. This
8411 * function @b won't call elm_gengrid_item_update() automatically,
8412 * so you'd issue it afterwards if you want to hove the item
8413 * updated to reflect the that new data.
8415 * @see elm_gengrid_item_data_get()
8419 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8422 * Get a given gengrid item's position, relative to the whole
8423 * gengrid's grid area.
8425 * @param item The Gengrid item.
8426 * @param x Pointer to variable where to store the item's <b>row
8428 * @param y Pointer to variable where to store the item's <b>column
8431 * This returns the "logical" position of the item whithin the
8432 * gengrid. For example, @c (0, 1) would stand for first row,
8437 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8440 * Set whether a given gengrid item is selected or not
8442 * @param item The gengrid item
8443 * @param selected Use @c EINA_TRUE, to make it selected, @c
8444 * EINA_FALSE to make it unselected
8446 * This sets the selected state of an item. If multi selection is
8447 * not enabled on the containing gengrid and @p selected is @c
8448 * EINA_TRUE, any other previously selected items will get
8449 * unselected in favor of this new one.
8451 * @see elm_gengrid_item_selected_get()
8455 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8458 * Get whether a given gengrid item is selected or not
8460 * @param item The gengrid item
8461 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8463 * @see elm_gengrid_item_selected_set() for more details
8467 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8470 * Get the real Evas object created to implement the view of a
8471 * given gengrid item
8473 * @param item The gengrid item.
8474 * @return the Evas object implementing this item's view.
8476 * This returns the actual Evas object used to implement the
8477 * specified gengrid item's view. This may be @c NULL, as it may
8478 * not have been created or may have been deleted, at any time, by
8479 * the gengrid. <b>Do not modify this object</b> (move, resize,
8480 * show, hide, etc.), as the gengrid is controlling it. This
8481 * function is for querying, emitting custom signals or hooking
8482 * lower level callbacks for events on that object. Do not delete
8483 * this object under any circumstances.
8485 * @see elm_gengrid_item_data_get()
8489 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8492 * Show the portion of a gengrid's internal grid containing a given
8493 * item, @b immediately.
8495 * @param item The item to display
8497 * This causes gengrid to @b redraw its viewport's contents to the
8498 * region contining the given @p item item, if it is not fully
8501 * @see elm_gengrid_item_bring_in()
8505 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8508 * Animatedly bring in, to the visible are of a gengrid, a given
8511 * @param item The gengrid item to display
8513 * This causes gengrig to jump to the given @p item item and show
8514 * it (by scrolling), if it is not fully visible. This will use
8515 * animation to do so and take a period of time to complete.
8517 * @see elm_gengrid_item_show()
8521 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8524 * Set whether a given gengrid item is disabled or not.
8526 * @param item The gengrid item
8527 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8528 * to enable it back.
8530 * A disabled item cannot be selected or unselected. It will also
8531 * change its appearance, to signal the user it's disabled.
8533 * @see elm_gengrid_item_disabled_get()
8537 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8540 * Get whether a given gengrid item is disabled or not.
8542 * @param item The gengrid item
8543 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8546 * @see elm_gengrid_item_disabled_set() for more details
8550 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8553 * Set the text to be shown in a given gengrid item's tooltips.
8555 * @param item The gengrid item
8556 * @param text The text to set in the content
8558 * This call will setup the text to be used as tooltip to that item
8559 * (analogous to elm_object_tooltip_text_set(), but being item
8560 * tooltips with higher precedence than object tooltips). It can
8561 * have only one tooltip at a time, so any previous tooltip data
8566 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8569 * Set the content to be shown in a given gengrid item's tooltips
8571 * @param item The gengrid item.
8572 * @param func The function returning the tooltip contents.
8573 * @param data What to provide to @a func as callback data/context.
8574 * @param del_cb Called when data is not needed anymore, either when
8575 * another callback replaces @p func, the tooltip is unset with
8576 * elm_gengrid_item_tooltip_unset() or the owner @p item
8577 * dies. This callback receives as its first parameter the
8578 * given @p data, being @c event_info the item handle.
8580 * This call will setup the tooltip's contents to @p item
8581 * (analogous to elm_object_tooltip_content_cb_set(), but being
8582 * item tooltips with higher precedence than object tooltips). It
8583 * can have only one tooltip at a time, so any previous tooltip
8584 * content will get removed. @p func (with @p data) will be called
8585 * every time Elementary needs to show the tooltip and it should
8586 * return a valid Evas object, which will be fully managed by the
8587 * tooltip system, getting deleted when the tooltip is gone.
8591 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);
8594 * Unset a tooltip from a given gengrid item
8596 * @param item gengrid item to remove a previously set tooltip from.
8598 * This call removes any tooltip set on @p item. The callback
8599 * provided as @c del_cb to
8600 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8601 * notify it is not used anymore (and have resources cleaned, if
8604 * @see elm_gengrid_item_tooltip_content_cb_set()
8608 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8611 * Set a different @b style for a given gengrid item's tooltip.
8613 * @param item gengrid item with tooltip set
8614 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8615 * "default", @c "transparent", etc)
8617 * Tooltips can have <b>alternate styles</b> to be displayed on,
8618 * which are defined by the theme set on Elementary. This function
8619 * works analogously as elm_object_tooltip_style_set(), but here
8620 * applied only to gengrid item objects. The default style for
8621 * tooltips is @c "default".
8623 * @note before you set a style you should define a tooltip with
8624 * elm_gengrid_item_tooltip_content_cb_set() or
8625 * elm_gengrid_item_tooltip_text_set()
8627 * @see elm_gengrid_item_tooltip_style_get()
8631 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8634 * Get the style set a given gengrid item's tooltip.
8636 * @param item gengrid item with tooltip already set on.
8637 * @return style the theme style in use, which defaults to
8638 * "default". If the object does not have a tooltip set,
8639 * then @c NULL is returned.
8641 * @see elm_gengrid_item_tooltip_style_set() for more details
8645 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8647 * @brief Disable size restrictions on an object's tooltip
8648 * @param item The tooltip's anchor object
8649 * @param disable If EINA_TRUE, size restrictions are disabled
8650 * @return EINA_FALSE on failure, EINA_TRUE on success
8652 * This function allows a tooltip to expand beyond its parant window's canvas.
8653 * It will instead be limited only by the size of the display.
8655 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8657 * @brief Retrieve size restriction state of an object's tooltip
8658 * @param item The tooltip's anchor object
8659 * @return If EINA_TRUE, size restrictions are disabled
8661 * This function returns whether a tooltip is allowed to expand beyond
8662 * its parant window's canvas.
8663 * It will instead be limited only by the size of the display.
8665 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8667 * Set the type of mouse pointer/cursor decoration to be shown,
8668 * when the mouse pointer is over the given gengrid widget item
8670 * @param item gengrid item to customize cursor on
8671 * @param cursor the cursor type's name
8673 * This function works analogously as elm_object_cursor_set(), but
8674 * here the cursor's changing area is restricted to the item's
8675 * area, and not the whole widget's. Note that that item cursors
8676 * have precedence over widget cursors, so that a mouse over @p
8677 * item will always show cursor @p type.
8679 * If this function is called twice for an object, a previously set
8680 * cursor will be unset on the second call.
8682 * @see elm_object_cursor_set()
8683 * @see elm_gengrid_item_cursor_get()
8684 * @see elm_gengrid_item_cursor_unset()
8688 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8691 * Get the type of mouse pointer/cursor decoration set to be shown,
8692 * when the mouse pointer is over the given gengrid widget item
8694 * @param item gengrid item with custom cursor set
8695 * @return the cursor type's name or @c NULL, if no custom cursors
8696 * were set to @p item (and on errors)
8698 * @see elm_object_cursor_get()
8699 * @see elm_gengrid_item_cursor_set() for more details
8700 * @see elm_gengrid_item_cursor_unset()
8704 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8707 * Unset any custom mouse pointer/cursor decoration set to be
8708 * shown, when the mouse pointer is over the given gengrid widget
8709 * item, thus making it show the @b default cursor again.
8711 * @param item a gengrid item
8713 * Use this call to undo any custom settings on this item's cursor
8714 * decoration, bringing it back to defaults (no custom style set).
8716 * @see elm_object_cursor_unset()
8717 * @see elm_gengrid_item_cursor_set() for more details
8721 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8724 * Set a different @b style for a given custom cursor set for a
8727 * @param item gengrid item with custom cursor set
8728 * @param style the <b>theme style</b> to use (e.g. @c "default",
8729 * @c "transparent", etc)
8731 * This function only makes sense when one is using custom mouse
8732 * cursor decorations <b>defined in a theme file</b> , which can
8733 * have, given a cursor name/type, <b>alternate styles</b> on
8734 * it. It works analogously as elm_object_cursor_style_set(), but
8735 * here applied only to gengrid item objects.
8737 * @warning Before you set a cursor style you should have defined a
8738 * custom cursor previously on the item, with
8739 * elm_gengrid_item_cursor_set()
8741 * @see elm_gengrid_item_cursor_engine_only_set()
8742 * @see elm_gengrid_item_cursor_style_get()
8746 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8749 * Get the current @b style set for a given gengrid item's custom
8752 * @param item gengrid item with custom cursor set.
8753 * @return style the cursor style in use. If the object does not
8754 * have a cursor set, then @c NULL is returned.
8756 * @see elm_gengrid_item_cursor_style_set() for more details
8760 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8763 * Set if the (custom) cursor for a given gengrid item should be
8764 * searched in its theme, also, or should only rely on the
8767 * @param item item with custom (custom) cursor already set on
8768 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8769 * only on those provided by the rendering engine, @c EINA_FALSE to
8770 * have them searched on the widget's theme, as well.
8772 * @note This call is of use only if you've set a custom cursor
8773 * for gengrid items, with elm_gengrid_item_cursor_set().
8775 * @note By default, cursors will only be looked for between those
8776 * provided by the rendering engine.
8780 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8783 * Get if the (custom) cursor for a given gengrid item is being
8784 * searched in its theme, also, or is only relying on the rendering
8787 * @param item a gengrid item
8788 * @return @c EINA_TRUE, if cursors are being looked for only on
8789 * those provided by the rendering engine, @c EINA_FALSE if they
8790 * are being searched on the widget's theme, as well.
8792 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8796 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8799 * Remove all items from a given gengrid widget
8801 * @param obj The gengrid object.
8803 * This removes (and deletes) all items in @p obj, leaving it
8806 * @see elm_gengrid_item_del(), to remove just one item.
8810 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8813 * Get the selected item in a given gengrid widget
8815 * @param obj The gengrid object.
8816 * @return The selected item's handleor @c NULL, if none is
8817 * selected at the moment (and on errors)
8819 * This returns the selected item in @p obj. If multi selection is
8820 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8821 * the first item in the list is selected, which might not be very
8822 * useful. For that case, see elm_gengrid_selected_items_get().
8826 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8829 * Get <b>a list</b> of selected items in a given gengrid
8831 * @param obj The gengrid object.
8832 * @return The list of selected items or @c NULL, if none is
8833 * selected at the moment (and on errors)
8835 * This returns a list of the selected items, in the order that
8836 * they appear in the grid. This list is only valid as long as no
8837 * more items are selected or unselected (or unselected implictly
8838 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8841 * @see elm_gengrid_selected_item_get()
8845 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8852 * @defgroup Clock Clock
8854 * @image html img/widget/clock/preview-00.png
8855 * @image latex img/widget/clock/preview-00.eps
8857 * This is a @b digital clock widget. In its default theme, it has a
8858 * vintage "flipping numbers clock" appearance, which will animate
8859 * sheets of individual algarisms individually as time goes by.
8861 * A newly created clock will fetch system's time (already
8862 * considering local time adjustments) to start with, and will tick
8863 * accondingly. It may or may not show seconds.
8865 * Clocks have an @b edition mode. When in it, the sheets will
8866 * display extra arrow indications on the top and bottom and the
8867 * user may click on them to raise or lower the time values. After
8868 * it's told to exit edition mode, it will keep ticking with that
8869 * new time set (it keeps the difference from local time).
8871 * Also, when under edition mode, user clicks on the cited arrows
8872 * which are @b held for some time will make the clock to flip the
8873 * sheet, thus editing the time, continuosly and automatically for
8874 * the user. The interval between sheet flips will keep growing in
8875 * time, so that it helps the user to reach a time which is distant
8878 * The time display is, by default, in military mode (24h), but an
8879 * am/pm indicator may be optionally shown, too, when it will
8882 * Smart callbacks one can register to:
8883 * - "changed" - the clock's user changed the time
8885 * Here is an example on its usage:
8886 * @li @ref clock_example
8895 * Identifiers for which clock digits should be editable, when a
8896 * clock widget is in edition mode. Values may be ORed together to
8897 * make a mask, naturally.
8899 * @see elm_clock_edit_set()
8900 * @see elm_clock_digit_edit_set()
8902 typedef enum _Elm_Clock_Digedit
8904 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8905 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8906 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8907 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8908 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8909 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8910 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8911 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8912 } Elm_Clock_Digedit;
8915 * Add a new clock widget to the given parent Elementary
8916 * (container) object
8918 * @param parent The parent object
8919 * @return a new clock widget handle or @c NULL, on errors
8921 * This function inserts a new clock widget on the canvas.
8925 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8928 * Set a clock widget's time, programmatically
8930 * @param obj The clock widget object
8931 * @param hrs The hours to set
8932 * @param min The minutes to set
8933 * @param sec The secondes to set
8935 * This function updates the time that is showed by the clock
8938 * Values @b must be set within the following ranges:
8939 * - 0 - 23, for hours
8940 * - 0 - 59, for minutes
8941 * - 0 - 59, for seconds,
8943 * even if the clock is not in "military" mode.
8945 * @warning The behavior for values set out of those ranges is @b
8950 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8953 * Get a clock widget's time values
8955 * @param obj The clock object
8956 * @param[out] hrs Pointer to the variable to get the hours value
8957 * @param[out] min Pointer to the variable to get the minutes value
8958 * @param[out] sec Pointer to the variable to get the seconds value
8960 * This function gets the time set for @p obj, returning
8961 * it on the variables passed as the arguments to function
8963 * @note Use @c NULL pointers on the time values you're not
8964 * interested in: they'll be ignored by the function.
8968 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8971 * Set whether a given clock widget is under <b>edition mode</b> or
8972 * under (default) displaying-only mode.
8974 * @param obj The clock object
8975 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8976 * put it back to "displaying only" mode
8978 * This function makes a clock's time to be editable or not <b>by
8979 * user interaction</b>. When in edition mode, clocks @b stop
8980 * ticking, until one brings them back to canonical mode. The
8981 * elm_clock_digit_edit_set() function will influence which digits
8982 * of the clock will be editable. By default, all of them will be
8983 * (#ELM_CLOCK_NONE).
8985 * @note am/pm sheets, if being shown, will @b always be editable
8986 * under edition mode.
8988 * @see elm_clock_edit_get()
8992 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8995 * Retrieve whether a given clock widget is under <b>edition
8996 * mode</b> or under (default) displaying-only mode.
8998 * @param obj The clock object
8999 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9002 * This function retrieves whether the clock's time can be edited
9003 * or not by user interaction.
9005 * @see elm_clock_edit_set() for more details
9009 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9012 * Set what digits of the given clock widget should be editable
9013 * when in edition mode.
9015 * @param obj The clock object
9016 * @param digedit Bit mask indicating the digits to be editable
9017 * (values in #Elm_Clock_Digedit).
9019 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9020 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9023 * @see elm_clock_digit_edit_get()
9027 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9030 * Retrieve what digits of the given clock widget should be
9031 * editable when in edition mode.
9033 * @param obj The clock object
9034 * @return Bit mask indicating the digits to be editable
9035 * (values in #Elm_Clock_Digedit).
9037 * @see elm_clock_digit_edit_set() for more details
9041 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9044 * Set if the given clock widget must show hours in military or
9047 * @param obj The clock object
9048 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9051 * This function sets if the clock must show hours in military or
9052 * am/pm mode. In some countries like Brazil the military mode
9053 * (00-24h-format) is used, in opposition to the USA, where the
9054 * am/pm mode is more commonly used.
9056 * @see elm_clock_show_am_pm_get()
9060 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9063 * Get if the given clock widget shows hours in military or am/pm
9066 * @param obj The clock object
9067 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9070 * This function gets if the clock shows hours in military or am/pm
9073 * @see elm_clock_show_am_pm_set() for more details
9077 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9080 * Set if the given clock widget must show time with seconds or not
9082 * @param obj The clock object
9083 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9085 * This function sets if the given clock must show or not elapsed
9086 * seconds. By default, they are @b not shown.
9088 * @see elm_clock_show_seconds_get()
9092 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9095 * Get whether the given clock widget is showing time with seconds
9098 * @param obj The clock object
9099 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9101 * This function gets whether @p obj is showing or not the elapsed
9104 * @see elm_clock_show_seconds_set()
9108 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9111 * Set the interval on time updates for an user mouse button hold
9112 * on clock widgets' time edition.
9114 * @param obj The clock object
9115 * @param interval The (first) interval value in seconds
9117 * This interval value is @b decreased while the user holds the
9118 * mouse pointer either incrementing or decrementing a given the
9119 * clock digit's value.
9121 * This helps the user to get to a given time distant from the
9122 * current one easier/faster, as it will start to flip quicker and
9123 * quicker on mouse button holds.
9125 * The calculation for the next flip interval value, starting from
9126 * the one set with this call, is the previous interval divided by
9127 * 1.05, so it decreases a little bit.
9129 * The default starting interval value for automatic flips is
9132 * @see elm_clock_interval_get()
9136 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9139 * Get the interval on time updates for an user mouse button hold
9140 * on clock widgets' time edition.
9142 * @param obj The clock object
9143 * @return The (first) interval value, in seconds, set on it
9145 * @see elm_clock_interval_set() for more details
9149 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9156 * @defgroup Layout Layout
9158 * @image html img/widget/layout/preview-00.png
9159 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9161 * @image html img/layout-predefined.png
9162 * @image latex img/layout-predefined.eps width=\textwidth
9164 * This is a container widget that takes a standard Edje design file and
9165 * wraps it very thinly in a widget.
9167 * An Edje design (theme) file has a very wide range of possibilities to
9168 * describe the behavior of elements added to the Layout. Check out the Edje
9169 * documentation and the EDC reference to get more information about what can
9170 * be done with Edje.
9172 * Just like @ref List, @ref Box, and other container widgets, any
9173 * object added to the Layout will become its child, meaning that it will be
9174 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9176 * The Layout widget can contain as many Contents, Boxes or Tables as
9177 * described in its theme file. For instance, objects can be added to
9178 * different Tables by specifying the respective Table part names. The same
9179 * is valid for Content and Box.
9181 * The objects added as child of the Layout will behave as described in the
9182 * part description where they were added. There are 3 possible types of
9183 * parts where a child can be added:
9185 * @section secContent Content (SWALLOW part)
9187 * Only one object can be added to the @c SWALLOW part (but you still can
9188 * have many @c SWALLOW parts and one object on each of them). Use the @c
9189 * elm_layout_content_* set of functions to set, retrieve and unset objects
9190 * as content of the @c SWALLOW. After being set to this part, the object
9191 * size, position, visibility, clipping and other description properties
9192 * will be totally controled by the description of the given part (inside
9193 * the Edje theme file).
9195 * One can use @c evas_object_size_hint_* functions on the child to have some
9196 * kind of control over its behavior, but the resulting behavior will still
9197 * depend heavily on the @c SWALLOW part description.
9199 * The Edje theme also can change the part description, based on signals or
9200 * scripts running inside the theme. This change can also be animated. All of
9201 * this will affect the child object set as content accordingly. The object
9202 * size will be changed if the part size is changed, it will animate move if
9203 * the part is moving, and so on.
9205 * The following picture demonstrates a Layout widget with a child object
9206 * added to its @c SWALLOW:
9208 * @image html layout_swallow.png
9209 * @image latex layout_swallow.eps width=\textwidth
9211 * @section secBox Box (BOX part)
9213 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9214 * allows one to add objects to the box and have them distributed along its
9215 * area, accordingly to the specified @a layout property (now by @a layout we
9216 * mean the chosen layouting design of the Box, not the Layout widget
9219 * A similar effect for having a box with its position, size and other things
9220 * controled by the Layout theme would be to create an Elementary @ref Box
9221 * widget and add it as a Content in the @c SWALLOW part.
9223 * The main difference of using the Layout Box is that its behavior, the box
9224 * properties like layouting format, padding, align, etc. will be all
9225 * controled by the theme. This means, for example, that a signal could be
9226 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9227 * handled the signal by changing the box padding, or align, or both. Using
9228 * the Elementary @ref Box widget is not necessarily harder or easier, it
9229 * just depends on the circunstances and requirements.
9231 * The Layout Box can be used through the @c elm_layout_box_* set of
9234 * The following picture demonstrates a Layout widget with many child objects
9235 * added to its @c BOX part:
9237 * @image html layout_box.png
9238 * @image latex layout_box.eps width=\textwidth
9240 * @section secTable Table (TABLE part)
9242 * Just like the @ref secBox, the Layout Table is very similar to the
9243 * Elementary @ref Table widget. It allows one to add objects to the Table
9244 * specifying the row and column where the object should be added, and any
9245 * column or row span if necessary.
9247 * Again, we could have this design by adding a @ref Table widget to the @c
9248 * SWALLOW part using elm_layout_content_set(). The same difference happens
9249 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9250 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9252 * The Layout Table can be used through the @c elm_layout_table_* set of
9255 * The following picture demonstrates a Layout widget with many child objects
9256 * added to its @c TABLE part:
9258 * @image html layout_table.png
9259 * @image latex layout_table.eps width=\textwidth
9261 * @section secPredef Predefined Layouts
9263 * Another interesting thing about the Layout widget is that it offers some
9264 * predefined themes that come with the default Elementary theme. These
9265 * themes can be set by the call elm_layout_theme_set(), and provide some
9266 * basic functionality depending on the theme used.
9268 * Most of them already send some signals, some already provide a toolbar or
9269 * back and next buttons.
9271 * These are available predefined theme layouts. All of them have class = @c
9272 * layout, group = @c application, and style = one of the following options:
9274 * @li @c toolbar-content - application with toolbar and main content area
9275 * @li @c toolbar-content-back - application with toolbar and main content
9276 * area with a back button and title area
9277 * @li @c toolbar-content-back-next - application with toolbar and main
9278 * content area with a back and next buttons and title area
9279 * @li @c content-back - application with a main content area with a back
9280 * button and title area
9281 * @li @c content-back-next - application with a main content area with a
9282 * back and next buttons and title area
9283 * @li @c toolbar-vbox - application with toolbar and main content area as a
9285 * @li @c toolbar-table - application with toolbar and main content area as a
9288 * @section secExamples Examples
9290 * Some examples of the Layout widget can be found here:
9291 * @li @ref layout_example_01
9292 * @li @ref layout_example_02
9293 * @li @ref layout_example_03
9294 * @li @ref layout_example_edc
9299 * Add a new layout to the parent
9301 * @param parent The parent object
9302 * @return The new object or NULL if it cannot be created
9304 * @see elm_layout_file_set()
9305 * @see elm_layout_theme_set()
9309 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9311 * Set the file that will be used as layout
9313 * @param obj The layout object
9314 * @param file The path to file (edj) that will be used as layout
9315 * @param group The group that the layout belongs in edje file
9317 * @return (1 = success, 0 = error)
9321 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9323 * Set the edje group from the elementary theme that will be used as layout
9325 * @param obj The layout object
9326 * @param clas the clas of the group
9327 * @param group the group
9328 * @param style the style to used
9330 * @return (1 = success, 0 = error)
9334 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9336 * Set the layout content.
9338 * @param obj The layout object
9339 * @param swallow The swallow part name in the edje file
9340 * @param content The child that will be added in this layout object
9342 * Once the content object is set, a previously set one will be deleted.
9343 * If you want to keep that old content object, use the
9344 * elm_layout_content_unset() function.
9346 * @note In an Edje theme, the part used as a content container is called @c
9347 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9348 * expected to be a part name just like the second parameter of
9349 * elm_layout_box_append().
9351 * @see elm_layout_box_append()
9352 * @see elm_layout_content_get()
9353 * @see elm_layout_content_unset()
9358 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9360 * Get the child object in the given content part.
9362 * @param obj The layout object
9363 * @param swallow The SWALLOW part to get its content
9365 * @return The swallowed object or NULL if none or an error occurred
9367 * @see elm_layout_content_set()
9371 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9373 * Unset the layout content.
9375 * @param obj The layout object
9376 * @param swallow The swallow part name in the edje file
9377 * @return The content that was being used
9379 * Unparent and return the content object which was set for this part.
9381 * @see elm_layout_content_set()
9385 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9387 * Set the text of the given part
9389 * @param obj The layout object
9390 * @param part The TEXT part where to set the text
9391 * @param text The text to set
9394 * @deprecated use elm_object_text_* instead.
9396 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9398 * Get the text set in the given part
9400 * @param obj The layout object
9401 * @param part The TEXT part to retrieve the text off
9403 * @return The text set in @p part
9406 * @deprecated use elm_object_text_* instead.
9408 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9410 * Append child to layout box part.
9412 * @param obj the layout object
9413 * @param part the box part to which the object will be appended.
9414 * @param child the child object to append to box.
9416 * Once the object is appended, it will become child of the layout. Its
9417 * lifetime will be bound to the layout, whenever the layout dies the child
9418 * will be deleted automatically. One should use elm_layout_box_remove() to
9419 * make this layout forget about the object.
9421 * @see elm_layout_box_prepend()
9422 * @see elm_layout_box_insert_before()
9423 * @see elm_layout_box_insert_at()
9424 * @see elm_layout_box_remove()
9428 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9430 * Prepend child to layout box part.
9432 * @param obj the layout object
9433 * @param part the box part to prepend.
9434 * @param child the child object to prepend to box.
9436 * Once the object is prepended, it will become child of the layout. Its
9437 * lifetime will be bound to the layout, whenever the layout dies the child
9438 * will be deleted automatically. One should use elm_layout_box_remove() to
9439 * make this layout forget about the object.
9441 * @see elm_layout_box_append()
9442 * @see elm_layout_box_insert_before()
9443 * @see elm_layout_box_insert_at()
9444 * @see elm_layout_box_remove()
9448 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9450 * Insert child to layout box part before a reference object.
9452 * @param obj the layout object
9453 * @param part the box part to insert.
9454 * @param child the child object to insert into box.
9455 * @param reference another reference object to insert before in box.
9457 * Once the object is inserted, it will become child of the layout. Its
9458 * lifetime will be bound to the layout, whenever the layout dies the child
9459 * will be deleted automatically. One should use elm_layout_box_remove() to
9460 * make this layout forget about the object.
9462 * @see elm_layout_box_append()
9463 * @see elm_layout_box_prepend()
9464 * @see elm_layout_box_insert_before()
9465 * @see elm_layout_box_remove()
9469 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9471 * Insert child to layout box part at a given position.
9473 * @param obj the layout object
9474 * @param part the box part to insert.
9475 * @param child the child object to insert into box.
9476 * @param pos the numeric position >=0 to insert the child.
9478 * Once the object is inserted, it will become child of the layout. Its
9479 * lifetime will be bound to the layout, whenever the layout dies the child
9480 * will be deleted automatically. One should use elm_layout_box_remove() to
9481 * make this layout forget about the object.
9483 * @see elm_layout_box_append()
9484 * @see elm_layout_box_prepend()
9485 * @see elm_layout_box_insert_before()
9486 * @see elm_layout_box_remove()
9490 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9492 * Remove a child of the given part box.
9494 * @param obj The layout object
9495 * @param part The box part name to remove child.
9496 * @param child The object to remove from box.
9497 * @return The object that was being used, or NULL if not found.
9499 * The object will be removed from the box part and its lifetime will
9500 * not be handled by the layout anymore. This is equivalent to
9501 * elm_layout_content_unset() for box.
9503 * @see elm_layout_box_append()
9504 * @see elm_layout_box_remove_all()
9508 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9510 * Remove all child of the given part box.
9512 * @param obj The layout object
9513 * @param part The box part name to remove child.
9514 * @param clear If EINA_TRUE, then all objects will be deleted as
9515 * well, otherwise they will just be removed and will be
9516 * dangling on the canvas.
9518 * The objects will be removed from the box part and their lifetime will
9519 * not be handled by the layout anymore. This is equivalent to
9520 * elm_layout_box_remove() for all box children.
9522 * @see elm_layout_box_append()
9523 * @see elm_layout_box_remove()
9527 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9529 * Insert child to layout table part.
9531 * @param obj the layout object
9532 * @param part the box part to pack child.
9533 * @param child_obj the child object to pack into table.
9534 * @param col the column to which the child should be added. (>= 0)
9535 * @param row the row to which the child should be added. (>= 0)
9536 * @param colspan how many columns should be used to store this object. (>=
9538 * @param rowspan how many rows should be used to store this object. (>= 1)
9540 * Once the object is inserted, it will become child of the table. Its
9541 * lifetime will be bound to the layout, and whenever the layout dies the
9542 * child will be deleted automatically. One should use
9543 * elm_layout_table_remove() to make this layout forget about the object.
9545 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9546 * more space than a single cell. For instance, the following code:
9548 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9551 * Would result in an object being added like the following picture:
9553 * @image html layout_colspan.png
9554 * @image latex layout_colspan.eps width=\textwidth
9556 * @see elm_layout_table_unpack()
9557 * @see elm_layout_table_clear()
9561 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);
9563 * Unpack (remove) a child of the given part table.
9565 * @param obj The layout object
9566 * @param part The table part name to remove child.
9567 * @param child_obj The object to remove from table.
9568 * @return The object that was being used, or NULL if not found.
9570 * The object will be unpacked from the table part and its lifetime
9571 * will not be handled by the layout anymore. This is equivalent to
9572 * elm_layout_content_unset() for table.
9574 * @see elm_layout_table_pack()
9575 * @see elm_layout_table_clear()
9579 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9581 * Remove all child of the given part table.
9583 * @param obj The layout object
9584 * @param part The table part name to remove child.
9585 * @param clear If EINA_TRUE, then all objects will be deleted as
9586 * well, otherwise they will just be removed and will be
9587 * dangling on the canvas.
9589 * The objects will be removed from the table part and their lifetime will
9590 * not be handled by the layout anymore. This is equivalent to
9591 * elm_layout_table_unpack() for all table children.
9593 * @see elm_layout_table_pack()
9594 * @see elm_layout_table_unpack()
9598 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9600 * Get the edje layout
9602 * @param obj The layout object
9604 * @return A Evas_Object with the edje layout settings loaded
9605 * with function elm_layout_file_set
9607 * This returns the edje object. It is not expected to be used to then
9608 * swallow objects via edje_object_part_swallow() for example. Use
9609 * elm_layout_content_set() instead so child object handling and sizing is
9612 * @note This function should only be used if you really need to call some
9613 * low level Edje function on this edje object. All the common stuff (setting
9614 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9615 * with proper elementary functions.
9617 * @see elm_object_signal_callback_add()
9618 * @see elm_object_signal_emit()
9619 * @see elm_object_text_part_set()
9620 * @see elm_layout_content_set()
9621 * @see elm_layout_box_append()
9622 * @see elm_layout_table_pack()
9623 * @see elm_layout_data_get()
9627 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9629 * Get the edje data from the given layout
9631 * @param obj The layout object
9632 * @param key The data key
9634 * @return The edje data string
9636 * This function fetches data specified inside the edje theme of this layout.
9637 * This function return NULL if data is not found.
9639 * In EDC this comes from a data block within the group block that @p
9640 * obj was loaded from. E.g.
9647 * item: "key1" "value1";
9648 * item: "key2" "value2";
9656 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9660 * @param obj The layout object
9662 * Manually forces a sizing re-evaluation. This is useful when the minimum
9663 * size required by the edje theme of this layout has changed. The change on
9664 * the minimum size required by the edje theme is not immediately reported to
9665 * the elementary layout, so one needs to call this function in order to tell
9666 * the widget (layout) that it needs to reevaluate its own size.
9668 * The minimum size of the theme is calculated based on minimum size of
9669 * parts, the size of elements inside containers like box and table, etc. All
9670 * of this can change due to state changes, and that's when this function
9673 * Also note that a standard signal of "size,eval" "elm" emitted from the
9674 * edje object will cause this to happen too.
9678 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9681 * Sets a specific cursor for an edje part.
9683 * @param obj The layout object.
9684 * @param part_name a part from loaded edje group.
9685 * @param cursor cursor name to use, see Elementary_Cursor.h
9687 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9688 * part not exists or it has "mouse_events: 0".
9692 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9695 * Get the cursor to be shown when mouse is over an edje part
9697 * @param obj The layout object.
9698 * @param part_name a part from loaded edje group.
9699 * @return the cursor name.
9703 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9706 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9708 * @param obj The layout object.
9709 * @param part_name a part from loaded edje group, that had a cursor set
9710 * with elm_layout_part_cursor_set().
9714 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9717 * Sets a specific cursor style for an edje part.
9719 * @param obj The layout object.
9720 * @param part_name a part from loaded edje group.
9721 * @param style the theme style to use (default, transparent, ...)
9723 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9724 * part not exists or it did not had a cursor set.
9728 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9731 * Gets a specific cursor style for an edje part.
9733 * @param obj The layout object.
9734 * @param part_name a part from loaded edje group.
9736 * @return the theme style in use, defaults to "default". If the
9737 * object does not have a cursor set, then NULL is returned.
9741 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9744 * Sets if the cursor set should be searched on the theme or should use
9745 * the provided by the engine, only.
9747 * @note before you set if should look on theme you should define a
9748 * cursor with elm_layout_part_cursor_set(). By default it will only
9749 * look for cursors provided by the engine.
9751 * @param obj The layout object.
9752 * @param part_name a part from loaded edje group.
9753 * @param engine_only if cursors should be just provided by the engine
9754 * or should also search on widget's theme as well
9756 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9757 * part not exists or it did not had a cursor set.
9761 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);
9764 * Gets a specific cursor engine_only for an edje part.
9766 * @param obj The layout object.
9767 * @param part_name a part from loaded edje group.
9769 * @return whenever the cursor is just provided by engine or also from theme.
9773 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9776 * @def elm_layout_icon_set
9777 * Convienience macro to set the icon object in a layout that follows the
9778 * Elementary naming convention for its parts.
9782 #define elm_layout_icon_set(_ly, _obj) \
9785 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9786 if ((_obj)) sig = "elm,state,icon,visible"; \
9787 else sig = "elm,state,icon,hidden"; \
9788 elm_object_signal_emit((_ly), sig, "elm"); \
9792 * @def elm_layout_icon_get
9793 * Convienience macro to get the icon object from a layout that follows the
9794 * Elementary naming convention for its parts.
9798 #define elm_layout_icon_get(_ly) \
9799 elm_layout_content_get((_ly), "elm.swallow.icon")
9802 * @def elm_layout_end_set
9803 * Convienience macro to set the end object in a layout that follows the
9804 * Elementary naming convention for its parts.
9808 #define elm_layout_end_set(_ly, _obj) \
9811 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9812 if ((_obj)) sig = "elm,state,end,visible"; \
9813 else sig = "elm,state,end,hidden"; \
9814 elm_object_signal_emit((_ly), sig, "elm"); \
9818 * @def elm_layout_end_get
9819 * Convienience macro to get the end object in a layout that follows the
9820 * Elementary naming convention for its parts.
9824 #define elm_layout_end_get(_ly) \
9825 elm_layout_content_get((_ly), "elm.swallow.end")
9828 * @def elm_layout_label_set
9829 * Convienience macro to set the label in a layout that follows the
9830 * Elementary naming convention for its parts.
9833 * @deprecated use elm_object_text_* instead.
9835 #define elm_layout_label_set(_ly, _txt) \
9836 elm_layout_text_set((_ly), "elm.text", (_txt))
9839 * @def elm_layout_label_get
9840 * Convienience macro to get the label in a layout that follows the
9841 * Elementary naming convention for its parts.
9844 * @deprecated use elm_object_text_* instead.
9846 #define elm_layout_label_get(_ly) \
9847 elm_layout_text_get((_ly), "elm.text")
9849 /* smart callbacks called:
9850 * "theme,changed" - when elm theme is changed.
9854 * @defgroup Notify Notify
9856 * @image html img/widget/notify/preview-00.png
9857 * @image latex img/widget/notify/preview-00.eps
9859 * Display a container in a particular region of the parent(top, bottom,
9860 * etc. A timeout can be set to automatically hide the notify. This is so
9861 * that, after an evas_object_show() on a notify object, if a timeout was set
9862 * on it, it will @b automatically get hidden after that time.
9864 * Signals that you can add callbacks for are:
9865 * @li "timeout" - when timeout happens on notify and it's hidden
9866 * @li "block,clicked" - when a click outside of the notify happens
9868 * @ref tutorial_notify show usage of the API.
9873 * @brief Possible orient values for notify.
9875 * This values should be used in conjunction to elm_notify_orient_set() to
9876 * set the position in which the notify should appear(relative to its parent)
9877 * and in conjunction with elm_notify_orient_get() to know where the notify
9880 typedef enum _Elm_Notify_Orient
9882 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9883 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9884 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9885 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9886 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9887 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9888 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9889 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9890 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9891 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9892 } Elm_Notify_Orient;
9894 * @brief Add a new notify to the parent
9896 * @param parent The parent object
9897 * @return The new object or NULL if it cannot be created
9899 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9901 * @brief Set the content of the notify widget
9903 * @param obj The notify object
9904 * @param content The content will be filled in this notify object
9906 * Once the content object is set, a previously set one will be deleted. If
9907 * you want to keep that old content object, use the
9908 * elm_notify_content_unset() function.
9910 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9912 * @brief Unset the content of the notify widget
9914 * @param obj The notify object
9915 * @return The content that was being used
9917 * Unparent and return the content object which was set for this widget
9919 * @see elm_notify_content_set()
9921 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9923 * @brief Return the content of the notify widget
9925 * @param obj The notify object
9926 * @return The content that is being used
9928 * @see elm_notify_content_set()
9930 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9932 * @brief Set the notify parent
9934 * @param obj The notify object
9935 * @param content The new parent
9937 * Once the parent object is set, a previously set one will be disconnected
9940 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9942 * @brief Get the notify parent
9944 * @param obj The notify object
9945 * @return The parent
9947 * @see elm_notify_parent_set()
9949 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9951 * @brief Set the orientation
9953 * @param obj The notify object
9954 * @param orient The new orientation
9956 * Sets the position in which the notify will appear in its parent.
9958 * @see @ref Elm_Notify_Orient for possible values.
9960 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9962 * @brief Return the orientation
9963 * @param obj The notify object
9964 * @return The orientation of the notification
9966 * @see elm_notify_orient_set()
9967 * @see Elm_Notify_Orient
9969 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9971 * @brief Set the time interval after which the notify window is going to be
9974 * @param obj The notify object
9975 * @param time The timeout in seconds
9977 * This function sets a timeout and starts the timer controlling when the
9978 * notify is hidden. Since calling evas_object_show() on a notify restarts
9979 * the timer controlling when the notify is hidden, setting this before the
9980 * notify is shown will in effect mean starting the timer when the notify is
9983 * @note Set a value <= 0.0 to disable a running timer.
9985 * @note If the value > 0.0 and the notify is previously visible, the
9986 * timer will be started with this value, canceling any running timer.
9988 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9990 * @brief Return the timeout value (in seconds)
9991 * @param obj the notify object
9993 * @see elm_notify_timeout_set()
9995 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9997 * @brief Sets whether events should be passed to by a click outside
10000 * @param obj The notify object
10001 * @param repeats EINA_TRUE Events are repeats, else no
10003 * When true if the user clicks outside the window the events will be caught
10004 * by the others widgets, else the events are blocked.
10006 * @note The default value is EINA_TRUE.
10008 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10010 * @brief Return true if events are repeat below the notify object
10011 * @param obj the notify object
10013 * @see elm_notify_repeat_events_set()
10015 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10021 * @defgroup Hover Hover
10023 * @image html img/widget/hover/preview-00.png
10024 * @image latex img/widget/hover/preview-00.eps
10026 * A Hover object will hover over its @p parent object at the @p target
10027 * location. Anything in the background will be given a darker coloring to
10028 * indicate that the hover object is on top (at the default theme). When the
10029 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10030 * clicked that @b doesn't cause the hover to be dismissed.
10032 * @note The hover object will take up the entire space of @p target
10035 * Elementary has the following styles for the hover widget:
10039 * @li hoversel_vertical
10041 * The following are the available position for content:
10053 * Signals that you can add callbacks for are:
10054 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10055 * @li "smart,changed" - a content object placed under the "smart"
10056 * policy was replaced to a new slot direction.
10058 * See @ref tutorial_hover for more information.
10062 typedef enum _Elm_Hover_Axis
10064 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10065 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10066 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10067 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10070 * @brief Adds a hover object to @p parent
10072 * @param parent The parent object
10073 * @return The hover object or NULL if one could not be created
10075 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10077 * @brief Sets the target object for the hover.
10079 * @param obj The hover object
10080 * @param target The object to center the hover onto. The hover
10082 * This function will cause the hover to be centered on the target object.
10084 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10086 * @brief Gets the target object for the hover.
10088 * @param obj The hover object
10089 * @param parent The object to locate the hover over.
10091 * @see elm_hover_target_set()
10093 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10095 * @brief Sets the parent object for the hover.
10097 * @param obj The hover object
10098 * @param parent The object to locate the hover over.
10100 * This function will cause the hover to take up the entire space that the
10101 * parent object fills.
10103 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10105 * @brief Gets the parent object for the hover.
10107 * @param obj The hover object
10108 * @return The parent object to locate the hover over.
10110 * @see elm_hover_parent_set()
10112 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10114 * @brief Sets the content of the hover object and the direction in which it
10117 * @param obj The hover object
10118 * @param swallow The direction that the object will be displayed
10119 * at. Accepted values are "left", "top-left", "top", "top-right",
10120 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10122 * @param content The content to place at @p swallow
10124 * Once the content object is set for a given direction, a previously
10125 * set one (on the same direction) will be deleted. If you want to
10126 * keep that old content object, use the elm_hover_content_unset()
10129 * All directions may have contents at the same time, except for
10130 * "smart". This is a special placement hint and its use case
10131 * independs of the calculations coming from
10132 * elm_hover_best_content_location_get(). Its use is for cases when
10133 * one desires only one hover content, but with a dinamic special
10134 * placement within the hover area. The content's geometry, whenever
10135 * it changes, will be used to decide on a best location not
10136 * extrapolating the hover's parent object view to show it in (still
10137 * being the hover's target determinant of its medium part -- move and
10138 * resize it to simulate finger sizes, for example). If one of the
10139 * directions other than "smart" are used, a previously content set
10140 * using it will be deleted, and vice-versa.
10142 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10144 * @brief Get the content of the hover object, in a given direction.
10146 * Return the content object which was set for this widget in the
10147 * @p swallow direction.
10149 * @param obj The hover object
10150 * @param swallow The direction that the object was display at.
10151 * @return The content that was being used
10153 * @see elm_hover_content_set()
10155 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10157 * @brief Unset the content of the hover object, in a given direction.
10159 * Unparent and return the content object set at @p swallow direction.
10161 * @param obj The hover object
10162 * @param swallow The direction that the object was display at.
10163 * @return The content that was being used.
10165 * @see elm_hover_content_set()
10167 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10169 * @brief Returns the best swallow location for content in the hover.
10171 * @param obj The hover object
10172 * @param pref_axis The preferred orientation axis for the hover object to use
10173 * @return The edje location to place content into the hover or @c
10176 * Best is defined here as the location at which there is the most available
10179 * @p pref_axis may be one of
10180 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10181 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10182 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10183 * - @c ELM_HOVER_AXIS_BOTH -- both
10185 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10186 * nescessarily be along the horizontal axis("left" or "right"). If
10187 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10188 * be along the vertical axis("top" or "bottom"). Chossing
10189 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10190 * returned position may be in either axis.
10192 * @see elm_hover_content_set()
10194 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10201 * @defgroup Entry Entry
10203 * @image html img/widget/entry/preview-00.png
10204 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10205 * @image html img/widget/entry/preview-01.png
10206 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10207 * @image html img/widget/entry/preview-02.png
10208 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10209 * @image html img/widget/entry/preview-03.png
10210 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10212 * An entry is a convenience widget which shows a box that the user can
10213 * enter text into. Entries by default don't scroll, so they grow to
10214 * accomodate the entire text, resizing the parent window as needed. This
10215 * can be changed with the elm_entry_scrollable_set() function.
10217 * They can also be single line or multi line (the default) and when set
10218 * to multi line mode they support text wrapping in any of the modes
10219 * indicated by #Elm_Wrap_Type.
10221 * Other features include password mode, filtering of inserted text with
10222 * elm_entry_text_filter_append() and related functions, inline "items" and
10223 * formatted markup text.
10225 * @section entry-markup Formatted text
10227 * The markup tags supported by the Entry are defined by the theme, but
10228 * even when writing new themes or extensions it's a good idea to stick to
10229 * a sane default, to maintain coherency and avoid application breakages.
10230 * Currently defined by the default theme are the following tags:
10231 * @li \<br\>: Inserts a line break.
10232 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10234 * @li \<tab\>: Inserts a tab.
10235 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10237 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10238 * @li \<link\>...\</link\>: Underlines the enclosed text.
10239 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10241 * @section entry-special Special markups
10243 * Besides those used to format text, entries support two special markup
10244 * tags used to insert clickable portions of text or items inlined within
10247 * @subsection entry-anchors Anchors
10249 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10250 * \</a\> tags and an event will be generated when this text is clicked,
10254 * This text is outside <a href=anc-01>but this one is an anchor</a>
10257 * The @c href attribute in the opening tag gives the name that will be
10258 * used to identify the anchor and it can be any valid utf8 string.
10260 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10261 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10262 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10263 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10266 * @subsection entry-items Items
10268 * Inlined in the text, any other @c Evas_Object can be inserted by using
10269 * \<item\> tags this way:
10272 * <item size=16x16 vsize=full href=emoticon/haha></item>
10275 * Just like with anchors, the @c href identifies each item, but these need,
10276 * in addition, to indicate their size, which is done using any one of
10277 * @c size, @c absize or @c relsize attributes. These attributes take their
10278 * value in the WxH format, where W is the width and H the height of the
10281 * @li absize: Absolute pixel size for the item. Whatever value is set will
10282 * be the item's size regardless of any scale value the object may have
10283 * been set to. The final line height will be adjusted to fit larger items.
10284 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10286 * @li relsize: Size is adjusted for the item to fit within the current
10289 * Besides their size, items are specificed a @c vsize value that affects
10290 * how their final size and position are calculated. The possible values
10292 * @li ascent: Item will be placed within the line's baseline and its
10293 * ascent. That is, the height between the line where all characters are
10294 * positioned and the highest point in the line. For @c size and @c absize
10295 * items, the descent value will be added to the total line height to make
10296 * them fit. @c relsize items will be adjusted to fit within this space.
10297 * @li full: Items will be placed between the descent and ascent, or the
10298 * lowest point in the line and its highest.
10300 * The next image shows different configurations of items and how they
10301 * are the previously mentioned options affect their sizes. In all cases,
10302 * the green line indicates the ascent, blue for the baseline and red for
10305 * @image html entry_item.png
10306 * @image latex entry_item.eps width=\textwidth
10308 * And another one to show how size differs from absize. In the first one,
10309 * the scale value is set to 1.0, while the second one is using one of 2.0.
10311 * @image html entry_item_scale.png
10312 * @image latex entry_item_scale.eps width=\textwidth
10314 * After the size for an item is calculated, the entry will request an
10315 * object to place in its space. For this, the functions set with
10316 * elm_entry_item_provider_append() and related functions will be called
10317 * in order until one of them returns a @c non-NULL value. If no providers
10318 * are available, or all of them return @c NULL, then the entry falls back
10319 * to one of the internal defaults, provided the name matches with one of
10322 * All of the following are currently supported:
10325 * - emoticon/angry-shout
10326 * - emoticon/crazy-laugh
10327 * - emoticon/evil-laugh
10329 * - emoticon/goggle-smile
10330 * - emoticon/grumpy
10331 * - emoticon/grumpy-smile
10332 * - emoticon/guilty
10333 * - emoticon/guilty-smile
10335 * - emoticon/half-smile
10336 * - emoticon/happy-panting
10338 * - emoticon/indifferent
10340 * - emoticon/knowing-grin
10342 * - emoticon/little-bit-sorry
10343 * - emoticon/love-lots
10345 * - emoticon/minimal-smile
10346 * - emoticon/not-happy
10347 * - emoticon/not-impressed
10349 * - emoticon/opensmile
10352 * - emoticon/squint-laugh
10353 * - emoticon/surprised
10354 * - emoticon/suspicious
10355 * - emoticon/tongue-dangling
10356 * - emoticon/tongue-poke
10358 * - emoticon/unhappy
10359 * - emoticon/very-sorry
10362 * - emoticon/worried
10365 * Alternatively, an item may reference an image by its path, using
10366 * the URI form @c file:///path/to/an/image.png and the entry will then
10367 * use that image for the item.
10369 * @section entry-files Loading and saving files
10371 * Entries have convinience functions to load text from a file and save
10372 * changes back to it after a short delay. The automatic saving is enabled
10373 * by default, but can be disabled with elm_entry_autosave_set() and files
10374 * can be loaded directly as plain text or have any markup in them
10375 * recognized. See elm_entry_file_set() for more details.
10377 * @section entry-signals Emitted signals
10379 * This widget emits the following signals:
10381 * @li "changed": The text within the entry was changed.
10382 * @li "changed,user": The text within the entry was changed because of user interaction.
10383 * @li "activated": The enter key was pressed on a single line entry.
10384 * @li "press": A mouse button has been pressed on the entry.
10385 * @li "longpressed": A mouse button has been pressed and held for a couple
10387 * @li "clicked": The entry has been clicked (mouse press and release).
10388 * @li "clicked,double": The entry has been double clicked.
10389 * @li "clicked,triple": The entry has been triple clicked.
10390 * @li "focused": The entry has received focus.
10391 * @li "unfocused": The entry has lost focus.
10392 * @li "selection,paste": A paste of the clipboard contents was requested.
10393 * @li "selection,copy": A copy of the selected text into the clipboard was
10395 * @li "selection,cut": A cut of the selected text into the clipboard was
10397 * @li "selection,start": A selection has begun and no previous selection
10399 * @li "selection,changed": The current selection has changed.
10400 * @li "selection,cleared": The current selection has been cleared.
10401 * @li "cursor,changed": The cursor has changed position.
10402 * @li "anchor,clicked": An anchor has been clicked. The event_info
10403 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10404 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10405 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10406 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10407 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10408 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10409 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10410 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10411 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10412 * @li "preedit,changed": The preedit string has changed.
10414 * @section entry-examples
10416 * An overview of the Entry API can be seen in @ref entry_example_01
10421 * @typedef Elm_Entry_Anchor_Info
10423 * The info sent in the callback for the "anchor,clicked" signals emitted
10426 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10428 * @struct _Elm_Entry_Anchor_Info
10430 * The info sent in the callback for the "anchor,clicked" signals emitted
10433 struct _Elm_Entry_Anchor_Info
10435 const char *name; /**< The name of the anchor, as stated in its href */
10436 int button; /**< The mouse button used to click on it */
10437 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10438 y, /**< Anchor geometry, relative to canvas */
10439 w, /**< Anchor geometry, relative to canvas */
10440 h; /**< Anchor geometry, relative to canvas */
10443 * @typedef Elm_Entry_Filter_Cb
10444 * This callback type is used by entry filters to modify text.
10445 * @param data The data specified as the last param when adding the filter
10446 * @param entry The entry object
10447 * @param text A pointer to the location of the text being filtered. This data can be modified,
10448 * but any additional allocations must be managed by the user.
10449 * @see elm_entry_text_filter_append
10450 * @see elm_entry_text_filter_prepend
10452 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10455 * This adds an entry to @p parent object.
10457 * By default, entries are:
10461 * @li autosave is enabled
10463 * @param parent The parent object
10464 * @return The new object or NULL if it cannot be created
10466 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10468 * Sets the entry to single line mode.
10470 * In single line mode, entries don't ever wrap when the text reaches the
10471 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10472 * key will generate an @c "activate" event instead of adding a new line.
10474 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10475 * and pressing enter will break the text into a different line
10476 * without generating any events.
10478 * @param obj The entry object
10479 * @param single_line If true, the text in the entry
10480 * will be on a single line.
10482 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10484 * Gets whether the entry is set to be single line.
10486 * @param obj The entry object
10487 * @return single_line If true, the text in the entry is set to display
10488 * on a single line.
10490 * @see elm_entry_single_line_set()
10492 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10494 * Sets the entry to password mode.
10496 * In password mode, entries are implicitly single line and the display of
10497 * any text in them is replaced with asterisks (*).
10499 * @param obj The entry object
10500 * @param password If true, password mode is enabled.
10502 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10504 * Gets whether the entry is set to password mode.
10506 * @param obj The entry object
10507 * @return If true, the entry is set to display all characters
10508 * as asterisks (*).
10510 * @see elm_entry_password_set()
10512 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10514 * This sets the text displayed within the entry to @p entry.
10516 * @param obj The entry object
10517 * @param entry The text to be displayed
10519 * @deprecated Use elm_object_text_set() instead.
10521 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10523 * This returns the text currently shown in object @p entry.
10524 * See also elm_entry_entry_set().
10526 * @param obj The entry object
10527 * @return The currently displayed text or NULL on failure
10529 * @deprecated Use elm_object_text_get() instead.
10531 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10533 * Appends @p entry to the text of the entry.
10535 * Adds the text in @p entry to the end of any text already present in the
10538 * The appended text is subject to any filters set for the widget.
10540 * @param obj The entry object
10541 * @param entry The text to be displayed
10543 * @see elm_entry_text_filter_append()
10545 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10547 * Gets whether the entry is empty.
10549 * Empty means no text at all. If there are any markup tags, like an item
10550 * tag for which no provider finds anything, and no text is displayed, this
10551 * function still returns EINA_FALSE.
10553 * @param obj The entry object
10554 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10556 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10558 * Gets any selected text within the entry.
10560 * If there's any selected text in the entry, this function returns it as
10561 * a string in markup format. NULL is returned if no selection exists or
10562 * if an error occurred.
10564 * The returned value points to an internal string and should not be freed
10565 * or modified in any way. If the @p entry object is deleted or its
10566 * contents are changed, the returned pointer should be considered invalid.
10568 * @param obj The entry object
10569 * @return The selected text within the entry or NULL on failure
10571 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10573 * Inserts the given text into the entry at the current cursor position.
10575 * This inserts text at the cursor position as if it was typed
10576 * by the user (note that this also allows markup which a user
10577 * can't just "type" as it would be converted to escaped text, so this
10578 * call can be used to insert things like emoticon items or bold push/pop
10579 * tags, other font and color change tags etc.)
10581 * If any selection exists, it will be replaced by the inserted text.
10583 * The inserted text is subject to any filters set for the widget.
10585 * @param obj The entry object
10586 * @param entry The text to insert
10588 * @see elm_entry_text_filter_append()
10590 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10592 * Set the line wrap type to use on multi-line entries.
10594 * Sets the wrap type used by the entry to any of the specified in
10595 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10596 * line (without inserting a line break or paragraph separator) when it
10597 * reaches the far edge of the widget.
10599 * Note that this only makes sense for multi-line entries. A widget set
10600 * to be single line will never wrap.
10602 * @param obj The entry object
10603 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10605 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10607 * Gets the wrap mode the entry was set to use.
10609 * @param obj The entry object
10610 * @return Wrap type
10612 * @see also elm_entry_line_wrap_set()
10614 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10616 * Sets if the entry is to be editable or not.
10618 * By default, entries are editable and when focused, any text input by the
10619 * user will be inserted at the current cursor position. But calling this
10620 * function with @p editable as EINA_FALSE will prevent the user from
10621 * inputting text into the entry.
10623 * The only way to change the text of a non-editable entry is to use
10624 * elm_object_text_set(), elm_entry_entry_insert() and other related
10627 * @param obj The entry object
10628 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10629 * if not, the entry is read-only and no user input is allowed.
10631 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10633 * Gets whether the entry is editable or not.
10635 * @param obj The entry object
10636 * @return If true, the entry is editable by the user.
10637 * If false, it is not editable by the user
10639 * @see elm_entry_editable_set()
10641 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10643 * This drops any existing text selection within the entry.
10645 * @param obj The entry object
10647 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10649 * This selects all text within the entry.
10651 * @param obj The entry object
10653 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10655 * This moves the cursor one place to the right within the entry.
10657 * @param obj The entry object
10658 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10660 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 * This moves the cursor one place to the left within the entry.
10664 * @param obj The entry object
10665 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10667 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10669 * This moves the cursor one line up within the entry.
10671 * @param obj The entry object
10672 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10674 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10676 * This moves the cursor one line down within the entry.
10678 * @param obj The entry object
10679 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10681 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10683 * This moves the cursor to the beginning of the entry.
10685 * @param obj The entry object
10687 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10689 * This moves the cursor to the end of the entry.
10691 * @param obj The entry object
10693 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10695 * This moves the cursor to the beginning of the current line.
10697 * @param obj The entry object
10699 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10701 * This moves the cursor to the end of the current line.
10703 * @param obj The entry object
10705 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10707 * This begins a selection within the entry as though
10708 * the user were holding down the mouse button to make a selection.
10710 * @param obj The entry object
10712 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10714 * This ends a selection within the entry as though
10715 * the user had just released the mouse button while making a selection.
10717 * @param obj The entry object
10719 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10721 * Gets whether a format node exists at the current cursor position.
10723 * A format node is anything that defines how the text is rendered. It can
10724 * be a visible format node, such as a line break or a paragraph separator,
10725 * or an invisible one, such as bold begin or end tag.
10726 * This function returns whether any format node exists at the current
10729 * @param obj The entry object
10730 * @return EINA_TRUE if the current cursor position contains a format node,
10731 * EINA_FALSE otherwise.
10733 * @see elm_entry_cursor_is_visible_format_get()
10735 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10737 * Gets if the current cursor position holds a visible format node.
10739 * @param obj The entry object
10740 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10741 * if it's an invisible one or no format exists.
10743 * @see elm_entry_cursor_is_format_get()
10745 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10747 * Gets the character pointed by the cursor at its current position.
10749 * This function returns a string with the utf8 character stored at the
10750 * current cursor position.
10751 * Only the text is returned, any format that may exist will not be part
10752 * of the return value.
10754 * @param obj The entry object
10755 * @return The text pointed by the cursors.
10757 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10759 * This function returns the geometry of the cursor.
10761 * It's useful if you want to draw something on the cursor (or where it is),
10762 * or for example in the case of scrolled entry where you want to show the
10765 * @param obj The entry object
10766 * @param x returned geometry
10767 * @param y returned geometry
10768 * @param w returned geometry
10769 * @param h returned geometry
10770 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10772 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);
10774 * Sets the cursor position in the entry to the given value
10776 * The value in @p pos is the index of the character position within the
10777 * contents of the string as returned by elm_entry_cursor_pos_get().
10779 * @param obj The entry object
10780 * @param pos The position of the cursor
10782 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10784 * Retrieves the current position of the cursor in the entry
10786 * @param obj The entry object
10787 * @return The cursor position
10789 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10791 * This executes a "cut" action on the selected text in the entry.
10793 * @param obj The entry object
10795 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10797 * This executes a "copy" action on the selected text in the entry.
10799 * @param obj The entry object
10801 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10803 * This executes a "paste" action in the entry.
10805 * @param obj The entry object
10807 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10809 * This clears and frees the items in a entry's contextual (longpress)
10812 * @param obj The entry object
10814 * @see elm_entry_context_menu_item_add()
10816 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10818 * This adds an item to the entry's contextual menu.
10820 * A longpress on an entry will make the contextual menu show up, if this
10821 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10822 * By default, this menu provides a few options like enabling selection mode,
10823 * which is useful on embedded devices that need to be explicit about it,
10824 * and when a selection exists it also shows the copy and cut actions.
10826 * With this function, developers can add other options to this menu to
10827 * perform any action they deem necessary.
10829 * @param obj The entry object
10830 * @param label The item's text label
10831 * @param icon_file The item's icon file
10832 * @param icon_type The item's icon type
10833 * @param func The callback to execute when the item is clicked
10834 * @param data The data to associate with the item for related functions
10836 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);
10838 * This disables the entry's contextual (longpress) menu.
10840 * @param obj The entry object
10841 * @param disabled If true, the menu is disabled
10843 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10845 * This returns whether the entry's contextual (longpress) menu is
10848 * @param obj The entry object
10849 * @return If true, the menu is disabled
10851 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10853 * This appends a custom item provider to the list for that entry
10855 * This appends the given callback. The list is walked from beginning to end
10856 * with each function called given the item href string in the text. If the
10857 * function returns an object handle other than NULL (it should create an
10858 * object to do this), then this object is used to replace that item. If
10859 * not the next provider is called until one provides an item object, or the
10860 * default provider in entry does.
10862 * @param obj The entry object
10863 * @param func The function called to provide the item object
10864 * @param data The data passed to @p func
10866 * @see @ref entry-items
10868 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);
10870 * This prepends a custom item provider to the list for that entry
10872 * This prepends the given callback. See elm_entry_item_provider_append() for
10875 * @param obj The entry object
10876 * @param func The function called to provide the item object
10877 * @param data The data passed to @p func
10879 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);
10881 * This removes a custom item provider to the list for that entry
10883 * This removes the given callback. See elm_entry_item_provider_append() for
10886 * @param obj The entry object
10887 * @param func The function called to provide the item object
10888 * @param data The data passed to @p func
10890 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);
10892 * Append a filter function for text inserted in the entry
10894 * Append the given callback to the list. This functions will be called
10895 * whenever any text is inserted into the entry, with the text to be inserted
10896 * as a parameter. The callback function is free to alter the text in any way
10897 * it wants, but it must remember to free the given pointer and update it.
10898 * If the new text is to be discarded, the function can free it and set its
10899 * text parameter to NULL. This will also prevent any following filters from
10902 * @param obj The entry object
10903 * @param func The function to use as text filter
10904 * @param data User data to pass to @p func
10906 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10908 * Prepend a filter function for text insdrted in the entry
10910 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10911 * for more information
10913 * @param obj The entry object
10914 * @param func The function to use as text filter
10915 * @param data User data to pass to @p func
10917 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10919 * Remove a filter from the list
10921 * Removes the given callback from the filter list. See
10922 * elm_entry_text_filter_append() for more information.
10924 * @param obj The entry object
10925 * @param func The filter function to remove
10926 * @param data The user data passed when adding the function
10928 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10930 * This converts a markup (HTML-like) string into UTF-8.
10932 * The returned string is a malloc'ed buffer and it should be freed when
10933 * not needed anymore.
10935 * @param s The string (in markup) to be converted
10936 * @return The converted string (in UTF-8). It should be freed.
10938 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10940 * This converts a UTF-8 string into markup (HTML-like).
10942 * The returned string is a malloc'ed buffer and it should be freed when
10943 * not needed anymore.
10945 * @param s The string (in UTF-8) to be converted
10946 * @return The converted string (in markup). It should be freed.
10948 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10950 * This sets the file (and implicitly loads it) for the text to display and
10951 * then edit. All changes are written back to the file after a short delay if
10952 * the entry object is set to autosave (which is the default).
10954 * If the entry had any other file set previously, any changes made to it
10955 * will be saved if the autosave feature is enabled, otherwise, the file
10956 * will be silently discarded and any non-saved changes will be lost.
10958 * @param obj The entry object
10959 * @param file The path to the file to load and save
10960 * @param format The file format
10962 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10964 * Gets the file being edited by the entry.
10966 * This function can be used to retrieve any file set on the entry for
10967 * edition, along with the format used to load and save it.
10969 * @param obj The entry object
10970 * @param file The path to the file to load and save
10971 * @param format The file format
10973 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10975 * This function writes any changes made to the file set with
10976 * elm_entry_file_set()
10978 * @param obj The entry object
10980 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10982 * This sets the entry object to 'autosave' the loaded text file or not.
10984 * @param obj The entry object
10985 * @param autosave Autosave the loaded file or not
10987 * @see elm_entry_file_set()
10989 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10991 * This gets the entry object's 'autosave' status.
10993 * @param obj The entry object
10994 * @return Autosave the loaded file or not
10996 * @see elm_entry_file_set()
10998 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11000 * Control pasting of text and images for the widget.
11002 * Normally the entry allows both text and images to be pasted. By setting
11003 * textonly to be true, this prevents images from being pasted.
11005 * Note this only changes the behaviour of text.
11007 * @param obj The entry object
11008 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11009 * text+image+other.
11011 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11013 * Getting elm_entry text paste/drop mode.
11015 * In textonly mode, only text may be pasted or dropped into the widget.
11017 * @param obj The entry object
11018 * @return If the widget only accepts text from pastes.
11020 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * Enable or disable scrolling in entry
11024 * Normally the entry is not scrollable unless you enable it with this call.
11026 * @param obj The entry object
11027 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11029 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11031 * Get the scrollable state of the entry
11033 * Normally the entry is not scrollable. This gets the scrollable state
11034 * of the entry. See elm_entry_scrollable_set() for more information.
11036 * @param obj The entry object
11037 * @return The scrollable state
11039 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11041 * This sets a widget to be displayed to the left of a scrolled entry.
11043 * @param obj The scrolled entry object
11044 * @param icon The widget to display on the left side of the scrolled
11047 * @note A previously set widget will be destroyed.
11048 * @note If the object being set does not have minimum size hints set,
11049 * it won't get properly displayed.
11051 * @see elm_entry_end_set()
11053 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11055 * Gets the leftmost widget of the scrolled entry. This object is
11056 * owned by the scrolled entry and should not be modified.
11058 * @param obj The scrolled entry object
11059 * @return the left widget inside the scroller
11061 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11063 * Unset the leftmost widget of the scrolled entry, unparenting and
11066 * @param obj The scrolled entry object
11067 * @return the previously set icon sub-object of this entry, on
11070 * @see elm_entry_icon_set()
11072 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11074 * Sets the visibility of the left-side widget of the scrolled entry,
11075 * set by elm_entry_icon_set().
11077 * @param obj The scrolled entry object
11078 * @param setting EINA_TRUE if the object should be displayed,
11079 * EINA_FALSE if not.
11081 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11083 * This sets a widget to be displayed to the end of a scrolled entry.
11085 * @param obj The scrolled entry object
11086 * @param end The widget to display on the right side of the scrolled
11089 * @note A previously set widget will be destroyed.
11090 * @note If the object being set does not have minimum size hints set,
11091 * it won't get properly displayed.
11093 * @see elm_entry_icon_set
11095 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11097 * Gets the endmost widget of the scrolled entry. This object is owned
11098 * by the scrolled entry and should not be modified.
11100 * @param obj The scrolled entry object
11101 * @return the right widget inside the scroller
11103 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11105 * Unset the endmost widget of the scrolled entry, unparenting and
11108 * @param obj The scrolled entry object
11109 * @return the previously set icon sub-object of this entry, on
11112 * @see elm_entry_icon_set()
11114 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11116 * Sets the visibility of the end widget of the scrolled entry, set by
11117 * elm_entry_end_set().
11119 * @param obj The scrolled entry object
11120 * @param setting EINA_TRUE if the object should be displayed,
11121 * EINA_FALSE if not.
11123 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11125 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11128 * Setting an entry to single-line mode with elm_entry_single_line_set()
11129 * will automatically disable the display of scrollbars when the entry
11130 * moves inside its scroller.
11132 * @param obj The scrolled entry object
11133 * @param h The horizontal scrollbar policy to apply
11134 * @param v The vertical scrollbar policy to apply
11136 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11138 * This enables/disables bouncing within the entry.
11140 * This function sets whether the entry will bounce when scrolling reaches
11141 * the end of the contained entry.
11143 * @param obj The scrolled entry object
11144 * @param h The horizontal bounce state
11145 * @param v The vertical bounce state
11147 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11149 * Get the bounce mode
11151 * @param obj The Entry object
11152 * @param h_bounce Allow bounce horizontally
11153 * @param v_bounce Allow bounce vertically
11155 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11157 /* pre-made filters for entries */
11159 * @typedef Elm_Entry_Filter_Limit_Size
11161 * Data for the elm_entry_filter_limit_size() entry filter.
11163 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11165 * @struct _Elm_Entry_Filter_Limit_Size
11167 * Data for the elm_entry_filter_limit_size() entry filter.
11169 struct _Elm_Entry_Filter_Limit_Size
11171 int max_char_count; /**< The maximum number of characters allowed. */
11172 int max_byte_count; /**< The maximum number of bytes allowed*/
11175 * Filter inserted text based on user defined character and byte limits
11177 * Add this filter to an entry to limit the characters that it will accept
11178 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11179 * The funtion works on the UTF-8 representation of the string, converting
11180 * it from the set markup, thus not accounting for any format in it.
11182 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11183 * it as data when setting the filter. In it, it's possible to set limits
11184 * by character count or bytes (any of them is disabled if 0), and both can
11185 * be set at the same time. In that case, it first checks for characters,
11188 * The function will cut the inserted text in order to allow only the first
11189 * number of characters that are still allowed. The cut is made in
11190 * characters, even when limiting by bytes, in order to always contain
11191 * valid ones and avoid half unicode characters making it in.
11193 * This filter, like any others, does not apply when setting the entry text
11194 * directly with elm_object_text_set() (or the deprecated
11195 * elm_entry_entry_set()).
11197 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11199 * @typedef Elm_Entry_Filter_Accept_Set
11201 * Data for the elm_entry_filter_accept_set() entry filter.
11203 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11205 * @struct _Elm_Entry_Filter_Accept_Set
11207 * Data for the elm_entry_filter_accept_set() entry filter.
11209 struct _Elm_Entry_Filter_Accept_Set
11211 const char *accepted; /**< Set of characters accepted in the entry. */
11212 const char *rejected; /**< Set of characters rejected from the entry. */
11215 * Filter inserted text based on accepted or rejected sets of characters
11217 * Add this filter to an entry to restrict the set of accepted characters
11218 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11219 * This structure contains both accepted and rejected sets, but they are
11220 * mutually exclusive.
11222 * The @c accepted set takes preference, so if it is set, the filter will
11223 * only work based on the accepted characters, ignoring anything in the
11224 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11226 * In both cases, the function filters by matching utf8 characters to the
11227 * raw markup text, so it can be used to remove formatting tags.
11229 * This filter, like any others, does not apply when setting the entry text
11230 * directly with elm_object_text_set() (or the deprecated
11231 * elm_entry_entry_set()).
11233 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11238 /* composite widgets - these basically put together basic widgets above
11239 * in convenient packages that do more than basic stuff */
11243 * @defgroup Anchorview Anchorview
11245 * @image html img/widget/anchorview/preview-00.png
11246 * @image latex img/widget/anchorview/preview-00.eps
11248 * Anchorview is for displaying text that contains markup with anchors
11249 * like <c>\<a href=1234\>something\</\></c> in it.
11251 * Besides being styled differently, the anchorview widget provides the
11252 * necessary functionality so that clicking on these anchors brings up a
11253 * popup with user defined content such as "call", "add to contacts" or
11254 * "open web page". This popup is provided using the @ref Hover widget.
11256 * This widget is very similar to @ref Anchorblock, so refer to that
11257 * widget for an example. The only difference Anchorview has is that the
11258 * widget is already provided with scrolling functionality, so if the
11259 * text set to it is too large to fit in the given space, it will scroll,
11260 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11261 * text can be displayed.
11263 * This widget emits the following signals:
11264 * @li "anchor,clicked": will be called when an anchor is clicked. The
11265 * @p event_info parameter on the callback will be a pointer of type
11266 * ::Elm_Entry_Anchorview_Info.
11268 * See @ref Anchorblock for an example on how to use both of them.
11277 * @typedef Elm_Entry_Anchorview_Info
11279 * The info sent in the callback for "anchor,clicked" signals emitted by
11280 * the Anchorview widget.
11282 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11284 * @struct _Elm_Entry_Anchorview_Info
11286 * The info sent in the callback for "anchor,clicked" signals emitted by
11287 * the Anchorview widget.
11289 struct _Elm_Entry_Anchorview_Info
11291 const char *name; /**< Name of the anchor, as indicated in its href
11293 int button; /**< The mouse button used to click on it */
11294 Evas_Object *hover; /**< The hover object to use for the popup */
11296 Evas_Coord x, y, w, h;
11297 } anchor, /**< Geometry selection of text used as anchor */
11298 hover_parent; /**< Geometry of the object used as parent by the
11300 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11301 for content on the left side of
11302 the hover. Before calling the
11303 callback, the widget will make the
11304 necessary calculations to check
11305 which sides are fit to be set with
11306 content, based on the position the
11307 hover is activated and its distance
11308 to the edges of its parent object
11310 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11311 the right side of the hover.
11312 See @ref hover_left */
11313 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11314 of the hover. See @ref hover_left */
11315 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11316 below the hover. See @ref
11320 * Add a new Anchorview object
11322 * @param parent The parent object
11323 * @return The new object or NULL if it cannot be created
11325 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11327 * Set the text to show in the anchorview
11329 * Sets the text of the anchorview to @p text. This text can include markup
11330 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11331 * text that will be specially styled and react to click events, ended with
11332 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11333 * "anchor,clicked" signal that you can attach a callback to with
11334 * evas_object_smart_callback_add(). The name of the anchor given in the
11335 * event info struct will be the one set in the href attribute, in this
11336 * case, anchorname.
11338 * Other markup can be used to style the text in different ways, but it's
11339 * up to the style defined in the theme which tags do what.
11340 * @deprecated use elm_object_text_set() instead.
11342 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11344 * Get the markup text set for the anchorview
11346 * Retrieves the text set on the anchorview, with markup tags included.
11348 * @param obj The anchorview object
11349 * @return The markup text set or @c NULL if nothing was set or an error
11351 * @deprecated use elm_object_text_set() instead.
11353 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11355 * Set the parent of the hover popup
11357 * Sets the parent object to use by the hover created by the anchorview
11358 * when an anchor is clicked. See @ref Hover for more details on this.
11359 * If no parent is set, the same anchorview object will be used.
11361 * @param obj The anchorview object
11362 * @param parent The object to use as parent for the hover
11364 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11366 * Get the parent of the hover popup
11368 * Get the object used as parent for the hover created by the anchorview
11369 * widget. See @ref Hover for more details on this.
11371 * @param obj The anchorview object
11372 * @return The object used as parent for the hover, NULL if none is set.
11374 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11376 * Set the style that the hover should use
11378 * When creating the popup hover, anchorview will request that it's
11379 * themed according to @p style.
11381 * @param obj The anchorview object
11382 * @param style The style to use for the underlying hover
11384 * @see elm_object_style_set()
11386 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11388 * Get the style that the hover should use
11390 * Get the style the hover created by anchorview will use.
11392 * @param obj The anchorview object
11393 * @return The style to use by the hover. NULL means the default is used.
11395 * @see elm_object_style_set()
11397 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11399 * Ends the hover popup in the anchorview
11401 * When an anchor is clicked, the anchorview widget will create a hover
11402 * object to use as a popup with user provided content. This function
11403 * terminates this popup, returning the anchorview to its normal state.
11405 * @param obj The anchorview object
11407 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11409 * Set bouncing behaviour when the scrolled content reaches an edge
11411 * Tell the internal scroller object whether it should bounce or not
11412 * when it reaches the respective edges for each axis.
11414 * @param obj The anchorview object
11415 * @param h_bounce Whether to bounce or not in the horizontal axis
11416 * @param v_bounce Whether to bounce or not in the vertical axis
11418 * @see elm_scroller_bounce_set()
11420 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11422 * Get the set bouncing behaviour of the internal scroller
11424 * Get whether the internal scroller should bounce when the edge of each
11425 * axis is reached scrolling.
11427 * @param obj The anchorview object
11428 * @param h_bounce Pointer where to store the bounce state of the horizontal
11430 * @param v_bounce Pointer where to store the bounce state of the vertical
11433 * @see elm_scroller_bounce_get()
11435 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11437 * Appends a custom item provider to the given anchorview
11439 * Appends the given function to the list of items providers. This list is
11440 * called, one function at a time, with the given @p data pointer, the
11441 * anchorview object and, in the @p item parameter, the item name as
11442 * referenced in its href string. Following functions in the list will be
11443 * called in order until one of them returns something different to NULL,
11444 * which should be an Evas_Object which will be used in place of the item
11447 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11448 * href=item/name\>\</item\>
11450 * @param obj The anchorview object
11451 * @param func The function to add to the list of providers
11452 * @param data User data that will be passed to the callback function
11454 * @see elm_entry_item_provider_append()
11456 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);
11458 * Prepend a custom item provider to the given anchorview
11460 * Like elm_anchorview_item_provider_append(), but it adds the function
11461 * @p func to the beginning of the list, instead of the end.
11463 * @param obj The anchorview object
11464 * @param func The function to add to the list of providers
11465 * @param data User data that will be passed to the callback function
11467 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);
11469 * Remove a custom item provider from the list of the given anchorview
11471 * Removes the function and data pairing that matches @p func and @p data.
11472 * That is, unless the same function and same user data are given, the
11473 * function will not be removed from the list. This allows us to add the
11474 * same callback several times, with different @p data pointers and be
11475 * able to remove them later without conflicts.
11477 * @param obj The anchorview object
11478 * @param func The function to remove from the list
11479 * @param data The data matching the function to remove from the list
11481 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);
11488 * @defgroup Anchorblock Anchorblock
11490 * @image html img/widget/anchorblock/preview-00.png
11491 * @image latex img/widget/anchorblock/preview-00.eps
11493 * Anchorblock is for displaying text that contains markup with anchors
11494 * like <c>\<a href=1234\>something\</\></c> in it.
11496 * Besides being styled differently, the anchorblock widget provides the
11497 * necessary functionality so that clicking on these anchors brings up a
11498 * popup with user defined content such as "call", "add to contacts" or
11499 * "open web page". This popup is provided using the @ref Hover widget.
11501 * This widget emits the following signals:
11502 * @li "anchor,clicked": will be called when an anchor is clicked. The
11503 * @p event_info parameter on the callback will be a pointer of type
11504 * ::Elm_Entry_Anchorblock_Info.
11510 * Since examples are usually better than plain words, we might as well
11511 * try @ref tutorial_anchorblock_example "one".
11514 * @addtogroup Anchorblock
11518 * @typedef Elm_Entry_Anchorblock_Info
11520 * The info sent in the callback for "anchor,clicked" signals emitted by
11521 * the Anchorblock widget.
11523 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11525 * @struct _Elm_Entry_Anchorblock_Info
11527 * The info sent in the callback for "anchor,clicked" signals emitted by
11528 * the Anchorblock widget.
11530 struct _Elm_Entry_Anchorblock_Info
11532 const char *name; /**< Name of the anchor, as indicated in its href
11534 int button; /**< The mouse button used to click on it */
11535 Evas_Object *hover; /**< The hover object to use for the popup */
11537 Evas_Coord x, y, w, h;
11538 } anchor, /**< Geometry selection of text used as anchor */
11539 hover_parent; /**< Geometry of the object used as parent by the
11541 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11542 for content on the left side of
11543 the hover. Before calling the
11544 callback, the widget will make the
11545 necessary calculations to check
11546 which sides are fit to be set with
11547 content, based on the position the
11548 hover is activated and its distance
11549 to the edges of its parent object
11551 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11552 the right side of the hover.
11553 See @ref hover_left */
11554 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11555 of the hover. See @ref hover_left */
11556 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11557 below the hover. See @ref
11561 * Add a new Anchorblock object
11563 * @param parent The parent object
11564 * @return The new object or NULL if it cannot be created
11566 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11568 * Set the text to show in the anchorblock
11570 * Sets the text of the anchorblock to @p text. This text can include markup
11571 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11572 * of text that will be specially styled and react to click events, ended
11573 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11574 * "anchor,clicked" signal that you can attach a callback to with
11575 * evas_object_smart_callback_add(). The name of the anchor given in the
11576 * event info struct will be the one set in the href attribute, in this
11577 * case, anchorname.
11579 * Other markup can be used to style the text in different ways, but it's
11580 * up to the style defined in the theme which tags do what.
11581 * @deprecated use elm_object_text_set() instead.
11583 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11585 * Get the markup text set for the anchorblock
11587 * Retrieves the text set on the anchorblock, with markup tags included.
11589 * @param obj The anchorblock object
11590 * @return The markup text set or @c NULL if nothing was set or an error
11592 * @deprecated use elm_object_text_set() instead.
11594 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11596 * Set the parent of the hover popup
11598 * Sets the parent object to use by the hover created by the anchorblock
11599 * when an anchor is clicked. See @ref Hover for more details on this.
11601 * @param obj The anchorblock object
11602 * @param parent The object to use as parent for the hover
11604 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11606 * Get the parent of the hover popup
11608 * Get the object used as parent for the hover created by the anchorblock
11609 * widget. See @ref Hover for more details on this.
11610 * If no parent is set, the same anchorblock object will be used.
11612 * @param obj The anchorblock object
11613 * @return The object used as parent for the hover, NULL if none is set.
11615 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11617 * Set the style that the hover should use
11619 * When creating the popup hover, anchorblock will request that it's
11620 * themed according to @p style.
11622 * @param obj The anchorblock object
11623 * @param style The style to use for the underlying hover
11625 * @see elm_object_style_set()
11627 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11629 * Get the style that the hover should use
11631 * Get the style the hover created by anchorblock will use.
11633 * @param obj The anchorblock object
11634 * @return The style to use by the hover. NULL means the default is used.
11636 * @see elm_object_style_set()
11638 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11640 * Ends the hover popup in the anchorblock
11642 * When an anchor is clicked, the anchorblock widget will create a hover
11643 * object to use as a popup with user provided content. This function
11644 * terminates this popup, returning the anchorblock to its normal state.
11646 * @param obj The anchorblock object
11648 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11650 * Appends a custom item provider to the given anchorblock
11652 * Appends the given function to the list of items providers. This list is
11653 * called, one function at a time, with the given @p data pointer, the
11654 * anchorblock object and, in the @p item parameter, the item name as
11655 * referenced in its href string. Following functions in the list will be
11656 * called in order until one of them returns something different to NULL,
11657 * which should be an Evas_Object which will be used in place of the item
11660 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11661 * href=item/name\>\</item\>
11663 * @param obj The anchorblock object
11664 * @param func The function to add to the list of providers
11665 * @param data User data that will be passed to the callback function
11667 * @see elm_entry_item_provider_append()
11669 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);
11671 * Prepend a custom item provider to the given anchorblock
11673 * Like elm_anchorblock_item_provider_append(), but it adds the function
11674 * @p func to the beginning of the list, instead of the end.
11676 * @param obj The anchorblock object
11677 * @param func The function to add to the list of providers
11678 * @param data User data that will be passed to the callback function
11680 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);
11682 * Remove a custom item provider from the list of the given anchorblock
11684 * Removes the function and data pairing that matches @p func and @p data.
11685 * That is, unless the same function and same user data are given, the
11686 * function will not be removed from the list. This allows us to add the
11687 * same callback several times, with different @p data pointers and be
11688 * able to remove them later without conflicts.
11690 * @param obj The anchorblock object
11691 * @param func The function to remove from the list
11692 * @param data The data matching the function to remove from the list
11694 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);
11700 * @defgroup Bubble Bubble
11702 * @image html img/widget/bubble/preview-00.png
11703 * @image latex img/widget/bubble/preview-00.eps
11704 * @image html img/widget/bubble/preview-01.png
11705 * @image latex img/widget/bubble/preview-01.eps
11706 * @image html img/widget/bubble/preview-02.png
11707 * @image latex img/widget/bubble/preview-02.eps
11709 * @brief The Bubble is a widget to show text similarly to how speech is
11710 * represented in comics.
11712 * The bubble widget contains 5 important visual elements:
11713 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11714 * @li The @p icon is an image to which the frame's arrow points to.
11715 * @li The @p label is a text which appears to the right of the icon if the
11716 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11718 * @li The @p info is a text which appears to the right of the label. Info's
11719 * font is of a ligther color than label.
11720 * @li The @p content is an evas object that is shown inside the frame.
11722 * The position of the arrow, icon, label and info depends on which corner is
11723 * selected. The four available corners are:
11724 * @li "top_left" - Default
11726 * @li "bottom_left"
11727 * @li "bottom_right"
11729 * Signals that you can add callbacks for are:
11730 * @li "clicked" - This is called when a user has clicked the bubble.
11732 * For an example of using a buble see @ref bubble_01_example_page "this".
11737 * Add a new bubble to the parent
11739 * @param parent The parent object
11740 * @return The new object or NULL if it cannot be created
11742 * This function adds a text bubble to the given parent evas object.
11744 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11746 * Set the label of the bubble
11748 * @param obj The bubble object
11749 * @param label The string to set in the label
11751 * This function sets the title of the bubble. Where this appears depends on
11752 * the selected corner.
11753 * @deprecated use elm_object_text_set() instead.
11755 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11757 * Get the label of the bubble
11759 * @param obj The bubble object
11760 * @return The string of set in the label
11762 * This function gets the title of the bubble.
11763 * @deprecated use elm_object_text_get() instead.
11765 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11767 * Set the info of the bubble
11769 * @param obj The bubble object
11770 * @param info The given info about the bubble
11772 * This function sets the info of the bubble. Where this appears depends on
11773 * the selected corner.
11774 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11776 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11778 * Get the info of the bubble
11780 * @param obj The bubble object
11782 * @return The "info" string of the bubble
11784 * This function gets the info text.
11785 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11787 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11789 * Set the content to be shown in the bubble
11791 * Once the content object is set, a previously set one will be deleted.
11792 * If you want to keep the old content object, use the
11793 * elm_bubble_content_unset() function.
11795 * @param obj The bubble object
11796 * @param content The given content of the bubble
11798 * This function sets the content shown on the middle of the bubble.
11800 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11802 * Get the content shown in the bubble
11804 * Return the content object which is set for this widget.
11806 * @param obj The bubble object
11807 * @return The content that is being used
11809 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11811 * Unset the content shown in the bubble
11813 * Unparent and return the content object which was set for this widget.
11815 * @param obj The bubble object
11816 * @return The content that was being used
11818 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11820 * Set the icon of the bubble
11822 * Once the icon object is set, a previously set one will be deleted.
11823 * If you want to keep the old content object, use the
11824 * elm_icon_content_unset() function.
11826 * @param obj The bubble object
11827 * @param icon The given icon for the bubble
11829 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11831 * Get the icon of the bubble
11833 * @param obj The bubble object
11834 * @return The icon for the bubble
11836 * This function gets the icon shown on the top left of bubble.
11838 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11840 * Unset the icon of the bubble
11842 * Unparent and return the icon object which was set for this widget.
11844 * @param obj The bubble object
11845 * @return The icon that was being used
11847 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11849 * Set the corner of the bubble
11851 * @param obj The bubble object.
11852 * @param corner The given corner for the bubble.
11854 * This function sets the corner of the bubble. The corner will be used to
11855 * determine where the arrow in the frame points to and where label, icon and
11858 * Possible values for corner are:
11859 * @li "top_left" - Default
11861 * @li "bottom_left"
11862 * @li "bottom_right"
11864 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11866 * Get the corner of the bubble
11868 * @param obj The bubble object.
11869 * @return The given corner for the bubble.
11871 * This function gets the selected corner of the bubble.
11873 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11879 * @defgroup Photo Photo
11881 * For displaying the photo of a person (contact). Simple yet
11882 * with a very specific purpose.
11884 * Signals that you can add callbacks for are:
11886 * "clicked" - This is called when a user has clicked the photo
11887 * "drag,start" - Someone started dragging the image out of the object
11888 * "drag,end" - Dragged item was dropped (somewhere)
11894 * Add a new photo to the parent
11896 * @param parent The parent object
11897 * @return The new object or NULL if it cannot be created
11901 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11904 * Set the file that will be used as photo
11906 * @param obj The photo object
11907 * @param file The path to file that will be used as photo
11909 * @return (1 = success, 0 = error)
11913 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11916 * Set the size that will be used on the photo
11918 * @param obj The photo object
11919 * @param size The size that the photo will be
11923 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11926 * Set if the photo should be completely visible or not.
11928 * @param obj The photo object
11929 * @param fill if true the photo will be completely visible
11933 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11936 * Set editability of the photo.
11938 * An editable photo can be dragged to or from, and can be cut or
11939 * pasted too. Note that pasting an image or dropping an item on
11940 * the image will delete the existing content.
11942 * @param obj The photo object.
11943 * @param set To set of clear editablity.
11945 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11951 /* gesture layer */
11953 * @defgroup Elm_Gesture_Layer Gesture Layer
11954 * Gesture Layer Usage:
11956 * Use Gesture Layer to detect gestures.
11957 * The advantage is that you don't have to implement
11958 * gesture detection, just set callbacks of gesture state.
11959 * By using gesture layer we make standard interface.
11961 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11962 * with a parent object parameter.
11963 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11964 * call. Usually with same object as target (2nd parameter).
11966 * Now you need to tell gesture layer what gestures you follow.
11967 * This is done with @ref elm_gesture_layer_cb_set call.
11968 * By setting the callback you actually saying to gesture layer:
11969 * I would like to know when the gesture @ref Elm_Gesture_Types
11970 * switches to state @ref Elm_Gesture_State.
11972 * Next, you need to implement the actual action that follows the input
11973 * in your callback.
11975 * Note that if you like to stop being reported about a gesture, just set
11976 * all callbacks referring this gesture to NULL.
11977 * (again with @ref elm_gesture_layer_cb_set)
11979 * The information reported by gesture layer to your callback is depending
11980 * on @ref Elm_Gesture_Types:
11981 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11982 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11983 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11985 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11986 * @ref ELM_GESTURE_MOMENTUM.
11988 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11989 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11990 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11991 * Note that we consider a flick as a line-gesture that should be completed
11992 * in flick-time-limit as defined in @ref Config.
11994 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11996 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12000 * @enum _Elm_Gesture_Types
12001 * Enum of supported gesture types.
12002 * @ingroup Elm_Gesture_Layer
12004 enum _Elm_Gesture_Types
12006 ELM_GESTURE_FIRST = 0,
12008 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12009 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12010 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12011 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12013 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12015 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12016 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12018 ELM_GESTURE_ZOOM, /**< Zoom */
12019 ELM_GESTURE_ROTATE, /**< Rotate */
12025 * @typedef Elm_Gesture_Types
12026 * gesture types enum
12027 * @ingroup Elm_Gesture_Layer
12029 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12032 * @enum _Elm_Gesture_State
12033 * Enum of gesture states.
12034 * @ingroup Elm_Gesture_Layer
12036 enum _Elm_Gesture_State
12038 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12039 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12040 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12041 ELM_GESTURE_STATE_END, /**< Gesture completed */
12042 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12046 * @typedef Elm_Gesture_State
12047 * gesture states enum
12048 * @ingroup Elm_Gesture_Layer
12050 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12053 * @struct _Elm_Gesture_Taps_Info
12054 * Struct holds taps info for user
12055 * @ingroup Elm_Gesture_Layer
12057 struct _Elm_Gesture_Taps_Info
12059 Evas_Coord x, y; /**< Holds center point between fingers */
12060 unsigned int n; /**< Number of fingers tapped */
12061 unsigned int timestamp; /**< event timestamp */
12065 * @typedef Elm_Gesture_Taps_Info
12066 * holds taps info for user
12067 * @ingroup Elm_Gesture_Layer
12069 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12072 * @struct _Elm_Gesture_Momentum_Info
12073 * Struct holds momentum info for user
12074 * x1 and y1 are not necessarily in sync
12075 * x1 holds x value of x direction starting point
12076 * and same holds for y1.
12077 * This is noticeable when doing V-shape movement
12078 * @ingroup Elm_Gesture_Layer
12080 struct _Elm_Gesture_Momentum_Info
12081 { /* Report line ends, timestamps, and momentum computed */
12082 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12083 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12084 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12085 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12087 unsigned int tx; /**< Timestamp of start of final x-swipe */
12088 unsigned int ty; /**< Timestamp of start of final y-swipe */
12090 Evas_Coord mx; /**< Momentum on X */
12091 Evas_Coord my; /**< Momentum on Y */
12095 * @typedef Elm_Gesture_Momentum_Info
12096 * holds momentum info for user
12097 * @ingroup Elm_Gesture_Layer
12099 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12102 * @struct _Elm_Gesture_Line_Info
12103 * Struct holds line info for user
12104 * @ingroup Elm_Gesture_Layer
12106 struct _Elm_Gesture_Line_Info
12107 { /* Report line ends, timestamps, and momentum computed */
12108 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12109 unsigned int n; /**< Number of fingers (lines) */
12110 /* FIXME should be radians, bot degrees */
12111 double angle; /**< Angle (direction) of lines */
12115 * @typedef Elm_Gesture_Line_Info
12116 * Holds line info for user
12117 * @ingroup Elm_Gesture_Layer
12119 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12122 * @struct _Elm_Gesture_Zoom_Info
12123 * Struct holds zoom info for user
12124 * @ingroup Elm_Gesture_Layer
12126 struct _Elm_Gesture_Zoom_Info
12128 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12129 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12130 double zoom; /**< Zoom value: 1.0 means no zoom */
12131 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12135 * @typedef Elm_Gesture_Zoom_Info
12136 * Holds zoom info for user
12137 * @ingroup Elm_Gesture_Layer
12139 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12142 * @struct _Elm_Gesture_Rotate_Info
12143 * Struct holds rotation info for user
12144 * @ingroup Elm_Gesture_Layer
12146 struct _Elm_Gesture_Rotate_Info
12148 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12149 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12150 double base_angle; /**< Holds start-angle */
12151 double angle; /**< Rotation value: 0.0 means no rotation */
12152 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12156 * @typedef Elm_Gesture_Rotate_Info
12157 * Holds rotation info for user
12158 * @ingroup Elm_Gesture_Layer
12160 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12163 * @typedef Elm_Gesture_Event_Cb
12164 * User callback used to stream gesture info from gesture layer
12165 * @param data user data
12166 * @param event_info gesture report info
12167 * Returns a flag field to be applied on the causing event.
12168 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12169 * upon the event, in an irreversible way.
12171 * @ingroup Elm_Gesture_Layer
12173 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12176 * Use function to set callbacks to be notified about
12177 * change of state of gesture.
12178 * When a user registers a callback with this function
12179 * this means this gesture has to be tested.
12181 * When ALL callbacks for a gesture are set to NULL
12182 * it means user isn't interested in gesture-state
12183 * and it will not be tested.
12185 * @param obj Pointer to gesture-layer.
12186 * @param idx The gesture you would like to track its state.
12187 * @param cb callback function pointer.
12188 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12189 * @param data user info to be sent to callback (usually, Smart Data)
12191 * @ingroup Elm_Gesture_Layer
12193 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);
12196 * Call this function to get repeat-events settings.
12198 * @param obj Pointer to gesture-layer.
12200 * @return repeat events settings.
12201 * @see elm_gesture_layer_hold_events_set()
12202 * @ingroup Elm_Gesture_Layer
12204 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12207 * This function called in order to make gesture-layer repeat events.
12208 * Set this of you like to get the raw events only if gestures were not detected.
12209 * Clear this if you like gesture layer to fwd events as testing gestures.
12211 * @param obj Pointer to gesture-layer.
12212 * @param r Repeat: TRUE/FALSE
12214 * @ingroup Elm_Gesture_Layer
12216 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12219 * This function sets step-value for zoom action.
12220 * Set step to any positive value.
12221 * Cancel step setting by setting to 0.0
12223 * @param obj Pointer to gesture-layer.
12224 * @param s new zoom step value.
12226 * @ingroup Elm_Gesture_Layer
12228 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12231 * This function sets step-value for rotate action.
12232 * Set step to any positive value.
12233 * Cancel step setting by setting to 0.0
12235 * @param obj Pointer to gesture-layer.
12236 * @param s new roatate step value.
12238 * @ingroup Elm_Gesture_Layer
12240 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12243 * This function called to attach gesture-layer to an Evas_Object.
12244 * @param obj Pointer to gesture-layer.
12245 * @param t Pointer to underlying object (AKA Target)
12247 * @return TRUE, FALSE on success, failure.
12249 * @ingroup Elm_Gesture_Layer
12251 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12254 * Call this function to construct a new gesture-layer object.
12255 * This does not activate the gesture layer. You have to
12256 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12258 * @param parent the parent object.
12260 * @return Pointer to new gesture-layer object.
12262 * @ingroup Elm_Gesture_Layer
12264 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12267 * @defgroup Thumb Thumb
12269 * @image html img/widget/thumb/preview-00.png
12270 * @image latex img/widget/thumb/preview-00.eps
12272 * A thumb object is used for displaying the thumbnail of an image or video.
12273 * You must have compiled Elementary with Ethumb_Client support and the DBus
12274 * service must be present and auto-activated in order to have thumbnails to
12277 * Once the thumbnail object becomes visible, it will check if there is a
12278 * previously generated thumbnail image for the file set on it. If not, it
12279 * will start generating this thumbnail.
12281 * Different config settings will cause different thumbnails to be generated
12282 * even on the same file.
12284 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12285 * Ethumb documentation to change this path, and to see other configuration
12288 * Signals that you can add callbacks for are:
12290 * - "clicked" - This is called when a user has clicked the thumb without dragging
12292 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12293 * - "press" - This is called when a user has pressed down the thumb.
12294 * - "generate,start" - The thumbnail generation started.
12295 * - "generate,stop" - The generation process stopped.
12296 * - "generate,error" - The generation failed.
12297 * - "load,error" - The thumbnail image loading failed.
12299 * available styles:
12303 * An example of use of thumbnail:
12305 * - @ref thumb_example_01
12309 * @addtogroup Thumb
12314 * @enum _Elm_Thumb_Animation_Setting
12315 * @typedef Elm_Thumb_Animation_Setting
12317 * Used to set if a video thumbnail is animating or not.
12321 typedef enum _Elm_Thumb_Animation_Setting
12323 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12324 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12325 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12326 ELM_THUMB_ANIMATION_LAST
12327 } Elm_Thumb_Animation_Setting;
12330 * Add a new thumb object to the parent.
12332 * @param parent The parent object.
12333 * @return The new object or NULL if it cannot be created.
12335 * @see elm_thumb_file_set()
12336 * @see elm_thumb_ethumb_client_get()
12340 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12342 * Reload thumbnail if it was generated before.
12344 * @param obj The thumb object to reload
12346 * This is useful if the ethumb client configuration changed, like its
12347 * size, aspect or any other property one set in the handle returned
12348 * by elm_thumb_ethumb_client_get().
12350 * If the options didn't change, the thumbnail won't be generated again, but
12351 * the old one will still be used.
12353 * @see elm_thumb_file_set()
12357 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12359 * Set the file that will be used as thumbnail.
12361 * @param obj The thumb object.
12362 * @param file The path to file that will be used as thumb.
12363 * @param key The key used in case of an EET file.
12365 * The file can be an image or a video (in that case, acceptable extensions are:
12366 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12367 * function elm_thumb_animate().
12369 * @see elm_thumb_file_get()
12370 * @see elm_thumb_reload()
12371 * @see elm_thumb_animate()
12375 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12377 * Get the image or video path and key used to generate the thumbnail.
12379 * @param obj The thumb object.
12380 * @param file Pointer to filename.
12381 * @param key Pointer to key.
12383 * @see elm_thumb_file_set()
12384 * @see elm_thumb_path_get()
12388 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12390 * Get the path and key to the image or video generated by ethumb.
12392 * One just need to make sure that the thumbnail was generated before getting
12393 * its path; otherwise, the path will be NULL. One way to do that is by asking
12394 * for the path when/after the "generate,stop" smart callback is called.
12396 * @param obj The thumb object.
12397 * @param file Pointer to thumb path.
12398 * @param key Pointer to thumb key.
12400 * @see elm_thumb_file_get()
12404 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12406 * Set the animation state for the thumb object. If its content is an animated
12407 * video, you may start/stop the animation or tell it to play continuously and
12410 * @param obj The thumb object.
12411 * @param setting The animation setting.
12413 * @see elm_thumb_file_set()
12417 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12419 * Get the animation state for the thumb object.
12421 * @param obj The thumb object.
12422 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12425 * @see elm_thumb_animate_set()
12429 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12431 * Get the ethumb_client handle so custom configuration can be made.
12433 * @return Ethumb_Client instance or NULL.
12435 * This must be called before the objects are created to be sure no object is
12436 * visible and no generation started.
12438 * Example of usage:
12441 * #include <Elementary.h>
12442 * #ifndef ELM_LIB_QUICKLAUNCH
12444 * elm_main(int argc, char **argv)
12446 * Ethumb_Client *client;
12448 * elm_need_ethumb();
12452 * client = elm_thumb_ethumb_client_get();
12455 * ERR("could not get ethumb_client");
12458 * ethumb_client_size_set(client, 100, 100);
12459 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12462 * // Create elm_thumb objects here
12472 * @note There's only one client handle for Ethumb, so once a configuration
12473 * change is done to it, any other request for thumbnails (for any thumbnail
12474 * object) will use that configuration. Thus, this configuration is global.
12478 EAPI void *elm_thumb_ethumb_client_get(void);
12480 * Get the ethumb_client connection state.
12482 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12485 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12487 * Make the thumbnail 'editable'.
12489 * @param obj Thumb object.
12490 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12492 * This means the thumbnail is a valid drag target for drag and drop, and can be
12493 * cut or pasted too.
12495 * @see elm_thumb_editable_get()
12499 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12501 * Make the thumbnail 'editable'.
12503 * @param obj Thumb object.
12504 * @return Editability.
12506 * This means the thumbnail is a valid drag target for drag and drop, and can be
12507 * cut or pasted too.
12509 * @see elm_thumb_editable_set()
12513 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12520 * @defgroup Hoversel Hoversel
12522 * @image html img/widget/hoversel/preview-00.png
12523 * @image latex img/widget/hoversel/preview-00.eps
12525 * A hoversel is a button that pops up a list of items (automatically
12526 * choosing the direction to display) that have a label and, optionally, an
12527 * icon to select from. It is a convenience widget to avoid the need to do
12528 * all the piecing together yourself. It is intended for a small number of
12529 * items in the hoversel menu (no more than 8), though is capable of many
12532 * Signals that you can add callbacks for are:
12533 * "clicked" - the user clicked the hoversel button and popped up the sel
12534 * "selected" - an item in the hoversel list is selected. event_info is the item
12535 * "dismissed" - the hover is dismissed
12537 * See @ref tutorial_hoversel for an example.
12540 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12542 * @brief Add a new Hoversel object
12544 * @param parent The parent object
12545 * @return The new object or NULL if it cannot be created
12547 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12549 * @brief This sets the hoversel to expand horizontally.
12551 * @param obj The hoversel object
12552 * @param horizontal If true, the hover will expand horizontally to the
12555 * @note The initial button will display horizontally regardless of this
12558 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12560 * @brief This returns whether the hoversel is set to expand horizontally.
12562 * @param obj The hoversel object
12563 * @return If true, the hover will expand horizontally to the right.
12565 * @see elm_hoversel_horizontal_set()
12567 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12569 * @brief Set the Hover parent
12571 * @param obj The hoversel object
12572 * @param parent The parent to use
12574 * Sets the hover parent object, the area that will be darkened when the
12575 * hoversel is clicked. Should probably be the window that the hoversel is
12576 * in. See @ref Hover objects for more information.
12578 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12580 * @brief Get the Hover parent
12582 * @param obj The hoversel object
12583 * @return The used parent
12585 * Gets the hover parent object.
12587 * @see elm_hoversel_hover_parent_set()
12589 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12591 * @brief Set the hoversel button label
12593 * @param obj The hoversel object
12594 * @param label The label text.
12596 * This sets the label of the button that is always visible (before it is
12597 * clicked and expanded).
12599 * @deprecated elm_object_text_set()
12601 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12603 * @brief Get the hoversel button label
12605 * @param obj The hoversel object
12606 * @return The label text.
12608 * @deprecated elm_object_text_get()
12610 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12612 * @brief Set the icon of the hoversel button
12614 * @param obj The hoversel object
12615 * @param icon The icon object
12617 * Sets the icon of the button that is always visible (before it is clicked
12618 * and expanded). Once the icon object is set, a previously set one will be
12619 * deleted, if you want to keep that old content object, use the
12620 * elm_hoversel_icon_unset() function.
12622 * @see elm_button_icon_set()
12624 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12626 * @brief Get the icon of the hoversel button
12628 * @param obj The hoversel object
12629 * @return The icon object
12631 * Get the icon of the button that is always visible (before it is clicked
12632 * and expanded). Also see elm_button_icon_get().
12634 * @see elm_hoversel_icon_set()
12636 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12638 * @brief Get and unparent the icon of the hoversel button
12640 * @param obj The hoversel object
12641 * @return The icon object that was being used
12643 * Unparent and return the icon of the button that is always visible
12644 * (before it is clicked and expanded).
12646 * @see elm_hoversel_icon_set()
12647 * @see elm_button_icon_unset()
12649 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12651 * @brief This triggers the hoversel popup from code, the same as if the user
12652 * had clicked the button.
12654 * @param obj The hoversel object
12656 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12658 * @brief This dismisses the hoversel popup as if the user had clicked
12659 * outside the hover.
12661 * @param obj The hoversel object
12663 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12665 * @brief Returns whether the hoversel is expanded.
12667 * @param obj The hoversel object
12668 * @return This will return EINA_TRUE if the hoversel is expanded or
12669 * EINA_FALSE if it is not expanded.
12671 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12673 * @brief This will remove all the children items from the hoversel.
12675 * @param obj The hoversel object
12677 * @warning Should @b not be called while the hoversel is active; use
12678 * elm_hoversel_expanded_get() to check first.
12680 * @see elm_hoversel_item_del_cb_set()
12681 * @see elm_hoversel_item_del()
12683 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12685 * @brief Get the list of items within the given hoversel.
12687 * @param obj The hoversel object
12688 * @return Returns a list of Elm_Hoversel_Item*
12690 * @see elm_hoversel_item_add()
12692 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12694 * @brief Add an item to the hoversel button
12696 * @param obj The hoversel object
12697 * @param label The text label to use for the item (NULL if not desired)
12698 * @param icon_file An image file path on disk to use for the icon or standard
12699 * icon name (NULL if not desired)
12700 * @param icon_type The icon type if relevant
12701 * @param func Convenience function to call when this item is selected
12702 * @param data Data to pass to item-related functions
12703 * @return A handle to the item added.
12705 * This adds an item to the hoversel to show when it is clicked. Note: if you
12706 * need to use an icon from an edje file then use
12707 * elm_hoversel_item_icon_set() right after the this function, and set
12708 * icon_file to NULL here.
12710 * For more information on what @p icon_file and @p icon_type are see the
12711 * @ref Icon "icon documentation".
12713 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);
12715 * @brief Delete an item from the hoversel
12717 * @param item The item to delete
12719 * This deletes the item from the hoversel (should not be called while the
12720 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12722 * @see elm_hoversel_item_add()
12723 * @see elm_hoversel_item_del_cb_set()
12725 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12727 * @brief Set the function to be called when an item from the hoversel is
12730 * @param item The item to set the callback on
12731 * @param func The function called
12733 * That function will receive these parameters:
12734 * @li void *item_data
12735 * @li Evas_Object *the_item_object
12736 * @li Elm_Hoversel_Item *the_object_struct
12738 * @see elm_hoversel_item_add()
12740 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12742 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12743 * that will be passed to associated function callbacks.
12745 * @param item The item to get the data from
12746 * @return The data pointer set with elm_hoversel_item_add()
12748 * @see elm_hoversel_item_add()
12750 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12752 * @brief This returns the label text of the given hoversel item.
12754 * @param item The item to get the label
12755 * @return The label text of the hoversel item
12757 * @see elm_hoversel_item_add()
12759 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12761 * @brief This sets the icon for the given hoversel item.
12763 * @param item The item to set the icon
12764 * @param icon_file An image file path on disk to use for the icon or standard
12766 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12767 * to NULL if the icon is not an edje file
12768 * @param icon_type The icon type
12770 * The icon can be loaded from the standard set, from an image file, or from
12773 * @see elm_hoversel_item_add()
12775 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);
12777 * @brief Get the icon object of the hoversel item
12779 * @param item The item to get the icon from
12780 * @param icon_file The image file path on disk used for the icon or standard
12782 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12783 * if the icon is not an edje file
12784 * @param icon_type The icon type
12786 * @see elm_hoversel_item_icon_set()
12787 * @see elm_hoversel_item_add()
12789 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);
12795 * @defgroup Toolbar Toolbar
12796 * @ingroup Elementary
12798 * @image html img/widget/toolbar/preview-00.png
12799 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12801 * @image html img/toolbar.png
12802 * @image latex img/toolbar.eps width=\textwidth
12804 * A toolbar is a widget that displays a list of items inside
12805 * a box. It can be scrollable, show a menu with items that don't fit
12806 * to toolbar size or even crop them.
12808 * Only one item can be selected at a time.
12810 * Items can have multiple states, or show menus when selected by the user.
12812 * Smart callbacks one can listen to:
12813 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12815 * Available styles for it:
12817 * - @c "transparent" - no background or shadow, just show the content
12819 * List of examples:
12820 * @li @ref toolbar_example_01
12821 * @li @ref toolbar_example_02
12822 * @li @ref toolbar_example_03
12826 * @addtogroup Toolbar
12831 * @enum _Elm_Toolbar_Shrink_Mode
12832 * @typedef Elm_Toolbar_Shrink_Mode
12834 * Set toolbar's items display behavior, it can be scrollabel,
12835 * show a menu with exceeding items, or simply hide them.
12837 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12840 * Values <b> don't </b> work as bitmask, only one can be choosen.
12842 * @see elm_toolbar_mode_shrink_set()
12843 * @see elm_toolbar_mode_shrink_get()
12847 typedef enum _Elm_Toolbar_Shrink_Mode
12849 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12850 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12851 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12852 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12853 } Elm_Toolbar_Shrink_Mode;
12855 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(). */
12857 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(). */
12860 * Add a new toolbar widget to the given parent Elementary
12861 * (container) object.
12863 * @param parent The parent object.
12864 * @return a new toolbar widget handle or @c NULL, on errors.
12866 * This function inserts a new toolbar widget on the canvas.
12870 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12873 * Set the icon size, in pixels, to be used by toolbar items.
12875 * @param obj The toolbar object
12876 * @param icon_size The icon size in pixels
12878 * @note Default value is @c 32. It reads value from elm config.
12880 * @see elm_toolbar_icon_size_get()
12884 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12887 * Get the icon size, in pixels, to be used by toolbar items.
12889 * @param obj The toolbar object.
12890 * @return The icon size in pixels.
12892 * @see elm_toolbar_icon_size_set() for details.
12896 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12899 * Sets icon lookup order, for toolbar items' icons.
12901 * @param obj The toolbar object.
12902 * @param order The icon lookup order.
12904 * Icons added before calling this function will not be affected.
12905 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12907 * @see elm_toolbar_icon_order_lookup_get()
12911 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12914 * Gets the icon lookup order.
12916 * @param obj The toolbar object.
12917 * @return The icon lookup order.
12919 * @see elm_toolbar_icon_order_lookup_set() for details.
12923 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12926 * Set whether the toolbar items' should be selected by the user or not.
12928 * @param obj The toolbar object.
12929 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12932 * This will turn off the ability to select items entirely and they will
12933 * neither appear selected nor emit selected signals. The clicked
12934 * callback function will still be called.
12936 * Selection is enabled by default.
12938 * @see elm_toolbar_no_select_mode_get().
12942 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12945 * Set whether the toolbar items' should be selected by the user or not.
12947 * @param obj The toolbar object.
12948 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12949 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12951 * @see elm_toolbar_no_select_mode_set() for details.
12955 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12958 * Append item to the toolbar.
12960 * @param obj The toolbar object.
12961 * @param icon A string with icon name or the absolute path of an image file.
12962 * @param label The label of the item.
12963 * @param func The function to call when the item is clicked.
12964 * @param data The data to associate with the item for related callbacks.
12965 * @return The created item or @c NULL upon failure.
12967 * A new item will be created and appended to the toolbar, i.e., will
12968 * be set as @b last item.
12970 * Items created with this method can be deleted with
12971 * elm_toolbar_item_del().
12973 * Associated @p data can be properly freed when item is deleted if a
12974 * callback function is set with elm_toolbar_item_del_cb_set().
12976 * If a function is passed as argument, it will be called everytime this item
12977 * is selected, i.e., the user clicks over an unselected item.
12978 * If such function isn't needed, just passing
12979 * @c NULL as @p func is enough. The same should be done for @p data.
12981 * Toolbar will load icon image from fdo or current theme.
12982 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12983 * If an absolute path is provided it will load it direct from a file.
12985 * @see elm_toolbar_item_icon_set()
12986 * @see elm_toolbar_item_del()
12987 * @see elm_toolbar_item_del_cb_set()
12991 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);
12994 * Prepend item to the toolbar.
12996 * @param obj The toolbar object.
12997 * @param icon A string with icon name or the absolute path of an image file.
12998 * @param label The label of the item.
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 * @return The created item or @c NULL upon failure.
13003 * A new item will be created and prepended to the toolbar, i.e., will
13004 * be set as @b first item.
13006 * Items created with this method can be deleted with
13007 * elm_toolbar_item_del().
13009 * Associated @p data can be properly freed when item is deleted if a
13010 * callback function is set with elm_toolbar_item_del_cb_set().
13012 * If a function is passed as argument, it will be called everytime this item
13013 * is selected, i.e., the user clicks over an unselected item.
13014 * If such function isn't needed, just passing
13015 * @c NULL as @p func is enough. The same should be done for @p data.
13017 * Toolbar will load icon image from fdo or current theme.
13018 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13019 * If an absolute path is provided it will load it direct from a file.
13021 * @see elm_toolbar_item_icon_set()
13022 * @see elm_toolbar_item_del()
13023 * @see elm_toolbar_item_del_cb_set()
13027 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);
13030 * Insert a new item into the toolbar object before item @p before.
13032 * @param obj The toolbar object.
13033 * @param before The toolbar item to insert before.
13034 * @param icon A string with icon name or the absolute path of an image file.
13035 * @param label The label of the item.
13036 * @param func The function to call when the item is clicked.
13037 * @param data The data to associate with the item for related callbacks.
13038 * @return The created item or @c NULL upon failure.
13040 * A new item will be created and added to the toolbar. Its position in
13041 * this toolbar will be just before item @p before.
13043 * Items created with this method can be deleted with
13044 * elm_toolbar_item_del().
13046 * Associated @p data can be properly freed when item is deleted if a
13047 * callback function is set with elm_toolbar_item_del_cb_set().
13049 * If a function is passed as argument, it will be called everytime this item
13050 * is selected, i.e., the user clicks over an unselected item.
13051 * If such function isn't needed, just passing
13052 * @c NULL as @p func is enough. The same should be done for @p data.
13054 * Toolbar will load icon image from fdo or current theme.
13055 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13056 * If an absolute path is provided it will load it direct from a file.
13058 * @see elm_toolbar_item_icon_set()
13059 * @see elm_toolbar_item_del()
13060 * @see elm_toolbar_item_del_cb_set()
13064 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);
13067 * Insert a new item into the toolbar object after item @p after.
13069 * @param obj The toolbar object.
13070 * @param before The toolbar item to insert before.
13071 * @param icon A string with icon name or the absolute path of an image file.
13072 * @param label The label of the item.
13073 * @param func The function to call when the item is clicked.
13074 * @param data The data to associate with the item for related callbacks.
13075 * @return The created item or @c NULL upon failure.
13077 * A new item will be created and added to the toolbar. Its position in
13078 * this toolbar will be just after item @p after.
13080 * Items created with this method can be deleted with
13081 * elm_toolbar_item_del().
13083 * Associated @p data can be properly freed when item is deleted if a
13084 * callback function is set with elm_toolbar_item_del_cb_set().
13086 * If a function is passed as argument, it will be called everytime this item
13087 * is selected, i.e., the user clicks over an unselected item.
13088 * If such function isn't needed, just passing
13089 * @c NULL as @p func is enough. The same should be done for @p data.
13091 * Toolbar will load icon image from fdo or current theme.
13092 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13093 * If an absolute path is provided it will load it direct from a file.
13095 * @see elm_toolbar_item_icon_set()
13096 * @see elm_toolbar_item_del()
13097 * @see elm_toolbar_item_del_cb_set()
13101 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);
13104 * Get the first item in the given toolbar widget's list of
13107 * @param obj The toolbar object
13108 * @return The first item or @c NULL, if it has no items (and on
13111 * @see elm_toolbar_item_append()
13112 * @see elm_toolbar_last_item_get()
13116 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13119 * Get the last item in the given toolbar widget's list of
13122 * @param obj The toolbar object
13123 * @return The last item or @c NULL, if it has no items (and on
13126 * @see elm_toolbar_item_prepend()
13127 * @see elm_toolbar_first_item_get()
13131 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13134 * Get the item after @p item in toolbar.
13136 * @param item The toolbar item.
13137 * @return The item after @p item, or @c NULL if none or on failure.
13139 * @note If it is the last item, @c NULL will be returned.
13141 * @see elm_toolbar_item_append()
13145 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13148 * Get the item before @p item in toolbar.
13150 * @param item The toolbar item.
13151 * @return The item before @p item, or @c NULL if none or on failure.
13153 * @note If it is the first item, @c NULL will be returned.
13155 * @see elm_toolbar_item_prepend()
13159 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13162 * Get the toolbar object from an item.
13164 * @param item The item.
13165 * @return The toolbar object.
13167 * This returns the toolbar object itself that an item belongs to.
13171 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13174 * Set the priority of a toolbar item.
13176 * @param item The toolbar item.
13177 * @param priority The item priority. The default is zero.
13179 * This is used only when the toolbar shrink mode is set to
13180 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13181 * When space is less than required, items with low priority
13182 * will be removed from the toolbar and added to a dynamically-created menu,
13183 * while items with higher priority will remain on the toolbar,
13184 * with the same order they were added.
13186 * @see elm_toolbar_item_priority_get()
13190 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13193 * Get the priority of a toolbar item.
13195 * @param item The toolbar item.
13196 * @return The @p item priority, or @c 0 on failure.
13198 * @see elm_toolbar_item_priority_set() for details.
13202 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13205 * Get the label of item.
13207 * @param item The item of toolbar.
13208 * @return The label of item.
13210 * The return value is a pointer to the label associated to @p item when
13211 * it was created, with function elm_toolbar_item_append() or similar,
13213 * with function elm_toolbar_item_label_set. If no label
13214 * was passed as argument, it will return @c NULL.
13216 * @see elm_toolbar_item_label_set() for more details.
13217 * @see elm_toolbar_item_append()
13221 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13224 * Set the label of item.
13226 * @param item The item of toolbar.
13227 * @param text The label of item.
13229 * The label to be displayed by the item.
13230 * Label will be placed at icons bottom (if set).
13232 * If a label was passed as argument on item creation, with function
13233 * elm_toolbar_item_append() or similar, it will be already
13234 * displayed by the item.
13236 * @see elm_toolbar_item_label_get()
13237 * @see elm_toolbar_item_append()
13241 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13244 * Return the data associated with a given toolbar widget item.
13246 * @param item The toolbar widget item handle.
13247 * @return The data associated with @p item.
13249 * @see elm_toolbar_item_data_set()
13253 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13256 * Set the data associated with a given toolbar widget item.
13258 * @param item The toolbar widget item handle.
13259 * @param data The new data pointer to set to @p item.
13261 * This sets new item data on @p item.
13263 * @warning The old data pointer won't be touched by this function, so
13264 * the user had better to free that old data himself/herself.
13268 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13271 * Returns a pointer to a toolbar item by its label.
13273 * @param obj The toolbar object.
13274 * @param label The label of the item to find.
13276 * @return The pointer to the toolbar item matching @p label or @c NULL
13281 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13284 * Get whether the @p item is selected or not.
13286 * @param item The toolbar item.
13287 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13288 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13290 * @see elm_toolbar_selected_item_set() for details.
13291 * @see elm_toolbar_item_selected_get()
13295 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13298 * Set the selected state of an item.
13300 * @param item The toolbar item
13301 * @param selected The selected state
13303 * This sets the selected state of the given item @p it.
13304 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13306 * If a new item is selected the previosly selected will be unselected.
13307 * Previoulsy selected item can be get with function
13308 * elm_toolbar_selected_item_get().
13310 * Selected items will be highlighted.
13312 * @see elm_toolbar_item_selected_get()
13313 * @see elm_toolbar_selected_item_get()
13317 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13320 * Get the selected item.
13322 * @param obj The toolbar object.
13323 * @return The selected toolbar item.
13325 * The selected item can be unselected with function
13326 * elm_toolbar_item_selected_set().
13328 * The selected item always will be highlighted on toolbar.
13330 * @see elm_toolbar_selected_items_get()
13334 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13337 * Set the icon associated with @p item.
13339 * @param obj The parent of this item.
13340 * @param item The toolbar item.
13341 * @param icon A string with icon name or the absolute path of an image file.
13343 * Toolbar will load icon image from fdo or current theme.
13344 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13345 * If an absolute path is provided it will load it direct from a file.
13347 * @see elm_toolbar_icon_order_lookup_set()
13348 * @see elm_toolbar_icon_order_lookup_get()
13352 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13355 * Get the string used to set the icon of @p item.
13357 * @param item The toolbar item.
13358 * @return The string associated with the icon object.
13360 * @see elm_toolbar_item_icon_set() for details.
13364 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13367 * Delete them item from the toolbar.
13369 * @param item The item of toolbar to be deleted.
13371 * @see elm_toolbar_item_append()
13372 * @see elm_toolbar_item_del_cb_set()
13376 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13379 * Set the function called when a toolbar item is freed.
13381 * @param item The item to set the callback on.
13382 * @param func The function called.
13384 * If there is a @p func, then it will be called prior item's memory release.
13385 * That will be called with the following arguments:
13387 * @li item's Evas object;
13390 * This way, a data associated to a toolbar item could be properly freed.
13394 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13397 * Get a value whether toolbar item is disabled or not.
13399 * @param item The item.
13400 * @return The disabled state.
13402 * @see elm_toolbar_item_disabled_set() for more details.
13406 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13409 * Sets the disabled/enabled state of a toolbar item.
13411 * @param item The item.
13412 * @param disabled The disabled state.
13414 * A disabled item cannot be selected or unselected. It will also
13415 * change its appearance (generally greyed out). This sets the
13416 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13421 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13424 * Set or unset item as a separator.
13426 * @param item The toolbar item.
13427 * @param setting @c EINA_TRUE to set item @p item as separator or
13428 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13430 * Items aren't set as separator by default.
13432 * If set as separator it will display separator theme, so won't display
13435 * @see elm_toolbar_item_separator_get()
13439 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13442 * Get a value whether item is a separator or not.
13444 * @param item The toolbar item.
13445 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13446 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13448 * @see elm_toolbar_item_separator_set() for details.
13452 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13455 * Set the shrink state of toolbar @p obj.
13457 * @param obj The toolbar object.
13458 * @param shrink_mode Toolbar's items display behavior.
13460 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13461 * but will enforce a minimun size so all the items will fit, won't scroll
13462 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13463 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13464 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13468 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13471 * Get the shrink mode of toolbar @p obj.
13473 * @param obj The toolbar object.
13474 * @return Toolbar's items display behavior.
13476 * @see elm_toolbar_mode_shrink_set() for details.
13480 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13483 * Enable/disable homogenous mode.
13485 * @param obj The toolbar object
13486 * @param homogeneous Assume the items within the toolbar are of the
13487 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13489 * This will enable the homogeneous mode where items are of the same size.
13490 * @see elm_toolbar_homogeneous_get()
13494 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13497 * Get whether the homogenous mode is enabled.
13499 * @param obj The toolbar object.
13500 * @return Assume the items within the toolbar are of the same height
13501 * and width (EINA_TRUE = on, EINA_FALSE = off).
13503 * @see elm_toolbar_homogeneous_set()
13507 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13510 * Enable/disable homogenous mode.
13512 * @param obj The toolbar object
13513 * @param homogeneous Assume the items within the toolbar are of the
13514 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13516 * This will enable the homogeneous mode where items are of the same size.
13517 * @see elm_toolbar_homogeneous_get()
13519 * @deprecated use elm_toolbar_homogeneous_set() instead.
13523 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13526 * Get whether the homogenous mode is enabled.
13528 * @param obj The toolbar object.
13529 * @return Assume the items within the toolbar are of the same height
13530 * and width (EINA_TRUE = on, EINA_FALSE = off).
13532 * @see elm_toolbar_homogeneous_set()
13533 * @deprecated use elm_toolbar_homogeneous_get() instead.
13537 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13540 * Set the parent object of the toolbar items' menus.
13542 * @param obj The toolbar object.
13543 * @param parent The parent of the menu objects.
13545 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13547 * For more details about setting the parent for toolbar menus, see
13548 * elm_menu_parent_set().
13550 * @see elm_menu_parent_set() for details.
13551 * @see elm_toolbar_item_menu_set() for details.
13555 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13558 * Get the parent object of the toolbar items' menus.
13560 * @param obj The toolbar object.
13561 * @return The parent of the menu objects.
13563 * @see elm_toolbar_menu_parent_set() for details.
13567 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13570 * Set the alignment of the items.
13572 * @param obj The toolbar object.
13573 * @param align The new alignment, a float between <tt> 0.0 </tt>
13574 * and <tt> 1.0 </tt>.
13576 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13577 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13580 * Centered items by default.
13582 * @see elm_toolbar_align_get()
13586 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13589 * Get the alignment of the items.
13591 * @param obj The toolbar object.
13592 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13595 * @see elm_toolbar_align_set() for details.
13599 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13602 * Set whether the toolbar item opens a menu.
13604 * @param item The toolbar item.
13605 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13607 * A toolbar item can be set to be a menu, using this function.
13609 * Once it is set to be a menu, it can be manipulated through the
13610 * menu-like function elm_toolbar_menu_parent_set() and the other
13611 * elm_menu functions, using the Evas_Object @c menu returned by
13612 * elm_toolbar_item_menu_get().
13614 * So, items to be displayed in this item's menu should be added with
13615 * elm_menu_item_add().
13617 * The following code exemplifies the most basic usage:
13619 * tb = elm_toolbar_add(win)
13620 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13621 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13622 * elm_toolbar_menu_parent_set(tb, win);
13623 * menu = elm_toolbar_item_menu_get(item);
13624 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13625 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13629 * @see elm_toolbar_item_menu_get()
13633 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13636 * Get toolbar item's menu.
13638 * @param item The toolbar item.
13639 * @return Item's menu object or @c NULL on failure.
13641 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13642 * this function will set it.
13644 * @see elm_toolbar_item_menu_set() for details.
13648 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13651 * Add a new state to @p item.
13653 * @param item The item.
13654 * @param icon A string with icon name or the absolute path of an image file.
13655 * @param label The label of the new state.
13656 * @param func The function to call when the item is clicked when this
13657 * state is selected.
13658 * @param data The data to associate with the state.
13659 * @return The toolbar item state, or @c NULL upon failure.
13661 * Toolbar will load icon image from fdo or current theme.
13662 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13663 * If an absolute path is provided it will load it direct from a file.
13665 * States created with this function can be removed with
13666 * elm_toolbar_item_state_del().
13668 * @see elm_toolbar_item_state_del()
13669 * @see elm_toolbar_item_state_sel()
13670 * @see elm_toolbar_item_state_get()
13674 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);
13677 * Delete a previoulsy added state to @p item.
13679 * @param item The toolbar item.
13680 * @param state The state to be deleted.
13681 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13683 * @see elm_toolbar_item_state_add()
13685 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13688 * Set @p state as the current state of @p it.
13690 * @param it The item.
13691 * @param state The state to use.
13692 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13694 * If @p state is @c NULL, it won't select any state and the default item's
13695 * icon and label will be used. It's the same behaviour than
13696 * elm_toolbar_item_state_unser().
13698 * @see elm_toolbar_item_state_unset()
13702 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13705 * Unset the state of @p it.
13707 * @param it The item.
13709 * The default icon and label from this item will be displayed.
13711 * @see elm_toolbar_item_state_set() for more details.
13715 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13718 * Get the current state of @p it.
13720 * @param item The item.
13721 * @return The selected state or @c NULL if none is selected or on failure.
13723 * @see elm_toolbar_item_state_set() for details.
13724 * @see elm_toolbar_item_state_unset()
13725 * @see elm_toolbar_item_state_add()
13729 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13732 * Get the state after selected state in toolbar's @p item.
13734 * @param it The toolbar item to change state.
13735 * @return The state after current state, or @c NULL on failure.
13737 * If last state is selected, this function will return first state.
13739 * @see elm_toolbar_item_state_set()
13740 * @see elm_toolbar_item_state_add()
13744 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13747 * Get the state before selected state in toolbar's @p item.
13749 * @param it The toolbar item to change state.
13750 * @return The state before current state, or @c NULL on failure.
13752 * If first state is selected, this function will return last state.
13754 * @see elm_toolbar_item_state_set()
13755 * @see elm_toolbar_item_state_add()
13759 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13762 * Set the text to be shown in a given toolbar item's tooltips.
13764 * @param item Target item.
13765 * @param text The text to set in the content.
13767 * Setup the text as tooltip to object. The item can have only one tooltip,
13768 * so any previous tooltip data - set with this function or
13769 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13771 * @see elm_object_tooltip_text_set() for more details.
13775 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13778 * Set the content to be shown in the tooltip item.
13780 * Setup the tooltip to item. The item can have only one tooltip,
13781 * so any previous tooltip data is removed. @p func(with @p data) will
13782 * be called every time that need show the tooltip and it should
13783 * return a valid Evas_Object. This object is then managed fully by
13784 * tooltip system and is deleted when the tooltip is gone.
13786 * @param item the toolbar item being attached a tooltip.
13787 * @param func the function used to create the tooltip contents.
13788 * @param data what to provide to @a func as callback data/context.
13789 * @param del_cb called when data is not needed anymore, either when
13790 * another callback replaces @a func, the tooltip is unset with
13791 * elm_toolbar_item_tooltip_unset() or the owner @a item
13792 * dies. This callback receives as the first parameter the
13793 * given @a data, and @c event_info is the item.
13795 * @see elm_object_tooltip_content_cb_set() for more details.
13799 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);
13802 * Unset tooltip from item.
13804 * @param item toolbar item to remove previously set tooltip.
13806 * Remove tooltip from item. The callback provided as del_cb to
13807 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13808 * it is not used anymore.
13810 * @see elm_object_tooltip_unset() for more details.
13811 * @see elm_toolbar_item_tooltip_content_cb_set()
13815 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13818 * Sets a different style for this item tooltip.
13820 * @note before you set a style you should define a tooltip with
13821 * elm_toolbar_item_tooltip_content_cb_set() or
13822 * elm_toolbar_item_tooltip_text_set()
13824 * @param item toolbar item with tooltip already set.
13825 * @param style the theme style to use (default, transparent, ...)
13827 * @see elm_object_tooltip_style_set() for more details.
13831 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13834 * Get the style for this item tooltip.
13836 * @param item toolbar item with tooltip already set.
13837 * @return style the theme style in use, defaults to "default". If the
13838 * object does not have a tooltip set, then NULL is returned.
13840 * @see elm_object_tooltip_style_get() for more details.
13841 * @see elm_toolbar_item_tooltip_style_set()
13845 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13848 * Set the type of mouse pointer/cursor decoration to be shown,
13849 * when the mouse pointer is over the given toolbar widget item
13851 * @param item toolbar item to customize cursor on
13852 * @param cursor the cursor type's name
13854 * This function works analogously as elm_object_cursor_set(), but
13855 * here the cursor's changing area is restricted to the item's
13856 * area, and not the whole widget's. Note that that item cursors
13857 * have precedence over widget cursors, so that a mouse over an
13858 * item with custom cursor set will always show @b that cursor.
13860 * If this function is called twice for an object, a previously set
13861 * cursor will be unset on the second call.
13863 * @see elm_object_cursor_set()
13864 * @see elm_toolbar_item_cursor_get()
13865 * @see elm_toolbar_item_cursor_unset()
13869 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13872 * Get the type of mouse pointer/cursor decoration set to be shown,
13873 * when the mouse pointer is over the given toolbar widget item
13875 * @param item toolbar item with custom cursor set
13876 * @return the cursor type's name or @c NULL, if no custom cursors
13877 * were set to @p item (and on errors)
13879 * @see elm_object_cursor_get()
13880 * @see elm_toolbar_item_cursor_set()
13881 * @see elm_toolbar_item_cursor_unset()
13885 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13888 * Unset any custom mouse pointer/cursor decoration set to be
13889 * shown, when the mouse pointer is over the given toolbar widget
13890 * item, thus making it show the @b default cursor again.
13892 * @param item a toolbar item
13894 * Use this call to undo any custom settings on this item's cursor
13895 * decoration, bringing it back to defaults (no custom style set).
13897 * @see elm_object_cursor_unset()
13898 * @see elm_toolbar_item_cursor_set()
13902 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13905 * Set a different @b style for a given custom cursor set for a
13908 * @param item toolbar item with custom cursor set
13909 * @param style the <b>theme style</b> to use (e.g. @c "default",
13910 * @c "transparent", etc)
13912 * This function only makes sense when one is using custom mouse
13913 * cursor decorations <b>defined in a theme file</b>, which can have,
13914 * given a cursor name/type, <b>alternate styles</b> on it. It
13915 * works analogously as elm_object_cursor_style_set(), but here
13916 * applyed only to toolbar item objects.
13918 * @warning Before you set a cursor style you should have definen a
13919 * custom cursor previously on the item, with
13920 * elm_toolbar_item_cursor_set()
13922 * @see elm_toolbar_item_cursor_engine_only_set()
13923 * @see elm_toolbar_item_cursor_style_get()
13927 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13930 * Get the current @b style set for a given toolbar item's custom
13933 * @param item toolbar item with custom cursor set.
13934 * @return style the cursor style in use. If the object does not
13935 * have a cursor set, then @c NULL is returned.
13937 * @see elm_toolbar_item_cursor_style_set() for more details
13941 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13944 * Set if the (custom)cursor for a given toolbar item should be
13945 * searched in its theme, also, or should only rely on the
13946 * rendering engine.
13948 * @param item item with custom (custom) cursor already set on
13949 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13950 * only on those provided by the rendering engine, @c EINA_FALSE to
13951 * have them searched on the widget's theme, as well.
13953 * @note This call is of use only if you've set a custom cursor
13954 * for toolbar items, with elm_toolbar_item_cursor_set().
13956 * @note By default, cursors will only be looked for between those
13957 * provided by the rendering engine.
13961 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13964 * Get if the (custom) cursor for a given toolbar item is being
13965 * searched in its theme, also, or is only relying on the rendering
13968 * @param item a toolbar item
13969 * @return @c EINA_TRUE, if cursors are being looked for only on
13970 * those provided by the rendering engine, @c EINA_FALSE if they
13971 * are being searched on the widget's theme, as well.
13973 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13977 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13980 * Change a toolbar's orientation
13981 * @param obj The toolbar object
13982 * @param vertical If @c EINA_TRUE, the toolbar is vertical
13983 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13986 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13989 * Get a toolbar's orientation
13990 * @param obj The toolbar object
13991 * @return If @c EINA_TRUE, the toolbar is vertical
13992 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13995 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14002 * @defgroup Tooltips Tooltips
14004 * The Tooltip is an (internal, for now) smart object used to show a
14005 * content in a frame on mouse hover of objects(or widgets), with
14006 * tips/information about them.
14011 EAPI double elm_tooltip_delay_get(void);
14012 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14013 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14014 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14015 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14016 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);
14017 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14018 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14019 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14020 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14021 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14028 * @defgroup Cursors Cursors
14030 * The Elementary cursor is an internal smart object used to
14031 * customize the mouse cursor displayed over objects (or
14032 * widgets). In the most common scenario, the cursor decoration
14033 * comes from the graphical @b engine Elementary is running
14034 * on. Those engines may provide different decorations for cursors,
14035 * and Elementary provides functions to choose them (think of X11
14036 * cursors, as an example).
14038 * There's also the possibility of, besides using engine provided
14039 * cursors, also use ones coming from Edje theming files. Both
14040 * globally and per widget, Elementary makes it possible for one to
14041 * make the cursors lookup to be held on engines only or on
14042 * Elementary's theme file, too.
14048 * Set the cursor to be shown when mouse is over the object
14050 * Set the cursor that will be displayed when mouse is over the
14051 * object. The object can have only one cursor set to it, so if
14052 * this function is called twice for an object, the previous set
14054 * If using X cursors, a definition of all the valid cursor names
14055 * is listed on Elementary_Cursors.h. If an invalid name is set
14056 * the default cursor will be used.
14058 * @param obj the object being set a cursor.
14059 * @param cursor the cursor name to be used.
14063 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14066 * Get the cursor to be shown when mouse is over the object
14068 * @param obj an object with cursor already set.
14069 * @return the cursor name.
14073 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14076 * Unset cursor for object
14078 * Unset cursor for object, and set the cursor to default if the mouse
14079 * was over this object.
14081 * @param obj Target object
14082 * @see elm_object_cursor_set()
14086 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14089 * Sets a different style for this object cursor.
14091 * @note before you set a style you should define a cursor with
14092 * elm_object_cursor_set()
14094 * @param obj an object with cursor already set.
14095 * @param style the theme style to use (default, transparent, ...)
14099 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14102 * Get the style for this object cursor.
14104 * @param obj an object with cursor already set.
14105 * @return style the theme style in use, defaults to "default". If the
14106 * object does not have a cursor set, then NULL is returned.
14110 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14113 * Set if the cursor set should be searched on the theme or should use
14114 * the provided by the engine, only.
14116 * @note before you set if should look on theme you should define a cursor
14117 * with elm_object_cursor_set(). By default it will only look for cursors
14118 * provided by the engine.
14120 * @param obj an object with cursor already set.
14121 * @param engine_only boolean to define it cursors should be looked only
14122 * between the provided by the engine or searched on widget's theme as well.
14126 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14129 * Get the cursor engine only usage for this object cursor.
14131 * @param obj an object with cursor already set.
14132 * @return engine_only boolean to define it cursors should be
14133 * looked only between the provided by the engine or searched on
14134 * widget's theme as well. If the object does not have a cursor
14135 * set, then EINA_FALSE is returned.
14139 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14142 * Get the configured cursor engine only usage
14144 * This gets the globally configured exclusive usage of engine cursors.
14146 * @return 1 if only engine cursors should be used
14149 EAPI int elm_cursor_engine_only_get(void);
14152 * Set the configured cursor engine only usage
14154 * This sets the globally configured exclusive usage of engine cursors.
14155 * It won't affect cursors set before changing this value.
14157 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14158 * look for them on theme before.
14159 * @return EINA_TRUE if value is valid and setted (0 or 1)
14162 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14169 * @defgroup Menu Menu
14171 * @image html img/widget/menu/preview-00.png
14172 * @image latex img/widget/menu/preview-00.eps
14174 * A menu is a list of items displayed above its parent. When the menu is
14175 * showing its parent is darkened. Each item can have a sub-menu. The menu
14176 * object can be used to display a menu on a right click event, in a toolbar,
14179 * Signals that you can add callbacks for are:
14180 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14181 * event_info is NULL.
14183 * @see @ref tutorial_menu
14186 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14188 * @brief Add a new menu to the parent
14190 * @param parent The parent object.
14191 * @return The new object or NULL if it cannot be created.
14193 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14195 * @brief Set the parent for the given menu widget
14197 * @param obj The menu object.
14198 * @param parent The new parent.
14200 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14202 * @brief Get the parent for the given menu widget
14204 * @param obj The menu object.
14205 * @return The parent.
14207 * @see elm_menu_parent_set()
14209 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14211 * @brief Move the menu to a new position
14213 * @param obj The menu object.
14214 * @param x The new position.
14215 * @param y The new position.
14217 * Sets the top-left position of the menu to (@p x,@p y).
14219 * @note @p x and @p y coordinates are relative to parent.
14221 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14223 * @brief Close a opened menu
14225 * @param obj the menu object
14228 * Hides the menu and all it's sub-menus.
14230 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14232 * @brief Returns a list of @p item's items.
14234 * @param obj The menu object
14235 * @return An Eina_List* of @p item's items
14237 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14239 * @brief Get the Evas_Object of an Elm_Menu_Item
14241 * @param item The menu item object.
14242 * @return The edje object containing the swallowed content
14244 * @warning Don't manipulate this object!
14246 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14248 * @brief Add an item at the end of the given menu widget
14250 * @param obj The menu object.
14251 * @param parent The parent menu item (optional)
14252 * @param icon A icon display on the item. The icon will be destryed by the menu.
14253 * @param label The label of the item.
14254 * @param func Function called when the user select the item.
14255 * @param data Data sent by the callback.
14256 * @return Returns the new item.
14258 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);
14260 * @brief Add an object swallowed in an item at the end of the given menu
14263 * @param obj The menu object.
14264 * @param parent The parent menu item (optional)
14265 * @param subobj The object to swallow
14266 * @param func Function called when the user select the item.
14267 * @param data Data sent by the callback.
14268 * @return Returns the new item.
14270 * Add an evas object as an item to the menu.
14272 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);
14274 * @brief Set the label of a menu item
14276 * @param item The menu item object.
14277 * @param label The label to set for @p item
14279 * @warning Don't use this funcion on items created with
14280 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14282 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14284 * @brief Get the label of a menu item
14286 * @param item The menu item object.
14287 * @return The label of @p item
14289 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14291 * @brief Set the icon of a menu item to the standard icon with name @p icon
14293 * @param item The menu item object.
14294 * @param icon The icon object to set for the content of @p item
14296 * Once this icon is set, any previously set icon will be deleted.
14298 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14300 * @brief Get the string representation from the icon of a menu item
14302 * @param item The menu item object.
14303 * @return The string representation of @p item's icon or NULL
14305 * @see elm_menu_item_object_icon_name_set()
14307 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14309 * @brief Set the content object of a menu item
14311 * @param item The menu item object
14312 * @param The content object or NULL
14313 * @return EINA_TRUE on success, else EINA_FALSE
14315 * Use this function to change the object swallowed by a menu item, deleting
14316 * any previously swallowed object.
14318 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14320 * @brief Get the content object of a menu item
14322 * @param item The menu item object
14323 * @return The content object or NULL
14324 * @note If @p item was added with elm_menu_item_add_object, this
14325 * function will return the object passed, else it will return the
14328 * @see elm_menu_item_object_content_set()
14330 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14332 * @brief Set the selected state of @p item.
14334 * @param item The menu item object.
14335 * @param selected The selected/unselected state of the item
14337 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14339 * @brief Get the selected state of @p item.
14341 * @param item The menu item object.
14342 * @return The selected/unselected state of the item
14344 * @see elm_menu_item_selected_set()
14346 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14348 * @brief Set the disabled state of @p item.
14350 * @param item The menu item object.
14351 * @param disabled The enabled/disabled state of the item
14353 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14355 * @brief Get the disabled state of @p item.
14357 * @param item The menu item object.
14358 * @return The enabled/disabled state of the item
14360 * @see elm_menu_item_disabled_set()
14362 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14364 * @brief Add a separator item to menu @p obj under @p parent.
14366 * @param obj The menu object
14367 * @param parent The item to add the separator under
14368 * @return The created item or NULL on failure
14370 * This is item is a @ref Separator.
14372 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14374 * @brief Returns whether @p item is a separator.
14376 * @param item The item to check
14377 * @return If true, @p item is a separator
14379 * @see elm_menu_item_separator_add()
14381 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14383 * @brief Deletes an item from the menu.
14385 * @param item The item to delete.
14387 * @see elm_menu_item_add()
14389 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14391 * @brief Set the function called when a menu item is deleted.
14393 * @param item The item to set the callback on
14394 * @param func The function called
14396 * @see elm_menu_item_add()
14397 * @see elm_menu_item_del()
14399 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14401 * @brief Returns the data associated with menu item @p item.
14403 * @param item The item
14404 * @return The data associated with @p item or NULL if none was set.
14406 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14408 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14410 * @brief Sets the data to be associated with menu item @p item.
14412 * @param item The item
14413 * @param data The data to be associated with @p item
14415 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14417 * @brief Returns a list of @p item's subitems.
14419 * @param item The item
14420 * @return An Eina_List* of @p item's subitems
14422 * @see elm_menu_add()
14424 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14426 * @brief Get the position of a menu item
14428 * @param item The menu item
14429 * @return The item's index
14431 * This function returns the index position of a menu item in a menu.
14432 * For a sub-menu, this number is relative to the first item in the sub-menu.
14434 * @note Index values begin with 0
14436 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14438 * @brief @brief Return a menu item's owner menu
14440 * @param item The menu item
14441 * @return The menu object owning @p item, or NULL on failure
14443 * Use this function to get the menu object owning an item.
14445 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14447 * @brief Get the selected item in the menu
14449 * @param obj The menu object
14450 * @return The selected item, or NULL if none
14452 * @see elm_menu_item_selected_get()
14453 * @see elm_menu_item_selected_set()
14455 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14457 * @brief Get the last item in the menu
14459 * @param obj The menu object
14460 * @return The last item, or NULL if none
14462 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14464 * @brief Get the first item in the menu
14466 * @param obj The menu object
14467 * @return The first item, or NULL if none
14469 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14471 * @brief Get the next item in the menu.
14473 * @param item The menu item object.
14474 * @return The item after it, or NULL if none
14476 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14478 * @brief Get the previous item in the menu.
14480 * @param item The menu item object.
14481 * @return The item before it, or NULL if none
14483 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14489 * @defgroup List List
14490 * @ingroup Elementary
14492 * @image html img/widget/list/preview-00.png
14493 * @image latex img/widget/list/preview-00.eps width=\textwidth
14495 * @image html img/list.png
14496 * @image latex img/list.eps width=\textwidth
14498 * A list widget is a container whose children are displayed vertically or
14499 * horizontally, in order, and can be selected.
14500 * The list can accept only one or multiple items selection. Also has many
14501 * modes of items displaying.
14503 * A list is a very simple type of list widget. For more robust
14504 * lists, @ref Genlist should probably be used.
14506 * Smart callbacks one can listen to:
14507 * - @c "activated" - The user has double-clicked or pressed
14508 * (enter|return|spacebar) on an item. The @c event_info parameter
14509 * is the item that was activated.
14510 * - @c "clicked,double" - The user has double-clicked an item.
14511 * The @c event_info parameter is the item that was double-clicked.
14512 * - "selected" - when the user selected an item
14513 * - "unselected" - when the user unselected an item
14514 * - "longpressed" - an item in the list is long-pressed
14515 * - "scroll,edge,top" - the list is scrolled until the top edge
14516 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14517 * - "scroll,edge,left" - the list is scrolled until the left edge
14518 * - "scroll,edge,right" - the list is scrolled until the right edge
14520 * Available styles for it:
14523 * List of examples:
14524 * @li @ref list_example_01
14525 * @li @ref list_example_02
14526 * @li @ref list_example_03
14535 * @enum _Elm_List_Mode
14536 * @typedef Elm_List_Mode
14538 * Set list's resize behavior, transverse axis scroll and
14539 * items cropping. See each mode's description for more details.
14541 * @note Default value is #ELM_LIST_SCROLL.
14543 * Values <b> don't </b> work as bitmask, only one can be choosen.
14545 * @see elm_list_mode_set()
14546 * @see elm_list_mode_get()
14550 typedef enum _Elm_List_Mode
14552 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. */
14553 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). */
14554 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. */
14555 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. */
14556 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14559 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(). */
14562 * Add a new list widget to the given parent Elementary
14563 * (container) object.
14565 * @param parent The parent object.
14566 * @return a new list widget handle or @c NULL, on errors.
14568 * This function inserts a new list widget on the canvas.
14572 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14577 * @param obj The list object
14579 * @note Call before running show() on the list object.
14580 * @warning If not called, it won't display the list properly.
14583 * li = elm_list_add(win);
14584 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14585 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14587 * evas_object_show(li);
14592 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14595 * Enable or disable multiple items selection on the list object.
14597 * @param obj The list object
14598 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14601 * Disabled by default. If disabled, the user can select a single item of
14602 * the list each time. Selected items are highlighted on list.
14603 * If enabled, many items can be selected.
14605 * If a selected item is selected again, it will be unselected.
14607 * @see elm_list_multi_select_get()
14611 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14614 * Get a value whether multiple items selection is enabled or not.
14616 * @see elm_list_multi_select_set() for details.
14618 * @param obj The list object.
14619 * @return @c EINA_TRUE means multiple items selection is enabled.
14620 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14621 * @c EINA_FALSE is returned.
14625 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14628 * Set which mode to use for the list object.
14630 * @param obj The list object
14631 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14632 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14634 * Set list's resize behavior, transverse axis scroll and
14635 * items cropping. See each mode's description for more details.
14637 * @note Default value is #ELM_LIST_SCROLL.
14639 * Only one can be set, if a previous one was set, it will be changed
14640 * by the new mode set. Bitmask won't work as well.
14642 * @see elm_list_mode_get()
14646 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14649 * Get the mode the list is at.
14651 * @param obj The list object
14652 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14653 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14655 * @note see elm_list_mode_set() for more information.
14659 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14662 * Enable or disable horizontal mode on the list object.
14664 * @param obj The list object.
14665 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14666 * disable it, i.e., to enable vertical mode.
14668 * @note Vertical mode is set by default.
14670 * On horizontal mode items are displayed on list from left to right,
14671 * instead of from top to bottom. Also, the list will scroll horizontally.
14672 * Each item will presents left icon on top and right icon, or end, at
14675 * @see elm_list_horizontal_get()
14679 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14682 * Get a value whether horizontal mode is enabled or not.
14684 * @param obj The list object.
14685 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14686 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14687 * @c EINA_FALSE is returned.
14689 * @see elm_list_horizontal_set() for details.
14693 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14696 * Enable or disable always select mode on the list object.
14698 * @param obj The list object
14699 * @param always_select @c EINA_TRUE to enable always select mode or
14700 * @c EINA_FALSE to disable it.
14702 * @note Always select mode is disabled by default.
14704 * Default behavior of list items is to only call its callback function
14705 * the first time it's pressed, i.e., when it is selected. If a selected
14706 * item is pressed again, and multi-select is disabled, it won't call
14707 * this function (if multi-select is enabled it will unselect the item).
14709 * If always select is enabled, it will call the callback function
14710 * everytime a item is pressed, so it will call when the item is selected,
14711 * and again when a selected item is pressed.
14713 * @see elm_list_always_select_mode_get()
14714 * @see elm_list_multi_select_set()
14718 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14721 * Get a value whether always select mode is enabled or not, meaning that
14722 * an item will always call its callback function, even if already selected.
14724 * @param obj The list object
14725 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14726 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14727 * @c EINA_FALSE is returned.
14729 * @see elm_list_always_select_mode_set() for details.
14733 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14736 * Set bouncing behaviour when the scrolled content reaches an edge.
14738 * Tell the internal scroller object whether it should bounce or not
14739 * when it reaches the respective edges for each axis.
14741 * @param obj The list object
14742 * @param h_bounce Whether to bounce or not in the horizontal axis.
14743 * @param v_bounce Whether to bounce or not in the vertical axis.
14745 * @see elm_scroller_bounce_set()
14749 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14752 * Get the bouncing behaviour of the internal scroller.
14754 * Get whether the internal scroller should bounce when the edge of each
14755 * axis is reached scrolling.
14757 * @param obj The list object.
14758 * @param h_bounce Pointer where to store the bounce state of the horizontal
14760 * @param v_bounce Pointer where to store the bounce state of the vertical
14763 * @see elm_scroller_bounce_get()
14764 * @see elm_list_bounce_set()
14768 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14771 * Set the scrollbar policy.
14773 * @param obj The list object
14774 * @param policy_h Horizontal scrollbar policy.
14775 * @param policy_v Vertical scrollbar policy.
14777 * This sets the scrollbar visibility policy for the given scroller.
14778 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14779 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14780 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14781 * This applies respectively for the horizontal and vertical scrollbars.
14783 * The both are disabled by default, i.e., are set to
14784 * #ELM_SCROLLER_POLICY_OFF.
14788 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14791 * Get the scrollbar policy.
14793 * @see elm_list_scroller_policy_get() for details.
14795 * @param obj The list object.
14796 * @param policy_h Pointer where to store horizontal scrollbar policy.
14797 * @param policy_v Pointer where to store vertical scrollbar policy.
14801 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);
14804 * Append a new item to the list object.
14806 * @param obj The list object.
14807 * @param label The label of the list item.
14808 * @param icon The icon object to use for the left side of the item. An
14809 * icon can be any Evas object, but usually it is an icon created
14810 * with elm_icon_add().
14811 * @param end The icon object to use for the right side of the item. An
14812 * icon can be any Evas object.
14813 * @param func The function to call when the item is clicked.
14814 * @param data The data to associate with the item for related callbacks.
14816 * @return The created item or @c NULL upon failure.
14818 * A new item will be created and appended to the list, i.e., will
14819 * be set as @b last item.
14821 * Items created with this method can be deleted with
14822 * elm_list_item_del().
14824 * Associated @p data can be properly freed when item is deleted if a
14825 * callback function is set with elm_list_item_del_cb_set().
14827 * If a function is passed as argument, it will be called everytime this item
14828 * is selected, i.e., the user clicks over an unselected item.
14829 * If always select is enabled it will call this function every time
14830 * user clicks over an item (already selected or not).
14831 * If such function isn't needed, just passing
14832 * @c NULL as @p func is enough. The same should be done for @p data.
14834 * Simple example (with no function callback or data associated):
14836 * li = elm_list_add(win);
14837 * ic = elm_icon_add(win);
14838 * elm_icon_file_set(ic, "path/to/image", NULL);
14839 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14840 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14842 * evas_object_show(li);
14845 * @see elm_list_always_select_mode_set()
14846 * @see elm_list_item_del()
14847 * @see elm_list_item_del_cb_set()
14848 * @see elm_list_clear()
14849 * @see elm_icon_add()
14853 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);
14856 * Prepend a new item to the list object.
14858 * @param obj The list object.
14859 * @param label The label of the list item.
14860 * @param icon The icon object to use for the left side of the item. An
14861 * icon can be any Evas object, but usually it is an icon created
14862 * with elm_icon_add().
14863 * @param end The icon object to use for the right side of the item. An
14864 * icon can be any Evas object.
14865 * @param func The function to call when the item is clicked.
14866 * @param data The data to associate with the item for related callbacks.
14868 * @return The created item or @c NULL upon failure.
14870 * A new item will be created and prepended to the list, i.e., will
14871 * be set as @b first item.
14873 * Items created with this method can be deleted with
14874 * elm_list_item_del().
14876 * Associated @p data can be properly freed when item is deleted if a
14877 * callback function is set with elm_list_item_del_cb_set().
14879 * If a function is passed as argument, it will be called everytime this item
14880 * is selected, i.e., the user clicks over an unselected item.
14881 * If always select is enabled it will call this function every time
14882 * user clicks over an item (already selected or not).
14883 * If such function isn't needed, just passing
14884 * @c NULL as @p func is enough. The same should be done for @p data.
14886 * @see elm_list_item_append() for a simple code example.
14887 * @see elm_list_always_select_mode_set()
14888 * @see elm_list_item_del()
14889 * @see elm_list_item_del_cb_set()
14890 * @see elm_list_clear()
14891 * @see elm_icon_add()
14895 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);
14898 * Insert a new item into the list object before item @p before.
14900 * @param obj The list object.
14901 * @param before The list item to insert before.
14902 * @param label The label of the list item.
14903 * @param icon The icon object to use for the left side of the item. An
14904 * icon can be any Evas object, but usually it is an icon created
14905 * with elm_icon_add().
14906 * @param end The icon object to use for the right side of the item. An
14907 * icon can be any Evas object.
14908 * @param func The function to call when the item is clicked.
14909 * @param data The data to associate with the item for related callbacks.
14911 * @return The created item or @c NULL upon failure.
14913 * A new item will be created and added to the list. Its position in
14914 * this list will be just before item @p before.
14916 * Items created with this method can be deleted with
14917 * elm_list_item_del().
14919 * Associated @p data can be properly freed when item is deleted if a
14920 * callback function is set with elm_list_item_del_cb_set().
14922 * If a function is passed as argument, it will be called everytime this item
14923 * is selected, i.e., the user clicks over an unselected item.
14924 * If always select is enabled it will call this function every time
14925 * user clicks over an item (already selected or not).
14926 * If such function isn't needed, just passing
14927 * @c NULL as @p func is enough. The same should be done for @p data.
14929 * @see elm_list_item_append() for a simple code example.
14930 * @see elm_list_always_select_mode_set()
14931 * @see elm_list_item_del()
14932 * @see elm_list_item_del_cb_set()
14933 * @see elm_list_clear()
14934 * @see elm_icon_add()
14938 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);
14941 * Insert a new item into the list object after item @p after.
14943 * @param obj The list object.
14944 * @param after The list item to insert after.
14945 * @param label The label of the list item.
14946 * @param icon The icon object to use for the left side of the item. An
14947 * icon can be any Evas object, but usually it is an icon created
14948 * with elm_icon_add().
14949 * @param end The icon object to use for the right side of the item. An
14950 * icon can be any Evas object.
14951 * @param func The function to call when the item is clicked.
14952 * @param data The data to associate with the item for related callbacks.
14954 * @return The created item or @c NULL upon failure.
14956 * A new item will be created and added to the list. Its position in
14957 * this list will be just after item @p after.
14959 * Items created with this method can be deleted with
14960 * elm_list_item_del().
14962 * Associated @p data can be properly freed when item is deleted if a
14963 * callback function is set with elm_list_item_del_cb_set().
14965 * If a function is passed as argument, it will be called everytime this item
14966 * is selected, i.e., the user clicks over an unselected item.
14967 * If always select is enabled it will call this function every time
14968 * user clicks over an item (already selected or not).
14969 * If such function isn't needed, just passing
14970 * @c NULL as @p func is enough. The same should be done for @p data.
14972 * @see elm_list_item_append() for a simple code example.
14973 * @see elm_list_always_select_mode_set()
14974 * @see elm_list_item_del()
14975 * @see elm_list_item_del_cb_set()
14976 * @see elm_list_clear()
14977 * @see elm_icon_add()
14981 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);
14984 * Insert a new item into the sorted list object.
14986 * @param obj The list object.
14987 * @param label The label of the list item.
14988 * @param icon The icon object to use for the left side of the item. An
14989 * icon can be any Evas object, but usually it is an icon created
14990 * with elm_icon_add().
14991 * @param end The icon object to use for the right side of the item. An
14992 * icon can be any Evas object.
14993 * @param func The function to call when the item is clicked.
14994 * @param data The data to associate with the item for related callbacks.
14995 * @param cmp_func The comparing function to be used to sort list
14996 * items <b>by #Elm_List_Item item handles</b>. This function will
14997 * receive two items and compare them, returning a non-negative integer
14998 * if the second item should be place after the first, or negative value
14999 * if should be placed before.
15001 * @return The created item or @c NULL upon failure.
15003 * @note This function inserts values into a list object assuming it was
15004 * sorted and the result will be sorted.
15006 * A new item will be created and added to the list. Its position in
15007 * this list will be found comparing the new item with previously inserted
15008 * items using function @p cmp_func.
15010 * Items created with this method can be deleted with
15011 * elm_list_item_del().
15013 * Associated @p data can be properly freed when item is deleted if a
15014 * callback function is set with elm_list_item_del_cb_set().
15016 * If a function is passed as argument, it will be called everytime this item
15017 * is selected, i.e., the user clicks over an unselected item.
15018 * If always select is enabled it will call this function every time
15019 * user clicks over an item (already selected or not).
15020 * If such function isn't needed, just passing
15021 * @c NULL as @p func is enough. The same should be done for @p data.
15023 * @see elm_list_item_append() for a simple code example.
15024 * @see elm_list_always_select_mode_set()
15025 * @see elm_list_item_del()
15026 * @see elm_list_item_del_cb_set()
15027 * @see elm_list_clear()
15028 * @see elm_icon_add()
15032 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);
15035 * Remove all list's items.
15037 * @param obj The list object
15039 * @see elm_list_item_del()
15040 * @see elm_list_item_append()
15044 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15047 * Get a list of all the list items.
15049 * @param obj The list object
15050 * @return An @c Eina_List of list items, #Elm_List_Item,
15051 * or @c NULL on failure.
15053 * @see elm_list_item_append()
15054 * @see elm_list_item_del()
15055 * @see elm_list_clear()
15059 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15062 * Get the selected item.
15064 * @param obj The list object.
15065 * @return The selected list item.
15067 * The selected item can be unselected with function
15068 * elm_list_item_selected_set().
15070 * The selected item always will be highlighted on list.
15072 * @see elm_list_selected_items_get()
15076 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15079 * Return a list of the currently selected list items.
15081 * @param obj The list object.
15082 * @return An @c Eina_List of list items, #Elm_List_Item,
15083 * or @c NULL on failure.
15085 * Multiple items can be selected if multi select is enabled. It can be
15086 * done with elm_list_multi_select_set().
15088 * @see elm_list_selected_item_get()
15089 * @see elm_list_multi_select_set()
15093 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15096 * Set the selected state of an item.
15098 * @param item The list item
15099 * @param selected The selected state
15101 * This sets the selected state of the given item @p it.
15102 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15104 * If a new item is selected the previosly selected will be unselected,
15105 * unless multiple selection is enabled with elm_list_multi_select_set().
15106 * Previoulsy selected item can be get with function
15107 * elm_list_selected_item_get().
15109 * Selected items will be highlighted.
15111 * @see elm_list_item_selected_get()
15112 * @see elm_list_selected_item_get()
15113 * @see elm_list_multi_select_set()
15117 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15120 * Get whether the @p item is selected or not.
15122 * @param item The list item.
15123 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15124 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15126 * @see elm_list_selected_item_set() for details.
15127 * @see elm_list_item_selected_get()
15131 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15134 * Set or unset item as a separator.
15136 * @param it The list item.
15137 * @param setting @c EINA_TRUE to set item @p it as separator or
15138 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15140 * Items aren't set as separator by default.
15142 * If set as separator it will display separator theme, so won't display
15145 * @see elm_list_item_separator_get()
15149 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15152 * Get a value whether item is a separator or not.
15154 * @see elm_list_item_separator_set() for details.
15156 * @param it The list item.
15157 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15158 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15162 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15165 * Show @p item in the list view.
15167 * @param item The list item to be shown.
15169 * It won't animate list until item is visible. If such behavior is wanted,
15170 * use elm_list_bring_in() intead.
15174 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15177 * Bring in the given item to list view.
15179 * @param item The item.
15181 * This causes list to jump to the given item @p item and show it
15182 * (by scrolling), if it is not fully visible.
15184 * This may use animation to do so and take a period of time.
15186 * If animation isn't wanted, elm_list_item_show() can be used.
15190 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15193 * Delete them item from the list.
15195 * @param item The item of list to be deleted.
15197 * If deleting all list items is required, elm_list_clear()
15198 * should be used instead of getting items list and deleting each one.
15200 * @see elm_list_clear()
15201 * @see elm_list_item_append()
15202 * @see elm_list_item_del_cb_set()
15206 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15209 * Set the function called when a list item is freed.
15211 * @param item The item to set the callback on
15212 * @param func The function called
15214 * If there is a @p func, then it will be called prior item's memory release.
15215 * That will be called with the following arguments:
15217 * @li item's Evas object;
15220 * This way, a data associated to a list item could be properly freed.
15224 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15227 * Get the data associated to the item.
15229 * @param item The list item
15230 * @return The data associated to @p item
15232 * The return value is a pointer to data associated to @p item when it was
15233 * created, with function elm_list_item_append() or similar. If no data
15234 * was passed as argument, it will return @c NULL.
15236 * @see elm_list_item_append()
15240 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15243 * Get the left side icon associated to the item.
15245 * @param item The list item
15246 * @return The left side icon associated to @p item
15248 * The return value is a pointer to the icon associated to @p item when
15250 * created, with function elm_list_item_append() or similar, or later
15251 * with function elm_list_item_icon_set(). If no icon
15252 * was passed as argument, it will return @c NULL.
15254 * @see elm_list_item_append()
15255 * @see elm_list_item_icon_set()
15259 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15262 * Set the left side icon associated to the item.
15264 * @param item The list item
15265 * @param icon The left side icon object to associate with @p item
15267 * The icon object to use at left side of the item. An
15268 * icon can be any Evas object, but usually it is an icon created
15269 * with elm_icon_add().
15271 * Once the icon object is set, a previously set one will be deleted.
15272 * @warning Setting the same icon for two items will cause the icon to
15273 * dissapear from the first item.
15275 * If an icon was passed as argument on item creation, with function
15276 * elm_list_item_append() or similar, it will be already
15277 * associated to the item.
15279 * @see elm_list_item_append()
15280 * @see elm_list_item_icon_get()
15284 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15287 * Get the right side icon associated to the item.
15289 * @param item The list item
15290 * @return The right side icon associated to @p item
15292 * The return value is a pointer to the icon associated to @p item when
15294 * created, with function elm_list_item_append() or similar, or later
15295 * with function elm_list_item_icon_set(). If no icon
15296 * was passed as argument, it will return @c NULL.
15298 * @see elm_list_item_append()
15299 * @see elm_list_item_icon_set()
15303 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15306 * Set the right side icon associated to the item.
15308 * @param item The list item
15309 * @param end The right side icon object to associate with @p item
15311 * The icon object to use at right side of the item. An
15312 * icon can be any Evas object, but usually it is an icon created
15313 * with elm_icon_add().
15315 * Once the icon object is set, a previously set one will be deleted.
15316 * @warning Setting the same icon for two items will cause the icon to
15317 * dissapear from the first item.
15319 * If an icon was passed as argument on item creation, with function
15320 * elm_list_item_append() or similar, it will be already
15321 * associated to the item.
15323 * @see elm_list_item_append()
15324 * @see elm_list_item_end_get()
15328 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15331 * Gets the base object of the item.
15333 * @param item The list item
15334 * @return The base object associated with @p item
15336 * Base object is the @c Evas_Object that represents that item.
15340 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15343 * Get the label of item.
15345 * @param item The item of list.
15346 * @return The label of item.
15348 * The return value is a pointer to the label associated to @p item when
15349 * it was created, with function elm_list_item_append(), or later
15350 * with function elm_list_item_label_set. If no label
15351 * was passed as argument, it will return @c NULL.
15353 * @see elm_list_item_label_set() for more details.
15354 * @see elm_list_item_append()
15358 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15361 * Set the label of item.
15363 * @param item The item of list.
15364 * @param text The label of item.
15366 * The label to be displayed by the item.
15367 * Label will be placed between left and right side icons (if set).
15369 * If a label was passed as argument on item creation, with function
15370 * elm_list_item_append() or similar, it will be already
15371 * displayed by the item.
15373 * @see elm_list_item_label_get()
15374 * @see elm_list_item_append()
15378 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15382 * Get the item before @p it in list.
15384 * @param it The list item.
15385 * @return The item before @p it, or @c NULL if none or on failure.
15387 * @note If it is the first item, @c NULL will be returned.
15389 * @see elm_list_item_append()
15390 * @see elm_list_items_get()
15394 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15397 * Get the item after @p it in list.
15399 * @param it The list item.
15400 * @return The item after @p it, or @c NULL if none or on failure.
15402 * @note If it is the last item, @c NULL will be returned.
15404 * @see elm_list_item_append()
15405 * @see elm_list_items_get()
15409 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15412 * Sets the disabled/enabled state of a list item.
15414 * @param it The item.
15415 * @param disabled The disabled state.
15417 * A disabled item cannot be selected or unselected. It will also
15418 * change its appearance (generally greyed out). This sets the
15419 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15424 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15427 * Get a value whether list item is disabled or not.
15429 * @param it The item.
15430 * @return The disabled state.
15432 * @see elm_list_item_disabled_set() for more details.
15436 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15439 * Set the text to be shown in a given list item's tooltips.
15441 * @param item Target item.
15442 * @param text The text to set in the content.
15444 * Setup the text as tooltip to object. The item can have only one tooltip,
15445 * so any previous tooltip data - set with this function or
15446 * elm_list_item_tooltip_content_cb_set() - is removed.
15448 * @see elm_object_tooltip_text_set() for more details.
15452 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15456 * @brief Disable size restrictions on an object's tooltip
15457 * @param item The tooltip's anchor object
15458 * @param disable If EINA_TRUE, size restrictions are disabled
15459 * @return EINA_FALSE on failure, EINA_TRUE on success
15461 * This function allows a tooltip to expand beyond its parant window's canvas.
15462 * It will instead be limited only by the size of the display.
15464 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15466 * @brief Retrieve size restriction state of an object's tooltip
15467 * @param obj The tooltip's anchor object
15468 * @return If EINA_TRUE, size restrictions are disabled
15470 * This function returns whether a tooltip is allowed to expand beyond
15471 * its parant window's canvas.
15472 * It will instead be limited only by the size of the display.
15474 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15477 * Set the content to be shown in the tooltip item.
15479 * Setup the tooltip to item. The item can have only one tooltip,
15480 * so any previous tooltip data is removed. @p func(with @p data) will
15481 * be called every time that need show the tooltip and it should
15482 * return a valid Evas_Object. This object is then managed fully by
15483 * tooltip system and is deleted when the tooltip is gone.
15485 * @param item the list item being attached a tooltip.
15486 * @param func the function used to create the tooltip contents.
15487 * @param data what to provide to @a func as callback data/context.
15488 * @param del_cb called when data is not needed anymore, either when
15489 * another callback replaces @a func, the tooltip is unset with
15490 * elm_list_item_tooltip_unset() or the owner @a item
15491 * dies. This callback receives as the first parameter the
15492 * given @a data, and @c event_info is the item.
15494 * @see elm_object_tooltip_content_cb_set() for more details.
15498 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);
15501 * Unset tooltip from item.
15503 * @param item list item to remove previously set tooltip.
15505 * Remove tooltip from item. The callback provided as del_cb to
15506 * elm_list_item_tooltip_content_cb_set() will be called to notify
15507 * it is not used anymore.
15509 * @see elm_object_tooltip_unset() for more details.
15510 * @see elm_list_item_tooltip_content_cb_set()
15514 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15517 * Sets a different style for this item tooltip.
15519 * @note before you set a style you should define a tooltip with
15520 * elm_list_item_tooltip_content_cb_set() or
15521 * elm_list_item_tooltip_text_set()
15523 * @param item list item with tooltip already set.
15524 * @param style the theme style to use (default, transparent, ...)
15526 * @see elm_object_tooltip_style_set() for more details.
15530 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15533 * Get the style for this item tooltip.
15535 * @param item list item with tooltip already set.
15536 * @return style the theme style in use, defaults to "default". If the
15537 * object does not have a tooltip set, then NULL is returned.
15539 * @see elm_object_tooltip_style_get() for more details.
15540 * @see elm_list_item_tooltip_style_set()
15544 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15547 * Set the type of mouse pointer/cursor decoration to be shown,
15548 * when the mouse pointer is over the given list widget item
15550 * @param item list item to customize cursor on
15551 * @param cursor the cursor type's name
15553 * This function works analogously as elm_object_cursor_set(), but
15554 * here the cursor's changing area is restricted to the item's
15555 * area, and not the whole widget's. Note that that item cursors
15556 * have precedence over widget cursors, so that a mouse over an
15557 * item with custom cursor set will always show @b that cursor.
15559 * If this function is called twice for an object, a previously set
15560 * cursor will be unset on the second call.
15562 * @see elm_object_cursor_set()
15563 * @see elm_list_item_cursor_get()
15564 * @see elm_list_item_cursor_unset()
15568 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15571 * Get the type of mouse pointer/cursor decoration set to be shown,
15572 * when the mouse pointer is over the given list widget item
15574 * @param item list item with custom cursor set
15575 * @return the cursor type's name or @c NULL, if no custom cursors
15576 * were set to @p item (and on errors)
15578 * @see elm_object_cursor_get()
15579 * @see elm_list_item_cursor_set()
15580 * @see elm_list_item_cursor_unset()
15584 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15587 * Unset any custom mouse pointer/cursor decoration set to be
15588 * shown, when the mouse pointer is over the given list widget
15589 * item, thus making it show the @b default cursor again.
15591 * @param item a list item
15593 * Use this call to undo any custom settings on this item's cursor
15594 * decoration, bringing it back to defaults (no custom style set).
15596 * @see elm_object_cursor_unset()
15597 * @see elm_list_item_cursor_set()
15601 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15604 * Set a different @b style for a given custom cursor set for a
15607 * @param item list item with custom cursor set
15608 * @param style the <b>theme style</b> to use (e.g. @c "default",
15609 * @c "transparent", etc)
15611 * This function only makes sense when one is using custom mouse
15612 * cursor decorations <b>defined in a theme file</b>, which can have,
15613 * given a cursor name/type, <b>alternate styles</b> on it. It
15614 * works analogously as elm_object_cursor_style_set(), but here
15615 * applyed only to list item objects.
15617 * @warning Before you set a cursor style you should have definen a
15618 * custom cursor previously on the item, with
15619 * elm_list_item_cursor_set()
15621 * @see elm_list_item_cursor_engine_only_set()
15622 * @see elm_list_item_cursor_style_get()
15626 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15629 * Get the current @b style set for a given list item's custom
15632 * @param item list item with custom cursor set.
15633 * @return style the cursor style in use. If the object does not
15634 * have a cursor set, then @c NULL is returned.
15636 * @see elm_list_item_cursor_style_set() for more details
15640 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15643 * Set if the (custom)cursor for a given list item should be
15644 * searched in its theme, also, or should only rely on the
15645 * rendering engine.
15647 * @param item item with custom (custom) cursor already set on
15648 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15649 * only on those provided by the rendering engine, @c EINA_FALSE to
15650 * have them searched on the widget's theme, as well.
15652 * @note This call is of use only if you've set a custom cursor
15653 * for list items, with elm_list_item_cursor_set().
15655 * @note By default, cursors will only be looked for between those
15656 * provided by the rendering engine.
15660 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15663 * Get if the (custom) cursor for a given list item is being
15664 * searched in its theme, also, or is only relying on the rendering
15667 * @param item a list item
15668 * @return @c EINA_TRUE, if cursors are being looked for only on
15669 * those provided by the rendering engine, @c EINA_FALSE if they
15670 * are being searched on the widget's theme, as well.
15672 * @see elm_list_item_cursor_engine_only_set(), for more details
15676 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15683 * @defgroup Slider Slider
15684 * @ingroup Elementary
15686 * @image html img/widget/slider/preview-00.png
15687 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15689 * The slider adds a dragable “slider” widget for selecting the value of
15690 * something within a range.
15692 * A slider can be horizontal or vertical. It can contain an Icon and has a
15693 * primary label as well as a units label (that is formatted with floating
15694 * point values and thus accepts a printf-style format string, like
15695 * “%1.2f units”. There is also an indicator string that may be somewhere
15696 * else (like on the slider itself) that also accepts a format string like
15697 * units. Label, Icon Unit and Indicator strings/objects are optional.
15699 * A slider may be inverted which means values invert, with high vales being
15700 * on the left or top and low values on the right or bottom (as opposed to
15701 * normally being low on the left or top and high on the bottom and right).
15703 * The slider should have its minimum and maximum values set by the
15704 * application with elm_slider_min_max_set() and value should also be set by
15705 * the application before use with elm_slider_value_set(). The span of the
15706 * slider is its length (horizontally or vertically). This will be scaled by
15707 * the object or applications scaling factor. At any point code can query the
15708 * slider for its value with elm_slider_value_get().
15710 * Smart callbacks one can listen to:
15711 * - "changed" - Whenever the slider value is changed by the user.
15712 * - "slider,drag,start" - dragging the slider indicator around has started.
15713 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15714 * - "delay,changed" - A short time after the value is changed by the user.
15715 * This will be called only when the user stops dragging for
15716 * a very short period or when they release their
15717 * finger/mouse, so it avoids possibly expensive reactions to
15718 * the value change.
15720 * Available styles for it:
15723 * Here is an example on its usage:
15724 * @li @ref slider_example
15728 * @addtogroup Slider
15733 * Add a new slider widget to the given parent Elementary
15734 * (container) object.
15736 * @param parent The parent object.
15737 * @return a new slider widget handle or @c NULL, on errors.
15739 * This function inserts a new slider widget on the canvas.
15743 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15746 * Set the label of a given slider widget
15748 * @param obj The progress bar object
15749 * @param label The text label string, in UTF-8
15752 * @deprecated use elm_object_text_set() instead.
15754 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15757 * Get the label of a given slider widget
15759 * @param obj The progressbar object
15760 * @return The text label string, in UTF-8
15763 * @deprecated use elm_object_text_get() instead.
15765 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15768 * Set the icon object of the slider object.
15770 * @param obj The slider object.
15771 * @param icon The icon object.
15773 * On horizontal mode, icon is placed at left, and on vertical mode,
15776 * @note Once the icon object is set, a previously set one will be deleted.
15777 * If you want to keep that old content object, use the
15778 * elm_slider_icon_unset() function.
15780 * @warning If the object being set does not have minimum size hints set,
15781 * it won't get properly displayed.
15785 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15788 * Unset an icon set on a given slider widget.
15790 * @param obj The slider object.
15791 * @return The icon object that was being used, if any was set, or
15792 * @c NULL, otherwise (and on errors).
15794 * On horizontal mode, icon is placed at left, and on vertical mode,
15797 * This call will unparent and return the icon object which was set
15798 * for this widget, previously, on success.
15800 * @see elm_slider_icon_set() for more details
15801 * @see elm_slider_icon_get()
15805 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15808 * Retrieve the icon object set for a given slider widget.
15810 * @param obj The slider object.
15811 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15812 * otherwise (and on errors).
15814 * On horizontal mode, icon is placed at left, and on vertical mode,
15817 * @see elm_slider_icon_set() for more details
15818 * @see elm_slider_icon_unset()
15822 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15825 * Set the end object of the slider object.
15827 * @param obj The slider object.
15828 * @param end The end object.
15830 * On horizontal mode, end is placed at left, and on vertical mode,
15831 * placed at bottom.
15833 * @note Once the icon object is set, a previously set one will be deleted.
15834 * If you want to keep that old content object, use the
15835 * elm_slider_end_unset() function.
15837 * @warning If the object being set does not have minimum size hints set,
15838 * it won't get properly displayed.
15842 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15845 * Unset an end object set on a given slider widget.
15847 * @param obj The slider object.
15848 * @return The end object that was being used, if any was set, or
15849 * @c NULL, otherwise (and on errors).
15851 * On horizontal mode, end is placed at left, and on vertical mode,
15852 * placed at bottom.
15854 * This call will unparent and return the icon object which was set
15855 * for this widget, previously, on success.
15857 * @see elm_slider_end_set() for more details.
15858 * @see elm_slider_end_get()
15862 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15865 * Retrieve the end object set for a given slider widget.
15867 * @param obj The slider object.
15868 * @return The end object's handle, if @p obj had one set, or @c NULL,
15869 * otherwise (and on errors).
15871 * On horizontal mode, icon is placed at right, and on vertical mode,
15872 * placed at bottom.
15874 * @see elm_slider_end_set() for more details.
15875 * @see elm_slider_end_unset()
15879 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15882 * Set the (exact) length of the bar region of a given slider widget.
15884 * @param obj The slider object.
15885 * @param size The length of the slider's bar region.
15887 * This sets the minimum width (when in horizontal mode) or height
15888 * (when in vertical mode) of the actual bar area of the slider
15889 * @p obj. This in turn affects the object's minimum size. Use
15890 * this when you're not setting other size hints expanding on the
15891 * given direction (like weight and alignment hints) and you would
15892 * like it to have a specific size.
15894 * @note Icon, end, label, indicator and unit text around @p obj
15895 * will require their
15896 * own space, which will make @p obj to require more the @p size,
15899 * @see elm_slider_span_size_get()
15903 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15906 * Get the length set for the bar region of a given slider widget
15908 * @param obj The slider object.
15909 * @return The length of the slider's bar region.
15911 * If that size was not set previously, with
15912 * elm_slider_span_size_set(), this call will return @c 0.
15916 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15919 * Set the format string for the unit label.
15921 * @param obj The slider object.
15922 * @param format The format string for the unit display.
15924 * Unit label is displayed all the time, if set, after slider's bar.
15925 * In horizontal mode, at right and in vertical mode, at bottom.
15927 * If @c NULL, unit label won't be visible. If not it sets the format
15928 * string for the label text. To the label text is provided a floating point
15929 * value, so the label text can display up to 1 floating point value.
15930 * Note that this is optional.
15932 * Use a format string such as "%1.2f meters" for example, and it will
15933 * display values like: "3.14 meters" for a value equal to 3.14159.
15935 * Default is unit label disabled.
15937 * @see elm_slider_indicator_format_get()
15941 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15944 * Get the unit label format of the slider.
15946 * @param obj The slider object.
15947 * @return The unit label format string in UTF-8.
15949 * Unit label is displayed all the time, if set, after slider's bar.
15950 * In horizontal mode, at right and in vertical mode, at bottom.
15952 * @see elm_slider_unit_format_set() for more
15953 * information on how this works.
15957 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15960 * Set the format string for the indicator label.
15962 * @param obj The slider object.
15963 * @param indicator The format string for the indicator display.
15965 * The slider may display its value somewhere else then unit label,
15966 * for example, above the slider knob that is dragged around. This function
15967 * sets the format string used for this.
15969 * If @c NULL, indicator label won't be visible. If not it sets the format
15970 * string for the label text. To the label text is provided a floating point
15971 * value, so the label text can display up to 1 floating point value.
15972 * Note that this is optional.
15974 * Use a format string such as "%1.2f meters" for example, and it will
15975 * display values like: "3.14 meters" for a value equal to 3.14159.
15977 * Default is indicator label disabled.
15979 * @see elm_slider_indicator_format_get()
15983 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15986 * Get the indicator label format of the slider.
15988 * @param obj The slider object.
15989 * @return The indicator label format string in UTF-8.
15991 * The slider may display its value somewhere else then unit label,
15992 * for example, above the slider knob that is dragged around. This function
15993 * gets the format string used for this.
15995 * @see elm_slider_indicator_format_set() for more
15996 * information on how this works.
16000 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16003 * Set the format function pointer for the indicator label
16005 * @param obj The slider object.
16006 * @param func The indicator format function.
16007 * @param free_func The freeing function for the format string.
16009 * Set the callback function to format the indicator string.
16011 * @see elm_slider_indicator_format_set() for more info on how this works.
16015 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);
16018 * Set the format function pointer for the units label
16020 * @param obj The slider object.
16021 * @param func The units format function.
16022 * @param free_func The freeing function for the format string.
16024 * Set the callback function to format the indicator string.
16026 * @see elm_slider_units_format_set() for more info on how this works.
16030 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);
16033 * Set the orientation of a given slider widget.
16035 * @param obj The slider object.
16036 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16037 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16039 * Use this function to change how your slider is to be
16040 * disposed: vertically or horizontally.
16042 * By default it's displayed horizontally.
16044 * @see elm_slider_horizontal_get()
16048 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16051 * Retrieve the orientation of a given slider widget
16053 * @param obj The slider object.
16054 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16055 * @c EINA_FALSE if it's @b vertical (and on errors).
16057 * @see elm_slider_horizontal_set() for more details.
16061 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16064 * Set the minimum and maximum values for the slider.
16066 * @param obj The slider object.
16067 * @param min The minimum value.
16068 * @param max The maximum value.
16070 * Define the allowed range of values to be selected by the user.
16072 * If actual value is less than @p min, it will be updated to @p min. If it
16073 * is bigger then @p max, will be updated to @p max. Actual value can be
16074 * get with elm_slider_value_get().
16076 * By default, min is equal to 0.0, and max is equal to 1.0.
16078 * @warning Maximum must be greater than minimum, otherwise behavior
16081 * @see elm_slider_min_max_get()
16085 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16088 * Get the minimum and maximum values of the slider.
16090 * @param obj The slider object.
16091 * @param min Pointer where to store the minimum value.
16092 * @param max Pointer where to store the maximum value.
16094 * @note If only one value is needed, the other pointer can be passed
16097 * @see elm_slider_min_max_set() for details.
16101 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16104 * Set the value the slider displays.
16106 * @param obj The slider object.
16107 * @param val The value to be displayed.
16109 * Value will be presented on the unit label following format specified with
16110 * elm_slider_unit_format_set() and on indicator with
16111 * elm_slider_indicator_format_set().
16113 * @warning The value must to be between min and max values. This values
16114 * are set by elm_slider_min_max_set().
16116 * @see elm_slider_value_get()
16117 * @see elm_slider_unit_format_set()
16118 * @see elm_slider_indicator_format_set()
16119 * @see elm_slider_min_max_set()
16123 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16126 * Get the value displayed by the spinner.
16128 * @param obj The spinner object.
16129 * @return The value displayed.
16131 * @see elm_spinner_value_set() for details.
16135 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16138 * Invert a given slider widget's displaying values order
16140 * @param obj The slider object.
16141 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16142 * @c EINA_FALSE to bring it back to default, non-inverted values.
16144 * A slider may be @b inverted, in which state it gets its
16145 * values inverted, with high vales being on the left or top and
16146 * low values on the right or bottom, as opposed to normally have
16147 * the low values on the former and high values on the latter,
16148 * respectively, for horizontal and vertical modes.
16150 * @see elm_slider_inverted_get()
16154 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16157 * Get whether a given slider widget's displaying values are
16160 * @param obj The slider object.
16161 * @return @c EINA_TRUE, if @p obj has inverted values,
16162 * @c EINA_FALSE otherwise (and on errors).
16164 * @see elm_slider_inverted_set() for more details.
16168 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16171 * Set whether to enlarge slider indicator (augmented knob) or not.
16173 * @param obj The slider object.
16174 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16175 * let the knob always at default size.
16177 * By default, indicator will be bigger while dragged by the user.
16179 * @warning It won't display values set with
16180 * elm_slider_indicator_format_set() if you disable indicator.
16184 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16187 * Get whether a given slider widget's enlarging indicator or not.
16189 * @param obj The slider object.
16190 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16191 * @c EINA_FALSE otherwise (and on errors).
16193 * @see elm_slider_indicator_show_set() for details.
16197 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16204 * @addtogroup Actionslider Actionslider
16206 * @image html img/widget/actionslider/preview-00.png
16207 * @image latex img/widget/actionslider/preview-00.eps
16209 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16210 * properties. The indicator is the element the user drags to choose a label.
16211 * When the position is set with magnet, when released the indicator will be
16212 * moved to it if it's nearest the magnetized position.
16214 * @note By default all positions are set as enabled.
16216 * Signals that you can add callbacks for are:
16218 * "selected" - when user selects an enabled position (the label is passed
16221 * "pos_changed" - when the indicator reaches any of the positions("left",
16222 * "right" or "center").
16224 * See an example of actionslider usage @ref actionslider_example_page "here"
16227 typedef enum _Elm_Actionslider_Pos
16229 ELM_ACTIONSLIDER_NONE = 0,
16230 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16231 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16232 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16233 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16234 } Elm_Actionslider_Pos;
16237 * Add a new actionslider to the parent.
16239 * @param parent The parent object
16240 * @return The new actionslider object or NULL if it cannot be created
16242 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16244 * Set actionslider labels.
16246 * @param obj The actionslider object
16247 * @param left_label The label to be set on the left.
16248 * @param center_label The label to be set on the center.
16249 * @param right_label The label to be set on the right.
16250 * @deprecated use elm_object_text_set() instead.
16252 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);
16254 * Get actionslider labels.
16256 * @param obj The actionslider object
16257 * @param left_label A char** to place the left_label of @p obj into.
16258 * @param center_label A char** to place the center_label of @p obj into.
16259 * @param right_label A char** to place the right_label of @p obj into.
16260 * @deprecated use elm_object_text_set() instead.
16262 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);
16264 * Get actionslider selected label.
16266 * @param obj The actionslider object
16267 * @return The selected label
16269 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16271 * Set actionslider indicator position.
16273 * @param obj The actionslider object.
16274 * @param pos The position of the indicator.
16276 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16278 * Get actionslider indicator position.
16280 * @param obj The actionslider object.
16281 * @return The position of the indicator.
16283 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16285 * Set actionslider magnet position. To make multiple positions magnets @c or
16286 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16288 * @param obj The actionslider object.
16289 * @param pos Bit mask indicating the magnet positions.
16291 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16293 * Get actionslider magnet position.
16295 * @param obj The actionslider object.
16296 * @return The positions with magnet property.
16298 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16300 * Set actionslider enabled position. To set multiple positions as enabled @c or
16301 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16303 * @note All the positions are enabled by default.
16305 * @param obj The actionslider object.
16306 * @param pos Bit mask indicating the enabled positions.
16308 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16310 * Get actionslider enabled position.
16312 * @param obj The actionslider object.
16313 * @return The enabled positions.
16315 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16317 * Set the label used on the indicator.
16319 * @param obj The actionslider object
16320 * @param label The label to be set on the indicator.
16321 * @deprecated use elm_object_text_set() instead.
16323 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16325 * Get the label used on the indicator object.
16327 * @param obj The actionslider object
16328 * @return The indicator label
16329 * @deprecated use elm_object_text_get() instead.
16331 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16337 * @defgroup Genlist Genlist
16339 * @image html img/widget/genlist/preview-00.png
16340 * @image latex img/widget/genlist/preview-00.eps
16341 * @image html img/genlist.png
16342 * @image latex img/genlist.eps
16344 * This widget aims to have more expansive list than the simple list in
16345 * Elementary that could have more flexible items and allow many more entries
16346 * while still being fast and low on memory usage. At the same time it was
16347 * also made to be able to do tree structures. But the price to pay is more
16348 * complexity when it comes to usage. If all you want is a simple list with
16349 * icons and a single label, use the normal @ref List object.
16351 * Genlist has a fairly large API, mostly because it's relatively complex,
16352 * trying to be both expansive, powerful and efficient. First we will begin
16353 * an overview on the theory behind genlist.
16355 * @section Genlist_Item_Class Genlist item classes - creating items
16357 * In order to have the ability to add and delete items on the fly, genlist
16358 * implements a class (callback) system where the application provides a
16359 * structure with information about that type of item (genlist may contain
16360 * multiple different items with different classes, states and styles).
16361 * Genlist will call the functions in this struct (methods) when an item is
16362 * "realized" (i.e., created dynamically, while the user is scrolling the
16363 * grid). All objects will simply be deleted when no longer needed with
16364 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16365 * following members:
16366 * - @c item_style - This is a constant string and simply defines the name
16367 * of the item style. It @b must be specified and the default should be @c
16369 * - @c mode_item_style - This is a constant string and simply defines the
16370 * name of the style that will be used for mode animations. It can be left
16371 * as @c NULL if you don't plan to use Genlist mode. See
16372 * elm_genlist_item_mode_set() for more info.
16374 * - @c func - A struct with pointers to functions that will be called when
16375 * an item is going to be actually created. All of them receive a @c data
16376 * parameter that will point to the same data passed to
16377 * elm_genlist_item_append() and related item creation functions, and a @c
16378 * obj parameter that points to the genlist object itself.
16380 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16381 * state_get and @c del. The 3 first functions also receive a @c part
16382 * parameter described below. A brief description of these functions follows:
16384 * - @c label_get - The @c part parameter is the name string of one of the
16385 * existing text parts in the Edje group implementing the item's theme.
16386 * This function @b must return a strdup'()ed string, as the caller will
16387 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16388 * - @c icon_get - The @c part parameter is the name string of one of the
16389 * existing (icon) swallow parts in the Edje group implementing the item's
16390 * theme. It must return @c NULL, when no icon is desired, or a valid
16391 * object handle, otherwise. The object will be deleted by the genlist on
16392 * its deletion or when the item is "unrealized". See
16393 * #Elm_Genlist_Item_Icon_Get_Cb.
16394 * - @c func.state_get - The @c part parameter is the name string of one of
16395 * the state parts in the Edje group implementing the item's theme. Return
16396 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16397 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16398 * and @c "elm" as "emission" and "source" arguments, respectively, when
16399 * the state is true (the default is false), where @c XXX is the name of
16400 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16401 * - @c func.del - This is intended for use when genlist items are deleted,
16402 * so any data attached to the item (e.g. its data parameter on creation)
16403 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16405 * available item styles:
16407 * - default_style - The text part is a textblock
16409 * @image html img/widget/genlist/preview-04.png
16410 * @image latex img/widget/genlist/preview-04.eps
16414 * @image html img/widget/genlist/preview-01.png
16415 * @image latex img/widget/genlist/preview-01.eps
16417 * - icon_top_text_bottom
16419 * @image html img/widget/genlist/preview-02.png
16420 * @image latex img/widget/genlist/preview-02.eps
16424 * @image html img/widget/genlist/preview-03.png
16425 * @image latex img/widget/genlist/preview-03.eps
16427 * @section Genlist_Items Structure of items
16429 * An item in a genlist can have 0 or more text labels (they can be regular
16430 * text or textblock Evas objects - that's up to the style to determine), 0
16431 * or more icons (which are simply objects swallowed into the genlist item's
16432 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16433 * behavior left to the user to define. The Edje part names for each of
16434 * these properties will be looked up, in the theme file for the genlist,
16435 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16436 * "states", respectively. For each of those properties, if more than one
16437 * part is provided, they must have names listed separated by spaces in the
16438 * data fields. For the default genlist item theme, we have @b one label
16439 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16440 * "elm.swallow.end") and @b no state parts.
16442 * A genlist item may be at one of several styles. Elementary provides one
16443 * by default - "default", but this can be extended by system or application
16444 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16447 * @section Genlist_Manipulation Editing and Navigating
16449 * Items can be added by several calls. All of them return a @ref
16450 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16451 * They all take a data parameter that is meant to be used for a handle to
16452 * the applications internal data (eg the struct with the original item
16453 * data). The parent parameter is the parent genlist item this belongs to if
16454 * it is a tree or an indexed group, and NULL if there is no parent. The
16455 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16456 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16457 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16458 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16459 * is set then this item is group index item that is displayed at the top
16460 * until the next group comes. The func parameter is a convenience callback
16461 * that is called when the item is selected and the data parameter will be
16462 * the func_data parameter, obj be the genlist object and event_info will be
16463 * the genlist item.
16465 * elm_genlist_item_append() adds an item to the end of the list, or if
16466 * there is a parent, to the end of all the child items of the parent.
16467 * elm_genlist_item_prepend() is the same but adds to the beginning of
16468 * the list or children list. elm_genlist_item_insert_before() inserts at
16469 * item before another item and elm_genlist_item_insert_after() inserts after
16470 * the indicated item.
16472 * The application can clear the list with elm_genlist_clear() which deletes
16473 * all the items in the list and elm_genlist_item_del() will delete a specific
16474 * item. elm_genlist_item_subitems_clear() will clear all items that are
16475 * children of the indicated parent item.
16477 * To help inspect list items you can jump to the item at the top of the list
16478 * with elm_genlist_first_item_get() which will return the item pointer, and
16479 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16480 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16481 * and previous items respectively relative to the indicated item. Using
16482 * these calls you can walk the entire item list/tree. Note that as a tree
16483 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16484 * let you know which item is the parent (and thus know how to skip them if
16487 * @section Genlist_Muti_Selection Multi-selection
16489 * If the application wants multiple items to be able to be selected,
16490 * elm_genlist_multi_select_set() can enable this. If the list is
16491 * single-selection only (the default), then elm_genlist_selected_item_get()
16492 * will return the selected item, if any, or NULL I none is selected. If the
16493 * list is multi-select then elm_genlist_selected_items_get() will return a
16494 * list (that is only valid as long as no items are modified (added, deleted,
16495 * selected or unselected)).
16497 * @section Genlist_Usage_Hints Usage hints
16499 * There are also convenience functions. elm_genlist_item_genlist_get() will
16500 * return the genlist object the item belongs to. elm_genlist_item_show()
16501 * will make the scroller scroll to show that specific item so its visible.
16502 * elm_genlist_item_data_get() returns the data pointer set by the item
16503 * creation functions.
16505 * If an item changes (state of boolean changes, label or icons change),
16506 * then use elm_genlist_item_update() to have genlist update the item with
16507 * the new state. Genlist will re-realize the item thus call the functions
16508 * in the _Elm_Genlist_Item_Class for that item.
16510 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16511 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16512 * to expand/contract an item and get its expanded state, use
16513 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16514 * again to make an item disabled (unable to be selected and appear
16515 * differently) use elm_genlist_item_disabled_set() to set this and
16516 * elm_genlist_item_disabled_get() to get the disabled state.
16518 * In general to indicate how the genlist should expand items horizontally to
16519 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16520 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16521 * mode means that if items are too wide to fit, the scroller will scroll
16522 * horizontally. Otherwise items are expanded to fill the width of the
16523 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16524 * to the viewport width and limited to that size. This can be combined with
16525 * a different style that uses edjes' ellipsis feature (cutting text off like
16528 * Items will only call their selection func and callback when first becoming
16529 * selected. Any further clicks will do nothing, unless you enable always
16530 * select with elm_genlist_always_select_mode_set(). This means even if
16531 * selected, every click will make the selected callbacks be called.
16532 * elm_genlist_no_select_mode_set() will turn off the ability to select
16533 * items entirely and they will neither appear selected nor call selected
16534 * callback functions.
16536 * Remember that you can create new styles and add your own theme augmentation
16537 * per application with elm_theme_extension_add(). If you absolutely must
16538 * have a specific style that overrides any theme the user or system sets up
16539 * you can use elm_theme_overlay_add() to add such a file.
16541 * @section Genlist_Implementation Implementation
16543 * Evas tracks every object you create. Every time it processes an event
16544 * (mouse move, down, up etc.) it needs to walk through objects and find out
16545 * what event that affects. Even worse every time it renders display updates,
16546 * in order to just calculate what to re-draw, it needs to walk through many
16547 * many many objects. Thus, the more objects you keep active, the more
16548 * overhead Evas has in just doing its work. It is advisable to keep your
16549 * active objects to the minimum working set you need. Also remember that
16550 * object creation and deletion carries an overhead, so there is a
16551 * middle-ground, which is not easily determined. But don't keep massive lists
16552 * of objects you can't see or use. Genlist does this with list objects. It
16553 * creates and destroys them dynamically as you scroll around. It groups them
16554 * into blocks so it can determine the visibility etc. of a whole block at
16555 * once as opposed to having to walk the whole list. This 2-level list allows
16556 * for very large numbers of items to be in the list (tests have used up to
16557 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16558 * may be different sizes, every item added needs to be calculated as to its
16559 * size and thus this presents a lot of overhead on populating the list, this
16560 * genlist employs a queue. Any item added is queued and spooled off over
16561 * time, actually appearing some time later, so if your list has many members
16562 * you may find it takes a while for them to all appear, with your process
16563 * consuming a lot of CPU while it is busy spooling.
16565 * Genlist also implements a tree structure, but it does so with callbacks to
16566 * the application, with the application filling in tree structures when
16567 * requested (allowing for efficient building of a very deep tree that could
16568 * even be used for file-management). See the above smart signal callbacks for
16571 * @section Genlist_Smart_Events Genlist smart events
16573 * Signals that you can add callbacks for are:
16574 * - @c "activated" - The user has double-clicked or pressed
16575 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16576 * item that was activated.
16577 * - @c "clicked,double" - The user has double-clicked an item. The @c
16578 * event_info parameter is the item that was double-clicked.
16579 * - @c "selected" - This is called when a user has made an item selected.
16580 * The event_info parameter is the genlist item that was selected.
16581 * - @c "unselected" - This is called when a user has made an item
16582 * unselected. The event_info parameter is the genlist item that was
16584 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16585 * called and the item is now meant to be expanded. The event_info
16586 * parameter is the genlist item that was indicated to expand. It is the
16587 * job of this callback to then fill in the child items.
16588 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16589 * called and the item is now meant to be contracted. The event_info
16590 * parameter is the genlist item that was indicated to contract. It is the
16591 * job of this callback to then delete the child items.
16592 * - @c "expand,request" - This is called when a user has indicated they want
16593 * to expand a tree branch item. The callback should decide if the item can
16594 * expand (has any children) and then call elm_genlist_item_expanded_set()
16595 * appropriately to set the state. The event_info parameter is the genlist
16596 * item that was indicated to expand.
16597 * - @c "contract,request" - This is called when a user has indicated they
16598 * want to contract a tree branch item. The callback should decide if the
16599 * item can contract (has any children) and then call
16600 * elm_genlist_item_expanded_set() appropriately to set the state. The
16601 * event_info parameter is the genlist item that was indicated to contract.
16602 * - @c "realized" - This is called when the item in the list is created as a
16603 * real evas object. event_info parameter is the genlist item that was
16604 * created. The object may be deleted at any time, so it is up to the
16605 * caller to not use the object pointer from elm_genlist_item_object_get()
16606 * in a way where it may point to freed objects.
16607 * - @c "unrealized" - This is called just before an item is unrealized.
16608 * After this call icon objects provided will be deleted and the item
16609 * object itself delete or be put into a floating cache.
16610 * - @c "drag,start,up" - This is called when the item in the list has been
16611 * dragged (not scrolled) up.
16612 * - @c "drag,start,down" - This is called when the item in the list has been
16613 * dragged (not scrolled) down.
16614 * - @c "drag,start,left" - This is called when the item in the list has been
16615 * dragged (not scrolled) left.
16616 * - @c "drag,start,right" - This is called when the item in the list has
16617 * been dragged (not scrolled) right.
16618 * - @c "drag,stop" - This is called when the item in the list has stopped
16620 * - @c "drag" - This is called when the item in the list is being dragged.
16621 * - @c "longpressed" - This is called when the item is pressed for a certain
16622 * amount of time. By default it's 1 second.
16623 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16625 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16626 * until the bottom edge.
16627 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16628 * until the left edge.
16629 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16630 * until the right edge.
16631 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16633 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16635 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16637 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16639 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16640 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16641 * multi-touch pinched in.
16642 * - @c "swipe" - This is called when the genlist is swiped.
16644 * @section Genlist_Examples Examples
16646 * Here is a list of examples that use the genlist, trying to show some of
16647 * its capabilities:
16648 * - @ref genlist_example_01
16649 * - @ref genlist_example_02
16650 * - @ref genlist_example_03
16651 * - @ref genlist_example_04
16652 * - @ref genlist_example_05
16656 * @addtogroup Genlist
16661 * @enum _Elm_Genlist_Item_Flags
16662 * @typedef Elm_Genlist_Item_Flags
16664 * Defines if the item is of any special type (has subitems or it's the
16665 * index of a group), or is just a simple item.
16669 typedef enum _Elm_Genlist_Item_Flags
16671 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16672 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16673 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16674 } Elm_Genlist_Item_Flags;
16675 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16676 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16677 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16678 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16679 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. */
16680 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. */
16681 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16682 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16684 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16685 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16686 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16687 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16690 * @struct _Elm_Genlist_Item_Class
16692 * Genlist item class definition structs.
16694 * This struct contains the style and fetching functions that will define the
16695 * contents of each item.
16697 * @see @ref Genlist_Item_Class
16699 struct _Elm_Genlist_Item_Class
16701 const char *item_style; /**< style of this class. */
16704 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16705 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16706 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16707 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16708 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16710 const char *mode_item_style;
16714 * Add a new genlist widget to the given parent Elementary
16715 * (container) object
16717 * @param parent The parent object
16718 * @return a new genlist widget handle or @c NULL, on errors
16720 * This function inserts a new genlist widget on the canvas.
16722 * @see elm_genlist_item_append()
16723 * @see elm_genlist_item_del()
16724 * @see elm_genlist_clear()
16728 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16730 * Remove all items from a given genlist widget.
16732 * @param obj The genlist object
16734 * This removes (and deletes) all items in @p obj, leaving it empty.
16736 * @see elm_genlist_item_del(), to remove just one item.
16740 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16742 * Enable or disable multi-selection in the genlist
16744 * @param obj The genlist object
16745 * @param multi Multi-select enable/disable. Default is disabled.
16747 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16748 * the list. This allows more than 1 item to be selected. To retrieve the list
16749 * of selected items, use elm_genlist_selected_items_get().
16751 * @see elm_genlist_selected_items_get()
16752 * @see elm_genlist_multi_select_get()
16756 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16758 * Gets if multi-selection in genlist is enabled or disabled.
16760 * @param obj The genlist object
16761 * @return Multi-select enabled/disabled
16762 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16764 * @see elm_genlist_multi_select_set()
16768 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16770 * This sets the horizontal stretching mode.
16772 * @param obj The genlist object
16773 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16775 * This sets the mode used for sizing items horizontally. Valid modes
16776 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16777 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16778 * the scroller will scroll horizontally. Otherwise items are expanded
16779 * to fill the width of the viewport of the scroller. If it is
16780 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16781 * limited to that size.
16783 * @see elm_genlist_horizontal_get()
16787 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16788 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16790 * Gets the horizontal stretching mode.
16792 * @param obj The genlist object
16793 * @return The mode to use
16794 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16796 * @see elm_genlist_horizontal_set()
16800 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16801 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16803 * Set the always select mode.
16805 * @param obj The genlist object
16806 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16807 * EINA_FALSE = off). Default is @c EINA_FALSE.
16809 * Items will only call their selection func and callback when first
16810 * becoming selected. Any further clicks will do nothing, unless you
16811 * enable always select with elm_genlist_always_select_mode_set().
16812 * This means that, even if selected, every click will make the selected
16813 * callbacks be called.
16815 * @see elm_genlist_always_select_mode_get()
16819 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16821 * Get the always select mode.
16823 * @param obj The genlist object
16824 * @return The always select mode
16825 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16827 * @see elm_genlist_always_select_mode_set()
16831 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16833 * Enable/disable the no select mode.
16835 * @param obj The genlist object
16836 * @param no_select The no select mode
16837 * (EINA_TRUE = on, EINA_FALSE = off)
16839 * This will turn off the ability to select items entirely and they
16840 * will neither appear selected nor call selected callback functions.
16842 * @see elm_genlist_no_select_mode_get()
16846 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16848 * Gets whether the no select mode is enabled.
16850 * @param obj The genlist object
16851 * @return The no select mode
16852 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16854 * @see elm_genlist_no_select_mode_set()
16858 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16860 * Enable/disable compress mode.
16862 * @param obj The genlist object
16863 * @param compress The compress mode
16864 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16866 * This will enable the compress mode where items are "compressed"
16867 * horizontally to fit the genlist scrollable viewport width. This is
16868 * special for genlist. Do not rely on
16869 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16870 * work as genlist needs to handle it specially.
16872 * @see elm_genlist_compress_mode_get()
16876 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16878 * Get whether the compress mode is enabled.
16880 * @param obj The genlist object
16881 * @return The compress mode
16882 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16884 * @see elm_genlist_compress_mode_set()
16888 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16890 * Enable/disable height-for-width mode.
16892 * @param obj The genlist object
16893 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16894 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16896 * With height-for-width mode the item width will be fixed (restricted
16897 * to a minimum of) to the list width when calculating its size in
16898 * order to allow the height to be calculated based on it. This allows,
16899 * for instance, text block to wrap lines if the Edje part is
16900 * configured with "text.min: 0 1".
16902 * @note This mode will make list resize slower as it will have to
16903 * recalculate every item height again whenever the list width
16906 * @note When height-for-width mode is enabled, it also enables
16907 * compress mode (see elm_genlist_compress_mode_set()) and
16908 * disables homogeneous (see elm_genlist_homogeneous_set()).
16912 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16914 * Get whether the height-for-width mode is enabled.
16916 * @param obj The genlist object
16917 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16922 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16924 * Enable/disable horizontal and vertical bouncing effect.
16926 * @param obj The genlist object
16927 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16928 * EINA_FALSE = off). Default is @c EINA_FALSE.
16929 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16930 * EINA_FALSE = off). Default is @c EINA_TRUE.
16932 * This will enable or disable the scroller bouncing effect for the
16933 * genlist. See elm_scroller_bounce_set() for details.
16935 * @see elm_scroller_bounce_set()
16936 * @see elm_genlist_bounce_get()
16940 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16942 * Get whether the horizontal and vertical bouncing effect is enabled.
16944 * @param obj The genlist object
16945 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16947 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16950 * @see elm_genlist_bounce_set()
16954 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16956 * Enable/disable homogenous mode.
16958 * @param obj The genlist object
16959 * @param homogeneous Assume the items within the genlist are of the
16960 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16963 * This will enable the homogeneous mode where items are of the same
16964 * height and width so that genlist may do the lazy-loading at its
16965 * maximum (which increases the performance for scrolling the list). This
16966 * implies 'compressed' mode.
16968 * @see elm_genlist_compress_mode_set()
16969 * @see elm_genlist_homogeneous_get()
16973 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16975 * Get whether the homogenous mode is enabled.
16977 * @param obj The genlist object
16978 * @return Assume the items within the genlist are of the same height
16979 * and width (EINA_TRUE = on, EINA_FALSE = off)
16981 * @see elm_genlist_homogeneous_set()
16985 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16987 * Set the maximum number of items within an item block
16989 * @param obj The genlist object
16990 * @param n Maximum number of items within an item block. Default is 32.
16992 * This will configure the block count to tune to the target with
16993 * particular performance matrix.
16995 * A block of objects will be used to reduce the number of operations due to
16996 * many objects in the screen. It can determine the visibility, or if the
16997 * object has changed, it theme needs to be updated, etc. doing this kind of
16998 * calculation to the entire block, instead of per object.
17000 * The default value for the block count is enough for most lists, so unless
17001 * you know you will have a lot of objects visible in the screen at the same
17002 * time, don't try to change this.
17004 * @see elm_genlist_block_count_get()
17005 * @see @ref Genlist_Implementation
17009 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17011 * Get the maximum number of items within an item block
17013 * @param obj The genlist object
17014 * @return Maximum number of items within an item block
17016 * @see elm_genlist_block_count_set()
17020 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17022 * Set the timeout in seconds for the longpress event.
17024 * @param obj The genlist object
17025 * @param timeout timeout in seconds. Default is 1.
17027 * This option will change how long it takes to send an event "longpressed"
17028 * after the mouse down signal is sent to the list. If this event occurs, no
17029 * "clicked" event will be sent.
17031 * @see elm_genlist_longpress_timeout_set()
17035 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17037 * Get the timeout in seconds for the longpress event.
17039 * @param obj The genlist object
17040 * @return timeout in seconds
17042 * @see elm_genlist_longpress_timeout_get()
17046 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17048 * Append a new item in a given genlist widget.
17050 * @param obj The genlist object
17051 * @param itc The item class for the item
17052 * @param data The item data
17053 * @param parent The parent item, or NULL if none
17054 * @param flags Item flags
17055 * @param func Convenience function called when the item is selected
17056 * @param func_data Data passed to @p func above.
17057 * @return A handle to the item added or @c NULL if not possible
17059 * This adds the given item to the end of the list or the end of
17060 * the children list if the @p parent is given.
17062 * @see elm_genlist_item_prepend()
17063 * @see elm_genlist_item_insert_before()
17064 * @see elm_genlist_item_insert_after()
17065 * @see elm_genlist_item_del()
17069 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);
17071 * Prepend a new item in a given genlist widget.
17073 * @param obj The genlist object
17074 * @param itc The item class for the item
17075 * @param data The item data
17076 * @param parent The parent item, or NULL if none
17077 * @param flags Item flags
17078 * @param func Convenience function called when the item is selected
17079 * @param func_data Data passed to @p func above.
17080 * @return A handle to the item added or NULL if not possible
17082 * This adds an item to the beginning of the list or beginning of the
17083 * children of the parent if given.
17085 * @see elm_genlist_item_append()
17086 * @see elm_genlist_item_insert_before()
17087 * @see elm_genlist_item_insert_after()
17088 * @see elm_genlist_item_del()
17092 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);
17094 * Insert an item before another in a genlist widget
17096 * @param obj The genlist object
17097 * @param itc The item class for the item
17098 * @param data The item data
17099 * @param before The item to place this new one before.
17100 * @param flags Item flags
17101 * @param func Convenience function called when the item is selected
17102 * @param func_data Data passed to @p func above.
17103 * @return A handle to the item added or @c NULL if not possible
17105 * This inserts an item before another in the list. It will be in the
17106 * same tree level or group as the item it is inserted before.
17108 * @see elm_genlist_item_append()
17109 * @see elm_genlist_item_prepend()
17110 * @see elm_genlist_item_insert_after()
17111 * @see elm_genlist_item_del()
17115 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);
17117 * Insert an item after another in a genlist widget
17119 * @param obj The genlist object
17120 * @param itc The item class for the item
17121 * @param data The item data
17122 * @param after The item to place this new one after.
17123 * @param flags Item flags
17124 * @param func Convenience function called when the item is selected
17125 * @param func_data Data passed to @p func above.
17126 * @return A handle to the item added or @c NULL if not possible
17128 * This inserts an item after another in the list. It will be in the
17129 * same tree level or group as the item it is inserted after.
17131 * @see elm_genlist_item_append()
17132 * @see elm_genlist_item_prepend()
17133 * @see elm_genlist_item_insert_before()
17134 * @see elm_genlist_item_del()
17138 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);
17140 * Insert a new item into the sorted genlist object
17142 * @param obj The genlist object
17143 * @param itc The item class for the item
17144 * @param data The item data
17145 * @param parent The parent item, or NULL if none
17146 * @param flags Item flags
17147 * @param comp The function called for the sort
17148 * @param func Convenience function called when item selected
17149 * @param func_data Data passed to @p func above.
17150 * @return A handle to the item added or NULL if not possible
17154 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);
17155 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);
17156 /* operations to retrieve existing items */
17158 * Get the selectd item in the genlist.
17160 * @param obj The genlist object
17161 * @return The selected item, or NULL if none is selected.
17163 * This gets the selected item in the list (if multi-selection is enabled, only
17164 * the item that was first selected in the list is returned - which is not very
17165 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17168 * If no item is selected, NULL is returned.
17170 * @see elm_genlist_selected_items_get()
17174 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17176 * Get a list of selected items in the genlist.
17178 * @param obj The genlist object
17179 * @return The list of selected items, or NULL if none are selected.
17181 * It returns a list of the selected items. This list pointer is only valid so
17182 * long as the selection doesn't change (no items are selected or unselected, or
17183 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17184 * pointers. The order of the items in this list is the order which they were
17185 * selected, i.e. the first item in this list is the first item that was
17186 * selected, and so on.
17188 * @note If not in multi-select mode, consider using function
17189 * elm_genlist_selected_item_get() instead.
17191 * @see elm_genlist_multi_select_set()
17192 * @see elm_genlist_selected_item_get()
17196 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17198 * Get a list of realized items in genlist
17200 * @param obj The genlist object
17201 * @return The list of realized items, nor NULL if none are realized.
17203 * This returns a list of the realized items in the genlist. The list
17204 * contains Elm_Genlist_Item pointers. The list must be freed by the
17205 * caller when done with eina_list_free(). The item pointers in the
17206 * list are only valid so long as those items are not deleted or the
17207 * genlist is not deleted.
17209 * @see elm_genlist_realized_items_update()
17213 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17215 * Get the item that is at the x, y canvas coords.
17217 * @param obj The gelinst object.
17218 * @param x The input x coordinate
17219 * @param y The input y coordinate
17220 * @param posret The position relative to the item returned here
17221 * @return The item at the coordinates or NULL if none
17223 * This returns the item at the given coordinates (which are canvas
17224 * relative, not object-relative). If an item is at that coordinate,
17225 * that item handle is returned, and if @p posret is not NULL, the
17226 * integer pointed to is set to a value of -1, 0 or 1, depending if
17227 * the coordinate is on the upper portion of that item (-1), on the
17228 * middle section (0) or on the lower part (1). If NULL is returned as
17229 * an item (no item found there), then posret may indicate -1 or 1
17230 * based if the coordinate is above or below all items respectively in
17235 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);
17237 * Get the first item in the genlist
17239 * This returns the first item in the list.
17241 * @param obj The genlist object
17242 * @return The first item, or NULL if none
17246 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17248 * Get the last item in the genlist
17250 * This returns the last item in the list.
17252 * @return The last item, or NULL if none
17256 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17258 * Set the scrollbar policy
17260 * @param obj The genlist object
17261 * @param policy_h Horizontal scrollbar policy.
17262 * @param policy_v Vertical scrollbar policy.
17264 * This sets the scrollbar visibility policy for the given genlist
17265 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17266 * made visible if it is needed, and otherwise kept hidden.
17267 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17268 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17269 * respectively for the horizontal and vertical scrollbars. Default is
17270 * #ELM_SMART_SCROLLER_POLICY_AUTO
17272 * @see elm_genlist_scroller_policy_get()
17276 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17278 * Get the scrollbar policy
17280 * @param obj The genlist object
17281 * @param policy_h Pointer to store the horizontal scrollbar policy.
17282 * @param policy_v Pointer to store the vertical scrollbar policy.
17284 * @see elm_genlist_scroller_policy_set()
17288 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);
17290 * Get the @b next item in a genlist widget's internal list of items,
17291 * given a handle to one of those items.
17293 * @param item The genlist item to fetch next from
17294 * @return The item after @p item, or @c NULL if there's none (and
17297 * This returns the item placed after the @p item, on the container
17300 * @see elm_genlist_item_prev_get()
17304 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17306 * Get the @b previous item in a genlist widget's internal list of items,
17307 * given a handle to one of those items.
17309 * @param item The genlist item to fetch previous from
17310 * @return The item before @p item, or @c NULL if there's none (and
17313 * This returns the item placed before the @p item, on the container
17316 * @see elm_genlist_item_next_get()
17320 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17322 * Get the genlist object's handle which contains a given genlist
17325 * @param item The item to fetch the container from
17326 * @return The genlist (parent) object
17328 * This returns the genlist object itself that an item belongs to.
17332 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17334 * Get the parent item of the given item
17336 * @param it The item
17337 * @return The parent of the item or @c NULL if it has no parent.
17339 * This returns the item that was specified as parent of the item @p it on
17340 * elm_genlist_item_append() and insertion related functions.
17344 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17346 * Remove all sub-items (children) of the given item
17348 * @param it The item
17350 * This removes all items that are children (and their descendants) of the
17351 * given item @p it.
17353 * @see elm_genlist_clear()
17354 * @see elm_genlist_item_del()
17358 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17360 * Set whether a given genlist item is selected or not
17362 * @param it The item
17363 * @param selected Use @c EINA_TRUE, to make it selected, @c
17364 * EINA_FALSE to make it unselected
17366 * This sets the selected state of an item. If multi selection is
17367 * not enabled on the containing genlist and @p selected is @c
17368 * EINA_TRUE, any other previously selected items will get
17369 * unselected in favor of this new one.
17371 * @see elm_genlist_item_selected_get()
17375 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17377 * Get whether a given genlist item is selected or not
17379 * @param it The item
17380 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17382 * @see elm_genlist_item_selected_set() for more details
17386 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17388 * Sets the expanded state of an item.
17390 * @param it The item
17391 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17393 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17396 * The theme will respond to this change visually, and a signal "expanded" or
17397 * "contracted" will be sent from the genlist with a pointer to the item that
17398 * has been expanded/contracted.
17400 * Calling this function won't show or hide any child of this item (if it is
17401 * a parent). You must manually delete and create them on the callbacks fo
17402 * the "expanded" or "contracted" signals.
17404 * @see elm_genlist_item_expanded_get()
17408 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17410 * Get the expanded state of an item
17412 * @param it The item
17413 * @return The expanded state
17415 * This gets the expanded state of an item.
17417 * @see elm_genlist_item_expanded_set()
17421 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17423 * Get the depth of expanded item
17425 * @param it The genlist item object
17426 * @return The depth of expanded item
17430 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17432 * Set whether a given genlist item is disabled or not.
17434 * @param it The item
17435 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17436 * to enable it back.
17438 * A disabled item cannot be selected or unselected. It will also
17439 * change its appearance, to signal the user it's disabled.
17441 * @see elm_genlist_item_disabled_get()
17445 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17447 * Get whether a given genlist item is disabled or not.
17449 * @param it The item
17450 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17453 * @see elm_genlist_item_disabled_set() for more details
17457 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17459 * Sets the display only state of an item.
17461 * @param it The item
17462 * @param display_only @c EINA_TRUE if the item is display only, @c
17463 * EINA_FALSE otherwise.
17465 * A display only item cannot be selected or unselected. It is for
17466 * display only and not selecting or otherwise clicking, dragging
17467 * etc. by the user, thus finger size rules will not be applied to
17470 * It's good to set group index items to display only state.
17472 * @see elm_genlist_item_display_only_get()
17476 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17478 * Get the display only state of an item
17480 * @param it The item
17481 * @return @c EINA_TRUE if the item is display only, @c
17482 * EINA_FALSE otherwise.
17484 * @see elm_genlist_item_display_only_set()
17488 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17490 * Show the portion of a genlist's internal list containing a given
17491 * item, immediately.
17493 * @param it The item to display
17495 * This causes genlist to jump to the given item @p it and show it (by
17496 * immediately scrolling to that position), if it is not fully visible.
17498 * @see elm_genlist_item_bring_in()
17499 * @see elm_genlist_item_top_show()
17500 * @see elm_genlist_item_middle_show()
17504 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17506 * Animatedly bring in, to the visible are of a genlist, a given
17509 * @param it The item to display
17511 * This causes genlist to jump to the given item @p it and show it (by
17512 * animatedly scrolling), if it is not fully visible. This may use animation
17513 * to do so and take a period of time
17515 * @see elm_genlist_item_show()
17516 * @see elm_genlist_item_top_bring_in()
17517 * @see elm_genlist_item_middle_bring_in()
17521 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17523 * Show the portion of a genlist's internal list containing a given
17524 * item, immediately.
17526 * @param it The item to display
17528 * This causes genlist to jump to the given item @p it and show it (by
17529 * immediately scrolling to that position), if it is not fully visible.
17531 * The item will be positioned at the top of the genlist viewport.
17533 * @see elm_genlist_item_show()
17534 * @see elm_genlist_item_top_bring_in()
17538 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17540 * Animatedly bring in, to the visible are of a genlist, a given
17543 * @param it The item
17545 * This causes genlist to jump to the given item @p it and show it (by
17546 * animatedly scrolling), if it is not fully visible. This may use animation
17547 * to do so and take a period of time
17549 * The item will be positioned at the top of the genlist viewport.
17551 * @see elm_genlist_item_bring_in()
17552 * @see elm_genlist_item_top_show()
17556 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17558 * Show the portion of a genlist's internal list containing a given
17559 * item, immediately.
17561 * @param it The item to display
17563 * This causes genlist to jump to the given item @p it and show it (by
17564 * immediately scrolling to that position), if it is not fully visible.
17566 * The item will be positioned at the middle of the genlist viewport.
17568 * @see elm_genlist_item_show()
17569 * @see elm_genlist_item_middle_bring_in()
17573 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17575 * Animatedly bring in, to the visible are of a genlist, a given
17578 * @param it The item
17580 * This causes genlist to jump to the given item @p it and show it (by
17581 * animatedly scrolling), if it is not fully visible. This may use animation
17582 * to do so and take a period of time
17584 * The item will be positioned at the middle of the genlist viewport.
17586 * @see elm_genlist_item_bring_in()
17587 * @see elm_genlist_item_middle_show()
17591 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17593 * Remove a genlist item from the its parent, deleting it.
17595 * @param item The item to be removed.
17596 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17598 * @see elm_genlist_clear(), to remove all items in a genlist at
17603 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17605 * Return the data associated to a given genlist item
17607 * @param item The genlist item.
17608 * @return the data associated to this item.
17610 * This returns the @c data value passed on the
17611 * elm_genlist_item_append() and related item addition calls.
17613 * @see elm_genlist_item_append()
17614 * @see elm_genlist_item_data_set()
17618 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17620 * Set the data associated to a given genlist item
17622 * @param item The genlist item
17623 * @param data The new data pointer to set on it
17625 * This @b overrides the @c data value passed on the
17626 * elm_genlist_item_append() and related item addition calls. This
17627 * function @b won't call elm_genlist_item_update() automatically,
17628 * so you'd issue it afterwards if you want to hove the item
17629 * updated to reflect the that new data.
17631 * @see elm_genlist_item_data_get()
17635 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17637 * Tells genlist to "orphan" icons fetchs by the item class
17639 * @param it The item
17641 * This instructs genlist to release references to icons in the item,
17642 * meaning that they will no longer be managed by genlist and are
17643 * floating "orphans" that can be re-used elsewhere if the user wants
17648 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17650 * Get the real Evas object created to implement the view of a
17651 * given genlist item
17653 * @param item The genlist item.
17654 * @return the Evas object implementing this item's view.
17656 * This returns the actual Evas object used to implement the
17657 * specified genlist item's view. This may be @c NULL, as it may
17658 * not have been created or may have been deleted, at any time, by
17659 * the genlist. <b>Do not modify this object</b> (move, resize,
17660 * show, hide, etc.), as the genlist is controlling it. This
17661 * function is for querying, emitting custom signals or hooking
17662 * lower level callbacks for events on that object. Do not delete
17663 * this object under any circumstances.
17665 * @see elm_genlist_item_data_get()
17669 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17671 * Update the contents of an item
17673 * @param it The item
17675 * This updates an item by calling all the item class functions again
17676 * to get the icons, labels and states. Use this when the original
17677 * item data has changed and the changes are desired to be reflected.
17679 * Use elm_genlist_realized_items_update() to update all already realized
17682 * @see elm_genlist_realized_items_update()
17686 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17688 * Update the item class of an item
17690 * @param it The item
17691 * @param itc The item class for the item
17693 * This sets another class fo the item, changing the way that it is
17694 * displayed. After changing the item class, elm_genlist_item_update() is
17695 * called on the item @p it.
17699 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17700 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17702 * Set the text to be shown in a given genlist item's tooltips.
17704 * @param item The genlist item
17705 * @param text The text to set in the content
17707 * This call will setup the text to be used as tooltip to that item
17708 * (analogous to elm_object_tooltip_text_set(), but being item
17709 * tooltips with higher precedence than object tooltips). It can
17710 * have only one tooltip at a time, so any previous tooltip data
17711 * will get removed.
17713 * In order to set an icon or something else as a tooltip, look at
17714 * elm_genlist_item_tooltip_content_cb_set().
17718 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17720 * Set the content to be shown in a given genlist item's tooltips
17722 * @param item The genlist item.
17723 * @param func The function returning the tooltip contents.
17724 * @param data What to provide to @a func as callback data/context.
17725 * @param del_cb Called when data is not needed anymore, either when
17726 * another callback replaces @p func, the tooltip is unset with
17727 * elm_genlist_item_tooltip_unset() or the owner @p item
17728 * dies. This callback receives as its first parameter the
17729 * given @p data, being @c event_info the item handle.
17731 * This call will setup the tooltip's contents to @p item
17732 * (analogous to elm_object_tooltip_content_cb_set(), but being
17733 * item tooltips with higher precedence than object tooltips). It
17734 * can have only one tooltip at a time, so any previous tooltip
17735 * content will get removed. @p func (with @p data) will be called
17736 * every time Elementary needs to show the tooltip and it should
17737 * return a valid Evas object, which will be fully managed by the
17738 * tooltip system, getting deleted when the tooltip is gone.
17740 * In order to set just a text as a tooltip, look at
17741 * elm_genlist_item_tooltip_text_set().
17745 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);
17747 * Unset a tooltip from a given genlist item
17749 * @param item genlist item to remove a previously set tooltip from.
17751 * This call removes any tooltip set on @p item. The callback
17752 * provided as @c del_cb to
17753 * elm_genlist_item_tooltip_content_cb_set() will be called to
17754 * notify it is not used anymore (and have resources cleaned, if
17757 * @see elm_genlist_item_tooltip_content_cb_set()
17761 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17763 * Set a different @b style for a given genlist item's tooltip.
17765 * @param item genlist item with tooltip set
17766 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17767 * "default", @c "transparent", etc)
17769 * Tooltips can have <b>alternate styles</b> to be displayed on,
17770 * which are defined by the theme set on Elementary. This function
17771 * works analogously as elm_object_tooltip_style_set(), but here
17772 * applied only to genlist item objects. The default style for
17773 * tooltips is @c "default".
17775 * @note before you set a style you should define a tooltip with
17776 * elm_genlist_item_tooltip_content_cb_set() or
17777 * elm_genlist_item_tooltip_text_set()
17779 * @see elm_genlist_item_tooltip_style_get()
17783 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17785 * Get the style set a given genlist item's tooltip.
17787 * @param item genlist item with tooltip already set on.
17788 * @return style the theme style in use, which defaults to
17789 * "default". If the object does not have a tooltip set,
17790 * then @c NULL is returned.
17792 * @see elm_genlist_item_tooltip_style_set() for more details
17796 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17798 * @brief Disable size restrictions on an object's tooltip
17799 * @param item The tooltip's anchor object
17800 * @param disable If EINA_TRUE, size restrictions are disabled
17801 * @return EINA_FALSE on failure, EINA_TRUE on success
17803 * This function allows a tooltip to expand beyond its parant window's canvas.
17804 * It will instead be limited only by the size of the display.
17806 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17808 * @brief Retrieve size restriction state of an object's tooltip
17809 * @param item The tooltip's anchor object
17810 * @return If EINA_TRUE, size restrictions are disabled
17812 * This function returns whether a tooltip is allowed to expand beyond
17813 * its parant window's canvas.
17814 * It will instead be limited only by the size of the display.
17816 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17818 * Set the type of mouse pointer/cursor decoration to be shown,
17819 * when the mouse pointer is over the given genlist widget item
17821 * @param item genlist item to customize cursor on
17822 * @param cursor the cursor type's name
17824 * This function works analogously as elm_object_cursor_set(), but
17825 * here the cursor's changing area is restricted to the item's
17826 * area, and not the whole widget's. Note that that item cursors
17827 * have precedence over widget cursors, so that a mouse over @p
17828 * item will always show cursor @p type.
17830 * If this function is called twice for an object, a previously set
17831 * cursor will be unset on the second call.
17833 * @see elm_object_cursor_set()
17834 * @see elm_genlist_item_cursor_get()
17835 * @see elm_genlist_item_cursor_unset()
17839 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17841 * Get the type of mouse pointer/cursor decoration set to be shown,
17842 * when the mouse pointer is over the given genlist widget item
17844 * @param item genlist item with custom cursor set
17845 * @return the cursor type's name or @c NULL, if no custom cursors
17846 * were set to @p item (and on errors)
17848 * @see elm_object_cursor_get()
17849 * @see elm_genlist_item_cursor_set() for more details
17850 * @see elm_genlist_item_cursor_unset()
17854 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17856 * Unset any custom mouse pointer/cursor decoration set to be
17857 * shown, when the mouse pointer is over the given genlist widget
17858 * item, thus making it show the @b default cursor again.
17860 * @param item a genlist item
17862 * Use this call to undo any custom settings on this item's cursor
17863 * decoration, bringing it back to defaults (no custom style set).
17865 * @see elm_object_cursor_unset()
17866 * @see elm_genlist_item_cursor_set() for more details
17870 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17872 * Set a different @b style for a given custom cursor set for a
17875 * @param item genlist item with custom cursor set
17876 * @param style the <b>theme style</b> to use (e.g. @c "default",
17877 * @c "transparent", etc)
17879 * This function only makes sense when one is using custom mouse
17880 * cursor decorations <b>defined in a theme file</b> , which can
17881 * have, given a cursor name/type, <b>alternate styles</b> on
17882 * it. It works analogously as elm_object_cursor_style_set(), but
17883 * here applied only to genlist item objects.
17885 * @warning Before you set a cursor style you should have defined a
17886 * custom cursor previously on the item, with
17887 * elm_genlist_item_cursor_set()
17889 * @see elm_genlist_item_cursor_engine_only_set()
17890 * @see elm_genlist_item_cursor_style_get()
17894 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17896 * Get the current @b style set for a given genlist item's custom
17899 * @param item genlist item with custom cursor set.
17900 * @return style the cursor style in use. If the object does not
17901 * have a cursor set, then @c NULL is returned.
17903 * @see elm_genlist_item_cursor_style_set() for more details
17907 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17909 * Set if the (custom) cursor for a given genlist item should be
17910 * searched in its theme, also, or should only rely on the
17911 * rendering engine.
17913 * @param item item with custom (custom) cursor already set on
17914 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17915 * only on those provided by the rendering engine, @c EINA_FALSE to
17916 * have them searched on the widget's theme, as well.
17918 * @note This call is of use only if you've set a custom cursor
17919 * for genlist items, with elm_genlist_item_cursor_set().
17921 * @note By default, cursors will only be looked for between those
17922 * provided by the rendering engine.
17926 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17928 * Get if the (custom) cursor for a given genlist item is being
17929 * searched in its theme, also, or is only relying on the rendering
17932 * @param item a genlist item
17933 * @return @c EINA_TRUE, if cursors are being looked for only on
17934 * those provided by the rendering engine, @c EINA_FALSE if they
17935 * are being searched on the widget's theme, as well.
17937 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17941 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17943 * Update the contents of all realized items.
17945 * @param obj The genlist object.
17947 * This updates all realized items by calling all the item class functions again
17948 * to get the icons, labels and states. Use this when the original
17949 * item data has changed and the changes are desired to be reflected.
17951 * To update just one item, use elm_genlist_item_update().
17953 * @see elm_genlist_realized_items_get()
17954 * @see elm_genlist_item_update()
17958 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17960 * Activate a genlist mode on an item
17962 * @param item The genlist item
17963 * @param mode Mode name
17964 * @param mode_set Boolean to define set or unset mode.
17966 * A genlist mode is a different way of selecting an item. Once a mode is
17967 * activated on an item, any other selected item is immediately unselected.
17968 * This feature provides an easy way of implementing a new kind of animation
17969 * for selecting an item, without having to entirely rewrite the item style
17970 * theme. However, the elm_genlist_selected_* API can't be used to get what
17971 * item is activate for a mode.
17973 * The current item style will still be used, but applying a genlist mode to
17974 * an item will select it using a different kind of animation.
17976 * The current active item for a mode can be found by
17977 * elm_genlist_mode_item_get().
17979 * The characteristics of genlist mode are:
17980 * - Only one mode can be active at any time, and for only one item.
17981 * - Genlist handles deactivating other items when one item is activated.
17982 * - A mode is defined in the genlist theme (edc), and more modes can easily
17984 * - A mode style and the genlist item style are different things. They
17985 * can be combined to provide a default style to the item, with some kind
17986 * of animation for that item when the mode is activated.
17988 * When a mode is activated on an item, a new view for that item is created.
17989 * The theme of this mode defines the animation that will be used to transit
17990 * the item from the old view to the new view. This second (new) view will be
17991 * active for that item while the mode is active on the item, and will be
17992 * destroyed after the mode is totally deactivated from that item.
17994 * @see elm_genlist_mode_get()
17995 * @see elm_genlist_mode_item_get()
17999 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18001 * Get the last (or current) genlist mode used.
18003 * @param obj The genlist object
18005 * This function just returns the name of the last used genlist mode. It will
18006 * be the current mode if it's still active.
18008 * @see elm_genlist_item_mode_set()
18009 * @see elm_genlist_mode_item_get()
18013 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18015 * Get active genlist mode item
18017 * @param obj The genlist object
18018 * @return The active item for that current mode. Or @c NULL if no item is
18019 * activated with any mode.
18021 * This function returns the item that was activated with a mode, by the
18022 * function elm_genlist_item_mode_set().
18024 * @see elm_genlist_item_mode_set()
18025 * @see elm_genlist_mode_get()
18029 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18034 * @param obj The genlist object
18035 * @param reorder_mode The reorder mode
18036 * (EINA_TRUE = on, EINA_FALSE = off)
18040 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18043 * Get the reorder mode
18045 * @param obj The genlist object
18046 * @return The reorder mode
18047 * (EINA_TRUE = on, EINA_FALSE = off)
18051 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18058 * @defgroup Check Check
18060 * @image html img/widget/check/preview-00.png
18061 * @image latex img/widget/check/preview-00.eps
18062 * @image html img/widget/check/preview-01.png
18063 * @image latex img/widget/check/preview-01.eps
18064 * @image html img/widget/check/preview-02.png
18065 * @image latex img/widget/check/preview-02.eps
18067 * @brief The check widget allows for toggling a value between true and
18070 * Check objects are a lot like radio objects in layout and functionality
18071 * except they do not work as a group, but independently and only toggle the
18072 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18073 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18074 * returns the current state. For convenience, like the radio objects, you
18075 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18076 * for it to modify.
18078 * Signals that you can add callbacks for are:
18079 * "changed" - This is called whenever the user changes the state of one of
18080 * the check object(event_info is NULL).
18082 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18086 * @brief Add a new Check object
18088 * @param parent The parent object
18089 * @return The new object or NULL if it cannot be created
18091 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18093 * @brief Set the text label of the check object
18095 * @param obj The check object
18096 * @param label The text label string in UTF-8
18098 * @deprecated use elm_object_text_set() instead.
18100 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18102 * @brief Get the text label of the check object
18104 * @param obj The check object
18105 * @return The text label string in UTF-8
18107 * @deprecated use elm_object_text_get() instead.
18109 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18111 * @brief Set the icon object of the check object
18113 * @param obj The check object
18114 * @param icon The icon object
18116 * Once the icon object is set, a previously set one will be deleted.
18117 * If you want to keep that old content object, use the
18118 * elm_check_icon_unset() function.
18120 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18122 * @brief Get the icon object of the check object
18124 * @param obj The check object
18125 * @return The icon object
18127 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18129 * @brief Unset the icon used for the check object
18131 * @param obj The check object
18132 * @return The icon object that was being used
18134 * Unparent and return the icon object which was set for this widget.
18136 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18138 * @brief Set the on/off state of the check object
18140 * @param obj The check object
18141 * @param state The state to use (1 == on, 0 == off)
18143 * This sets the state of the check. If set
18144 * with elm_check_state_pointer_set() the state of that variable is also
18145 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18147 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18149 * @brief Get the state of the check object
18151 * @param obj The check object
18152 * @return The boolean state
18154 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18156 * @brief Set a convenience pointer to a boolean to change
18158 * @param obj The check object
18159 * @param statep Pointer to the boolean to modify
18161 * This sets a pointer to a boolean, that, in addition to the check objects
18162 * state will also be modified directly. To stop setting the object pointed
18163 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18164 * then when this is called, the check objects state will also be modified to
18165 * reflect the value of the boolean @p statep points to, just like calling
18166 * elm_check_state_set().
18168 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18174 * @defgroup Radio Radio
18176 * @image html img/widget/radio/preview-00.png
18177 * @image latex img/widget/radio/preview-00.eps
18179 * @brief Radio is a widget that allows for 1 or more options to be displayed
18180 * and have the user choose only 1 of them.
18182 * A radio object contains an indicator, an optional Label and an optional
18183 * icon object. While it's possible to have a group of only one radio they,
18184 * are normally used in groups of 2 or more. To add a radio to a group use
18185 * elm_radio_group_add(). The radio object(s) will select from one of a set
18186 * of integer values, so any value they are configuring needs to be mapped to
18187 * a set of integers. To configure what value that radio object represents,
18188 * use elm_radio_state_value_set() to set the integer it represents. To set
18189 * the value the whole group(which one is currently selected) is to indicate
18190 * use elm_radio_value_set() on any group member, and to get the groups value
18191 * use elm_radio_value_get(). For convenience the radio objects are also able
18192 * to directly set an integer(int) to the value that is selected. To specify
18193 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18194 * The radio objects will modify this directly. That implies the pointer must
18195 * point to valid memory for as long as the radio objects exist.
18197 * Signals that you can add callbacks for are:
18198 * @li changed - This is called whenever the user changes the state of one of
18199 * the radio objects within the group of radio objects that work together.
18201 * @ref tutorial_radio show most of this API in action.
18205 * @brief Add a new radio to the parent
18207 * @param parent The parent object
18208 * @return The new object or NULL if it cannot be created
18210 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18212 * @brief Set the text label of the radio object
18214 * @param obj The radio object
18215 * @param label The text label string in UTF-8
18217 * @deprecated use elm_object_text_set() instead.
18219 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18221 * @brief Get the text label of the radio object
18223 * @param obj The radio object
18224 * @return The text label string in UTF-8
18226 * @deprecated use elm_object_text_set() instead.
18228 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18230 * @brief Set the icon object of the radio object
18232 * @param obj The radio object
18233 * @param icon The icon object
18235 * Once the icon object is set, a previously set one will be deleted. If you
18236 * want to keep that old content object, use the elm_radio_icon_unset()
18239 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18241 * @brief Get the icon object of the radio object
18243 * @param obj The radio object
18244 * @return The icon object
18246 * @see elm_radio_icon_set()
18248 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18250 * @brief Unset the icon used for the radio object
18252 * @param obj The radio object
18253 * @return The icon object that was being used
18255 * Unparent and return the icon object which was set for this widget.
18257 * @see elm_radio_icon_set()
18259 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18261 * @brief Add this radio to a group of other radio objects
18263 * @param obj The radio object
18264 * @param group Any object whose group the @p obj is to join.
18266 * Radio objects work in groups. Each member should have a different integer
18267 * value assigned. In order to have them work as a group, they need to know
18268 * about each other. This adds the given radio object to the group of which
18269 * the group object indicated is a member.
18271 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18273 * @brief Set the integer value that this radio object represents
18275 * @param obj The radio object
18276 * @param value The value to use if this radio object is selected
18278 * This sets the value of the radio.
18280 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18282 * @brief Get the integer value that this radio object represents
18284 * @param obj The radio object
18285 * @return The value used if this radio object is selected
18287 * This gets the value of the radio.
18289 * @see elm_radio_value_set()
18291 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18293 * @brief Set the value of the radio.
18295 * @param obj The radio object
18296 * @param value The value to use for the group
18298 * This sets the value of the radio group and will also set the value if
18299 * pointed to, to the value supplied, but will not call any callbacks.
18301 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18303 * @brief Get the state of the radio object
18305 * @param obj The radio object
18306 * @return The integer state
18308 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18310 * @brief Set a convenience pointer to a integer to change
18312 * @param obj The radio object
18313 * @param valuep Pointer to the integer to modify
18315 * This sets a pointer to a integer, that, in addition to the radio objects
18316 * state will also be modified directly. To stop setting the object pointed
18317 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18318 * when this is called, the radio objects state will also be modified to
18319 * reflect the value of the integer valuep points to, just like calling
18320 * elm_radio_value_set().
18322 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18328 * @defgroup Pager Pager
18330 * @image html img/widget/pager/preview-00.png
18331 * @image latex img/widget/pager/preview-00.eps
18333 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18335 * The flipping between “pages” of objects is animated. All content in pager
18336 * is kept in a stack, the last content to be added will be on the top of the
18337 * stack(be visible).
18339 * Objects can be pushed or popped from the stack or deleted as normal.
18340 * Pushes and pops will animate (and a pop will delete the object once the
18341 * animation is finished). Any object already in the pager can be promoted to
18342 * the top(from its current stacking position) through the use of
18343 * elm_pager_content_promote(). Objects are pushed to the top with
18344 * elm_pager_content_push() and when the top item is no longer wanted, simply
18345 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18346 * object is no longer needed and is not the top item, just delete it as
18347 * normal. You can query which objects are the top and bottom with
18348 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18350 * Signals that you can add callbacks for are:
18351 * "hide,finished" - when the previous page is hided
18353 * This widget has the following styles available:
18356 * @li fade_translucide
18357 * @li fade_invisible
18358 * @note This styles affect only the flipping animations, the appearance when
18359 * not animating is unaffected by styles.
18361 * @ref tutorial_pager gives a good overview of the usage of the API.
18365 * Add a new pager to the parent
18367 * @param parent The parent object
18368 * @return The new object or NULL if it cannot be created
18372 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18374 * @brief Push an object to the top of the pager stack (and show it).
18376 * @param obj The pager object
18377 * @param content The object to push
18379 * The object pushed becomes a child of the pager, it will be controlled and
18380 * deleted when the pager is deleted.
18382 * @note If the content is already in the stack use
18383 * elm_pager_content_promote().
18384 * @warning Using this function on @p content already in the stack results in
18385 * undefined behavior.
18387 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18389 * @brief Pop the object that is on top of the stack
18391 * @param obj The pager object
18393 * This pops the object that is on the top(visible) of the pager, makes it
18394 * disappear, then deletes the object. The object that was underneath it on
18395 * the stack will become visible.
18397 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18399 * @brief Moves an object already in the pager stack to the top of the stack.
18401 * @param obj The pager object
18402 * @param content The object to promote
18404 * This will take the @p content and move it to the top of the stack as
18405 * if it had been pushed there.
18407 * @note If the content isn't already in the stack use
18408 * elm_pager_content_push().
18409 * @warning Using this function on @p content not already in the stack
18410 * results in undefined behavior.
18412 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18414 * @brief Return the object at the bottom of the pager stack
18416 * @param obj The pager object
18417 * @return The bottom object or NULL if none
18419 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18421 * @brief Return the object at the top of the pager stack
18423 * @param obj The pager object
18424 * @return The top object or NULL if none
18426 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18432 * @defgroup Slideshow Slideshow
18434 * @image html img/widget/slideshow/preview-00.png
18435 * @image latex img/widget/slideshow/preview-00.eps
18437 * This widget, as the name indicates, is a pre-made image
18438 * slideshow panel, with API functions acting on (child) image
18439 * items presentation. Between those actions, are:
18440 * - advance to next/previous image
18441 * - select the style of image transition animation
18442 * - set the exhibition time for each image
18443 * - start/stop the slideshow
18445 * The transition animations are defined in the widget's theme,
18446 * consequently new animations can be added without having to
18447 * update the widget's code.
18449 * @section Slideshow_Items Slideshow items
18451 * For slideshow items, just like for @ref Genlist "genlist" ones,
18452 * the user defines a @b classes, specifying functions that will be
18453 * called on the item's creation and deletion times.
18455 * The #Elm_Slideshow_Item_Class structure contains the following
18458 * - @c func.get - When an item is displayed, this function is
18459 * called, and it's where one should create the item object, de
18460 * facto. For example, the object can be a pure Evas image object
18461 * or an Elementary @ref Photocam "photocam" widget. See
18462 * #SlideshowItemGetFunc.
18463 * - @c func.del - When an item is no more displayed, this function
18464 * is called, where the user must delete any data associated to
18465 * the item. See #SlideshowItemDelFunc.
18467 * @section Slideshow_Caching Slideshow caching
18469 * The slideshow provides facilities to have items adjacent to the
18470 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18471 * you, so that the system does not have to decode image data
18472 * anymore at the time it has to actually switch images on its
18473 * viewport. The user is able to set the numbers of items to be
18474 * cached @b before and @b after the current item, in the widget's
18477 * Smart events one can add callbacks for are:
18479 * - @c "changed" - when the slideshow switches its view to a new
18482 * List of examples for the slideshow widget:
18483 * @li @ref slideshow_example
18487 * @addtogroup Slideshow
18491 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18492 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18493 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18494 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18495 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18498 * @struct _Elm_Slideshow_Item_Class
18500 * Slideshow item class definition. See @ref Slideshow_Items for
18503 struct _Elm_Slideshow_Item_Class
18505 struct _Elm_Slideshow_Item_Class_Func
18507 SlideshowItemGetFunc get;
18508 SlideshowItemDelFunc del;
18510 }; /**< #Elm_Slideshow_Item_Class member definitions */
18513 * Add a new slideshow widget to the given parent Elementary
18514 * (container) object
18516 * @param parent The parent object
18517 * @return A new slideshow widget handle or @c NULL, on errors
18519 * This function inserts a new slideshow widget on the canvas.
18521 * @ingroup Slideshow
18523 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18526 * Add (append) a new item in a given slideshow widget.
18528 * @param obj The slideshow object
18529 * @param itc The item class for the item
18530 * @param data The item's data
18531 * @return A handle to the item added or @c NULL, on errors
18533 * Add a new item to @p obj's internal list of items, appending it.
18534 * The item's class must contain the function really fetching the
18535 * image object to show for this item, which could be an Evas image
18536 * object or an Elementary photo, for example. The @p data
18537 * parameter is going to be passed to both class functions of the
18540 * @see #Elm_Slideshow_Item_Class
18541 * @see elm_slideshow_item_sorted_insert()
18543 * @ingroup Slideshow
18545 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18548 * Insert a new item into the given slideshow widget, using the @p func
18549 * function to sort items (by item handles).
18551 * @param obj The slideshow object
18552 * @param itc The item class for the item
18553 * @param data The item's data
18554 * @param func The comparing function to be used to sort slideshow
18555 * items <b>by #Elm_Slideshow_Item item handles</b>
18556 * @return Returns The slideshow item handle, on success, or
18557 * @c NULL, on errors
18559 * Add a new item to @p obj's internal list of items, in a position
18560 * determined by the @p func comparing function. The item's class
18561 * must contain the function really fetching the image object to
18562 * show for this item, which could be an Evas image object or an
18563 * Elementary photo, for example. The @p data parameter is going to
18564 * be passed to both class functions of the item.
18566 * @see #Elm_Slideshow_Item_Class
18567 * @see elm_slideshow_item_add()
18569 * @ingroup Slideshow
18571 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);
18574 * Display a given slideshow widget's item, programmatically.
18576 * @param obj The slideshow object
18577 * @param item The item to display on @p obj's viewport
18579 * The change between the current item and @p item will use the
18580 * transition @p obj is set to use (@see
18581 * elm_slideshow_transition_set()).
18583 * @ingroup Slideshow
18585 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18588 * Slide to the @b next item, in a given slideshow widget
18590 * @param obj The slideshow object
18592 * The sliding animation @p obj is set to use will be the
18593 * transition effect used, after this call is issued.
18595 * @note If the end of the slideshow's internal list of items is
18596 * reached, it'll wrap around to the list's beginning, again.
18598 * @ingroup Slideshow
18600 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18603 * Slide to the @b previous item, in a given slideshow widget
18605 * @param obj The slideshow object
18607 * The sliding animation @p obj is set to use will be the
18608 * transition effect used, after this call is issued.
18610 * @note If the beginning of the slideshow's internal list of items
18611 * is reached, it'll wrap around to the list's end, again.
18613 * @ingroup Slideshow
18615 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18618 * Returns the list of sliding transition/effect names available, for a
18619 * given slideshow widget.
18621 * @param obj The slideshow object
18622 * @return The list of transitions (list of @b stringshared strings
18625 * The transitions, which come from @p obj's theme, must be an EDC
18626 * data item named @c "transitions" on the theme file, with (prefix)
18627 * names of EDC programs actually implementing them.
18629 * The available transitions for slideshows on the default theme are:
18630 * - @c "fade" - the current item fades out, while the new one
18631 * fades in to the slideshow's viewport.
18632 * - @c "black_fade" - the current item fades to black, and just
18633 * then, the new item will fade in.
18634 * - @c "horizontal" - the current item slides horizontally, until
18635 * it gets out of the slideshow's viewport, while the new item
18636 * comes from the left to take its place.
18637 * - @c "vertical" - the current item slides vertically, until it
18638 * gets out of the slideshow's viewport, while the new item comes
18639 * from the bottom to take its place.
18640 * - @c "square" - the new item starts to appear from the middle of
18641 * the current one, but with a tiny size, growing until its
18642 * target (full) size and covering the old one.
18644 * @warning The stringshared strings get no new references
18645 * exclusive to the user grabbing the list, here, so if you'd like
18646 * to use them out of this call's context, you'd better @c
18647 * eina_stringshare_ref() them.
18649 * @see elm_slideshow_transition_set()
18651 * @ingroup Slideshow
18653 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18656 * Set the current slide transition/effect in use for a given
18659 * @param obj The slideshow object
18660 * @param transition The new transition's name string
18662 * If @p transition is implemented in @p obj's theme (i.e., is
18663 * contained in the list returned by
18664 * elm_slideshow_transitions_get()), this new sliding effect will
18665 * be used on the widget.
18667 * @see elm_slideshow_transitions_get() for more details
18669 * @ingroup Slideshow
18671 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18674 * Get the current slide transition/effect in use for a given
18677 * @param obj The slideshow object
18678 * @return The current transition's name
18680 * @see elm_slideshow_transition_set() for more details
18682 * @ingroup Slideshow
18684 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18687 * Set the interval between each image transition on a given
18688 * slideshow widget, <b>and start the slideshow, itself</b>
18690 * @param obj The slideshow object
18691 * @param timeout The new displaying timeout for images
18693 * After this call, the slideshow widget will start cycling its
18694 * view, sequentially and automatically, with the images of the
18695 * items it has. The time between each new image displayed is going
18696 * to be @p timeout, in @b seconds. If a different timeout was set
18697 * previously and an slideshow was in progress, it will continue
18698 * with the new time between transitions, after this call.
18700 * @note A value less than or equal to 0 on @p timeout will disable
18701 * the widget's internal timer, thus halting any slideshow which
18702 * could be happening on @p obj.
18704 * @see elm_slideshow_timeout_get()
18706 * @ingroup Slideshow
18708 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18711 * Get the interval set for image transitions on a given slideshow
18714 * @param obj The slideshow object
18715 * @return Returns the timeout set on it
18717 * @see elm_slideshow_timeout_set() for more details
18719 * @ingroup Slideshow
18721 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18724 * Set if, after a slideshow is started, for a given slideshow
18725 * widget, its items should be displayed cyclically or not.
18727 * @param obj The slideshow object
18728 * @param loop Use @c EINA_TRUE to make it cycle through items or
18729 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18732 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18733 * ignore what is set by this functions, i.e., they'll @b always
18734 * cycle through items. This affects only the "automatic"
18735 * slideshow, as set by elm_slideshow_timeout_set().
18737 * @see elm_slideshow_loop_get()
18739 * @ingroup Slideshow
18741 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18744 * Get if, after a slideshow is started, for a given slideshow
18745 * widget, its items are to be displayed cyclically or not.
18747 * @param obj The slideshow object
18748 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18749 * through or @c EINA_FALSE, otherwise
18751 * @see elm_slideshow_loop_set() for more details
18753 * @ingroup Slideshow
18755 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18758 * Remove all items from a given slideshow widget
18760 * @param obj The slideshow object
18762 * This removes (and deletes) all items in @p obj, leaving it
18765 * @see elm_slideshow_item_del(), to remove just one item.
18767 * @ingroup Slideshow
18769 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18772 * Get the internal list of items in a given slideshow widget.
18774 * @param obj The slideshow object
18775 * @return The list of items (#Elm_Slideshow_Item as data) or
18776 * @c NULL on errors.
18778 * This list is @b not to be modified in any way and must not be
18779 * freed. Use the list members with functions like
18780 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18782 * @warning This list is only valid until @p obj object's internal
18783 * items list is changed. It should be fetched again with another
18784 * call to this function when changes happen.
18786 * @ingroup Slideshow
18788 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18791 * Delete a given item from a slideshow widget.
18793 * @param item The slideshow item
18795 * @ingroup Slideshow
18797 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18800 * Return the data associated with a given slideshow item
18802 * @param item The slideshow item
18803 * @return Returns the data associated to this item
18805 * @ingroup Slideshow
18807 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18810 * Returns the currently displayed item, in a given slideshow widget
18812 * @param obj The slideshow object
18813 * @return A handle to the item being displayed in @p obj or
18814 * @c NULL, if none is (and on errors)
18816 * @ingroup Slideshow
18818 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18821 * Get the real Evas object created to implement the view of a
18822 * given slideshow item
18824 * @param item The slideshow item.
18825 * @return the Evas object implementing this item's view.
18827 * This returns the actual Evas object used to implement the
18828 * specified slideshow item's view. This may be @c NULL, as it may
18829 * not have been created or may have been deleted, at any time, by
18830 * the slideshow. <b>Do not modify this object</b> (move, resize,
18831 * show, hide, etc.), as the slideshow is controlling it. This
18832 * function is for querying, emitting custom signals or hooking
18833 * lower level callbacks for events on that object. Do not delete
18834 * this object under any circumstances.
18836 * @see elm_slideshow_item_data_get()
18838 * @ingroup Slideshow
18840 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18843 * Get the the item, in a given slideshow widget, placed at
18844 * position @p nth, in its internal items list
18846 * @param obj The slideshow object
18847 * @param nth The number of the item to grab a handle to (0 being
18849 * @return The item stored in @p obj at position @p nth or @c NULL,
18850 * if there's no item with that index (and on errors)
18852 * @ingroup Slideshow
18854 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18857 * Set the current slide layout in use for a given slideshow widget
18859 * @param obj The slideshow object
18860 * @param layout The new layout's name string
18862 * If @p layout is implemented in @p obj's theme (i.e., is contained
18863 * in the list returned by elm_slideshow_layouts_get()), this new
18864 * images layout will be used on the widget.
18866 * @see elm_slideshow_layouts_get() for more details
18868 * @ingroup Slideshow
18870 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18873 * Get the current slide layout in use for a given slideshow widget
18875 * @param obj The slideshow object
18876 * @return The current layout's name
18878 * @see elm_slideshow_layout_set() for more details
18880 * @ingroup Slideshow
18882 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18885 * Returns the list of @b layout names available, for a given
18886 * slideshow widget.
18888 * @param obj The slideshow object
18889 * @return The list of layouts (list of @b stringshared strings
18892 * Slideshow layouts will change how the widget is to dispose each
18893 * image item in its viewport, with regard to cropping, scaling,
18896 * The layouts, which come from @p obj's theme, must be an EDC
18897 * data item name @c "layouts" on the theme file, with (prefix)
18898 * names of EDC programs actually implementing them.
18900 * The available layouts for slideshows on the default theme are:
18901 * - @c "fullscreen" - item images with original aspect, scaled to
18902 * touch top and down slideshow borders or, if the image's heigh
18903 * is not enough, left and right slideshow borders.
18904 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18905 * one, but always leaving 10% of the slideshow's dimensions of
18906 * distance between the item image's borders and the slideshow
18907 * borders, for each axis.
18909 * @warning The stringshared strings get no new references
18910 * exclusive to the user grabbing the list, here, so if you'd like
18911 * to use them out of this call's context, you'd better @c
18912 * eina_stringshare_ref() them.
18914 * @see elm_slideshow_layout_set()
18916 * @ingroup Slideshow
18918 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18921 * Set the number of items to cache, on a given slideshow widget,
18922 * <b>before the current item</b>
18924 * @param obj The slideshow object
18925 * @param count Number of items to cache before the current one
18927 * The default value for this property is @c 2. See
18928 * @ref Slideshow_Caching "slideshow caching" for more details.
18930 * @see elm_slideshow_cache_before_get()
18932 * @ingroup Slideshow
18934 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18937 * Retrieve the number of items to cache, on a given slideshow widget,
18938 * <b>before the current item</b>
18940 * @param obj The slideshow object
18941 * @return The number of items set to be cached before the current one
18943 * @see elm_slideshow_cache_before_set() for more details
18945 * @ingroup Slideshow
18947 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18950 * Set the number of items to cache, on a given slideshow widget,
18951 * <b>after the current item</b>
18953 * @param obj The slideshow object
18954 * @param count Number of items to cache after the current one
18956 * The default value for this property is @c 2. See
18957 * @ref Slideshow_Caching "slideshow caching" for more details.
18959 * @see elm_slideshow_cache_after_get()
18961 * @ingroup Slideshow
18963 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18966 * Retrieve the number of items to cache, on a given slideshow widget,
18967 * <b>after the current item</b>
18969 * @param obj The slideshow object
18970 * @return The number of items set to be cached after the current one
18972 * @see elm_slideshow_cache_after_set() for more details
18974 * @ingroup Slideshow
18976 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18979 * Get the number of items stored in a given slideshow widget
18981 * @param obj The slideshow object
18982 * @return The number of items on @p obj, at the moment of this call
18984 * @ingroup Slideshow
18986 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18993 * @defgroup Fileselector File Selector
18995 * @image html img/widget/fileselector/preview-00.png
18996 * @image latex img/widget/fileselector/preview-00.eps
18998 * A file selector is a widget that allows a user to navigate
18999 * through a file system, reporting file selections back via its
19002 * It contains shortcut buttons for home directory (@c ~) and to
19003 * jump one directory upwards (..), as well as cancel/ok buttons to
19004 * confirm/cancel a given selection. After either one of those two
19005 * former actions, the file selector will issue its @c "done" smart
19008 * There's a text entry on it, too, showing the name of the current
19009 * selection. There's the possibility of making it editable, so it
19010 * is useful on file saving dialogs on applications, where one
19011 * gives a file name to save contents to, in a given directory in
19012 * the system. This custom file name will be reported on the @c
19013 * "done" smart callback (explained in sequence).
19015 * Finally, it has a view to display file system items into in two
19020 * If Elementary is built with support of the Ethumb thumbnailing
19021 * library, the second form of view will display preview thumbnails
19022 * of files which it supports.
19024 * Smart callbacks one can register to:
19026 * - @c "selected" - the user has clicked on a file (when not in
19027 * folders-only mode) or directory (when in folders-only mode)
19028 * - @c "directory,open" - the list has been populated with new
19029 * content (@c event_info is a pointer to the directory's
19030 * path, a @b stringshared string)
19031 * - @c "done" - the user has clicked on the "ok" or "cancel"
19032 * buttons (@c event_info is a pointer to the selection's
19033 * path, a @b stringshared string)
19035 * Here is an example on its usage:
19036 * @li @ref fileselector_example
19040 * @addtogroup Fileselector
19045 * Defines how a file selector widget is to layout its contents
19046 * (file system entries).
19048 typedef enum _Elm_Fileselector_Mode
19050 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19051 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19052 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19053 } Elm_Fileselector_Mode;
19056 * Add a new file selector widget to the given parent Elementary
19057 * (container) object
19059 * @param parent The parent object
19060 * @return a new file selector widget handle or @c NULL, on errors
19062 * This function inserts a new file selector widget on the canvas.
19064 * @ingroup Fileselector
19066 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19069 * Enable/disable the file name entry box where the user can type
19070 * in a name for a file, in a given file selector widget
19072 * @param obj The file selector object
19073 * @param is_save @c EINA_TRUE to make the file selector a "saving
19074 * dialog", @c EINA_FALSE otherwise
19076 * Having the entry editable is useful on file saving dialogs on
19077 * applications, where one gives a file name to save contents to,
19078 * in a given directory in the system. This custom file name will
19079 * be reported on the @c "done" smart callback.
19081 * @see elm_fileselector_is_save_get()
19083 * @ingroup Fileselector
19085 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19088 * Get whether the given file selector is in "saving dialog" mode
19090 * @param obj The file selector object
19091 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19092 * mode, @c EINA_FALSE otherwise (and on errors)
19094 * @see elm_fileselector_is_save_set() for more details
19096 * @ingroup Fileselector
19098 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19101 * Enable/disable folder-only view for a given file selector widget
19103 * @param obj The file selector object
19104 * @param only @c EINA_TRUE to make @p obj only display
19105 * directories, @c EINA_FALSE to make files to be displayed in it
19108 * If enabled, the widget's view will only display folder items,
19111 * @see elm_fileselector_folder_only_get()
19113 * @ingroup Fileselector
19115 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19118 * Get whether folder-only view is set for a given file selector
19121 * @param obj The file selector object
19122 * @return only @c EINA_TRUE if @p obj is only displaying
19123 * directories, @c EINA_FALSE if files are being displayed in it
19124 * too (and on errors)
19126 * @see elm_fileselector_folder_only_get()
19128 * @ingroup Fileselector
19130 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19133 * Enable/disable the "ok" and "cancel" buttons on a given file
19136 * @param obj The file selector object
19137 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19139 * @note A file selector without those buttons will never emit the
19140 * @c "done" smart event, and is only usable if one is just hooking
19141 * to the other two events.
19143 * @see elm_fileselector_buttons_ok_cancel_get()
19145 * @ingroup Fileselector
19147 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19150 * Get whether the "ok" and "cancel" buttons on a given file
19151 * selector widget are being shown.
19153 * @param obj The file selector object
19154 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19155 * otherwise (and on errors)
19157 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19159 * @ingroup Fileselector
19161 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19164 * Enable/disable a tree view in the given file selector widget,
19165 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19167 * @param obj The file selector object
19168 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19171 * In a tree view, arrows are created on the sides of directories,
19172 * allowing them to expand in place.
19174 * @note If it's in other mode, the changes made by this function
19175 * will only be visible when one switches back to "list" mode.
19177 * @see elm_fileselector_expandable_get()
19179 * @ingroup Fileselector
19181 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19184 * Get whether tree view is enabled for the given file selector
19187 * @param obj The file selector object
19188 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19189 * otherwise (and or errors)
19191 * @see elm_fileselector_expandable_set() for more details
19193 * @ingroup Fileselector
19195 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19198 * Set, programmatically, the @b directory that a given file
19199 * selector widget will display contents from
19201 * @param obj The file selector object
19202 * @param path The path to display in @p obj
19204 * This will change the @b directory that @p obj is displaying. It
19205 * will also clear the text entry area on the @p obj object, which
19206 * displays select files' names.
19208 * @see elm_fileselector_path_get()
19210 * @ingroup Fileselector
19212 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19215 * Get the parent directory's path that a given file selector
19216 * widget is displaying
19218 * @param obj The file selector object
19219 * @return The (full) path of the directory the file selector is
19220 * displaying, a @b stringshared string
19222 * @see elm_fileselector_path_set()
19224 * @ingroup Fileselector
19226 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19229 * Set, programmatically, the currently selected file/directory in
19230 * the given file selector widget
19232 * @param obj The file selector object
19233 * @param path The (full) path to a file or directory
19234 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19235 * latter case occurs if the directory or file pointed to do not
19238 * @see elm_fileselector_selected_get()
19240 * @ingroup Fileselector
19242 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19245 * Get the currently selected item's (full) path, in the given file
19248 * @param obj The file selector object
19249 * @return The absolute path of the selected item, a @b
19250 * stringshared string
19252 * @note Custom editions on @p obj object's text entry, if made,
19253 * will appear on the return string of this function, naturally.
19255 * @see elm_fileselector_selected_set() for more details
19257 * @ingroup Fileselector
19259 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19262 * Set the mode in which a given file selector widget will display
19263 * (layout) file system entries in its view
19265 * @param obj The file selector object
19266 * @param mode The mode of the fileselector, being it one of
19267 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19268 * first one, naturally, will display the files in a list. The
19269 * latter will make the widget to display its entries in a grid
19272 * @note By using elm_fileselector_expandable_set(), the user may
19273 * trigger a tree view for that list.
19275 * @note If Elementary is built with support of the Ethumb
19276 * thumbnailing library, the second form of view will display
19277 * preview thumbnails of files which it supports. You must have
19278 * elm_need_ethumb() called in your Elementary for thumbnailing to
19281 * @see elm_fileselector_expandable_set().
19282 * @see elm_fileselector_mode_get().
19284 * @ingroup Fileselector
19286 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19289 * Get the mode in which a given file selector widget is displaying
19290 * (layouting) file system entries in its view
19292 * @param obj The fileselector object
19293 * @return The mode in which the fileselector is at
19295 * @see elm_fileselector_mode_set() for more details
19297 * @ingroup Fileselector
19299 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19306 * @defgroup Progressbar Progress bar
19308 * The progress bar is a widget for visually representing the
19309 * progress status of a given job/task.
19311 * A progress bar may be horizontal or vertical. It may display an
19312 * icon besides it, as well as primary and @b units labels. The
19313 * former is meant to label the widget as a whole, while the
19314 * latter, which is formatted with floating point values (and thus
19315 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19316 * units"</c>), is meant to label the widget's <b>progress
19317 * value</b>. Label, icon and unit strings/objects are @b optional
19318 * for progress bars.
19320 * A progress bar may be @b inverted, in which state it gets its
19321 * values inverted, with high values being on the left or top and
19322 * low values on the right or bottom, as opposed to normally have
19323 * the low values on the former and high values on the latter,
19324 * respectively, for horizontal and vertical modes.
19326 * The @b span of the progress, as set by
19327 * elm_progressbar_span_size_set(), is its length (horizontally or
19328 * vertically), unless one puts size hints on the widget to expand
19329 * on desired directions, by any container. That length will be
19330 * scaled by the object or applications scaling factor. At any
19331 * point code can query the progress bar for its value with
19332 * elm_progressbar_value_get().
19334 * Available widget styles for progress bars:
19336 * - @c "wheel" (simple style, no text, no progression, only
19337 * "pulse" effect is available)
19339 * Here is an example on its usage:
19340 * @li @ref progressbar_example
19344 * Add a new progress bar widget to the given parent Elementary
19345 * (container) object
19347 * @param parent The parent object
19348 * @return a new progress bar widget handle or @c NULL, on errors
19350 * This function inserts a new progress bar widget on the canvas.
19352 * @ingroup Progressbar
19354 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19357 * Set whether a given progress bar widget is at "pulsing mode" or
19360 * @param obj The progress bar object
19361 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19362 * @c EINA_FALSE to put it back to its default one
19364 * By default, progress bars will display values from the low to
19365 * high value boundaries. There are, though, contexts in which the
19366 * state of progression of a given task is @b unknown. For those,
19367 * one can set a progress bar widget to a "pulsing state", to give
19368 * the user an idea that some computation is being held, but
19369 * without exact progress values. In the default theme it will
19370 * animate its bar with the contents filling in constantly and back
19371 * to non-filled, in a loop. To start and stop this pulsing
19372 * animation, one has to explicitly call elm_progressbar_pulse().
19374 * @see elm_progressbar_pulse_get()
19375 * @see elm_progressbar_pulse()
19377 * @ingroup Progressbar
19379 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19382 * Get whether a given progress bar widget is at "pulsing mode" or
19385 * @param obj The progress bar object
19386 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19387 * if it's in the default one (and on errors)
19389 * @ingroup Progressbar
19391 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19394 * Start/stop a given progress bar "pulsing" animation, if its
19397 * @param obj The progress bar object
19398 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19399 * @c EINA_FALSE to @b stop it
19401 * @note This call won't do anything if @p obj is not under "pulsing mode".
19403 * @see elm_progressbar_pulse_set() for more details.
19405 * @ingroup Progressbar
19407 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19410 * Set the progress value (in percentage) on a given progress bar
19413 * @param obj The progress bar object
19414 * @param val The progress value (@b must be between @c 0.0 and @c
19417 * Use this call to set progress bar levels.
19419 * @note If you passes a value out of the specified range for @p
19420 * val, it will be interpreted as the @b closest of the @b boundary
19421 * values in the range.
19423 * @ingroup Progressbar
19425 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19428 * Get the progress value (in percentage) on a given progress bar
19431 * @param obj The progress bar object
19432 * @return The value of the progressbar
19434 * @see elm_progressbar_value_set() for more details
19436 * @ingroup Progressbar
19438 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19441 * Set the label of a given progress bar widget
19443 * @param obj The progress bar object
19444 * @param label The text label string, in UTF-8
19446 * @ingroup Progressbar
19447 * @deprecated use elm_object_text_set() instead.
19449 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19452 * Get the label of a given progress bar widget
19454 * @param obj The progressbar object
19455 * @return The text label string, in UTF-8
19457 * @ingroup Progressbar
19458 * @deprecated use elm_object_text_set() instead.
19460 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19463 * Set the icon object of a given progress bar widget
19465 * @param obj The progress bar object
19466 * @param icon The icon object
19468 * Use this call to decorate @p obj with an icon next to it.
19470 * @note Once the icon object is set, a previously set one will be
19471 * deleted. If you want to keep that old content object, use the
19472 * elm_progressbar_icon_unset() function.
19474 * @see elm_progressbar_icon_get()
19476 * @ingroup Progressbar
19478 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19481 * Retrieve the icon object set for a given progress bar widget
19483 * @param obj The progress bar object
19484 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19485 * otherwise (and on errors)
19487 * @see elm_progressbar_icon_set() for more details
19489 * @ingroup Progressbar
19491 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19494 * Unset an icon set on a given progress bar widget
19496 * @param obj The progress bar object
19497 * @return The icon object that was being used, if any was set, or
19498 * @c NULL, otherwise (and on errors)
19500 * This call will unparent and return the icon object which was set
19501 * for this widget, previously, on success.
19503 * @see elm_progressbar_icon_set() for more details
19505 * @ingroup Progressbar
19507 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19510 * Set the (exact) length of the bar region of a given progress bar
19513 * @param obj The progress bar object
19514 * @param size The length of the progress bar's bar region
19516 * This sets the minimum width (when in horizontal mode) or height
19517 * (when in vertical mode) of the actual bar area of the progress
19518 * bar @p obj. This in turn affects the object's minimum size. Use
19519 * this when you're not setting other size hints expanding on the
19520 * given direction (like weight and alignment hints) and you would
19521 * like it to have a specific size.
19523 * @note Icon, label and unit text around @p obj will require their
19524 * own space, which will make @p obj to require more the @p size,
19527 * @see elm_progressbar_span_size_get()
19529 * @ingroup Progressbar
19531 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19534 * Get the length set for the bar region of a given progress bar
19537 * @param obj The progress bar object
19538 * @return The length of the progress bar's bar region
19540 * If that size was not set previously, with
19541 * elm_progressbar_span_size_set(), this call will return @c 0.
19543 * @ingroup Progressbar
19545 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19548 * Set the format string for a given progress bar widget's units
19551 * @param obj The progress bar object
19552 * @param format The format string for @p obj's units label
19554 * If @c NULL is passed on @p format, it will make @p obj's units
19555 * area to be hidden completely. If not, it'll set the <b>format
19556 * string</b> for the units label's @b text. The units label is
19557 * provided a floating point value, so the units text is up display
19558 * at most one floating point falue. Note that the units label is
19559 * optional. Use a format string such as "%1.2f meters" for
19562 * @note The default format string for a progress bar is an integer
19563 * percentage, as in @c "%.0f %%".
19565 * @see elm_progressbar_unit_format_get()
19567 * @ingroup Progressbar
19569 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19572 * Retrieve the format string set for a given progress bar widget's
19575 * @param obj The progress bar object
19576 * @return The format set string for @p obj's units label or
19577 * @c NULL, if none was set (and on errors)
19579 * @see elm_progressbar_unit_format_set() for more details
19581 * @ingroup Progressbar
19583 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19586 * Set the orientation of a given progress bar widget
19588 * @param obj The progress bar object
19589 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19590 * @b horizontal, @c EINA_FALSE to make it @b vertical
19592 * Use this function to change how your progress bar is to be
19593 * disposed: vertically or horizontally.
19595 * @see elm_progressbar_horizontal_get()
19597 * @ingroup Progressbar
19599 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19602 * Retrieve the orientation of a given progress bar widget
19604 * @param obj The progress bar object
19605 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19606 * @c EINA_FALSE if it's @b vertical (and on errors)
19608 * @see elm_progressbar_horizontal_set() for more details
19610 * @ingroup Progressbar
19612 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19615 * Invert a given progress bar widget's displaying values order
19617 * @param obj The progress bar object
19618 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19619 * @c EINA_FALSE to bring it back to default, non-inverted values.
19621 * A progress bar may be @b inverted, in which state it gets its
19622 * values inverted, with high values being on the left or top and
19623 * low values on the right or bottom, as opposed to normally have
19624 * the low values on the former and high values on the latter,
19625 * respectively, for horizontal and vertical modes.
19627 * @see elm_progressbar_inverted_get()
19629 * @ingroup Progressbar
19631 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19634 * Get whether a given progress bar widget's displaying values are
19637 * @param obj The progress bar object
19638 * @return @c EINA_TRUE, if @p obj has inverted values,
19639 * @c EINA_FALSE otherwise (and on errors)
19641 * @see elm_progressbar_inverted_set() for more details
19643 * @ingroup Progressbar
19645 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19648 * @defgroup Separator Separator
19650 * @brief Separator is a very thin object used to separate other objects.
19652 * A separator can be vertical or horizontal.
19654 * @ref tutorial_separator is a good example of how to use a separator.
19658 * @brief Add a separator object to @p parent
19660 * @param parent The parent object
19662 * @return The separator object, or NULL upon failure
19664 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19666 * @brief Set the horizontal mode of a separator object
19668 * @param obj The separator object
19669 * @param horizontal If true, the separator is horizontal
19671 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19673 * @brief Get the horizontal mode of a separator object
19675 * @param obj The separator object
19676 * @return If true, the separator is horizontal
19678 * @see elm_separator_horizontal_set()
19680 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19686 * @defgroup Spinner Spinner
19687 * @ingroup Elementary
19689 * @image html img/widget/spinner/preview-00.png
19690 * @image latex img/widget/spinner/preview-00.eps
19692 * A spinner is a widget which allows the user to increase or decrease
19693 * numeric values using arrow buttons, or edit values directly, clicking
19694 * over it and typing the new value.
19696 * By default the spinner will not wrap and has a label
19697 * of "%.0f" (just showing the integer value of the double).
19699 * A spinner has a label that is formatted with floating
19700 * point values and thus accepts a printf-style format string, like
19703 * It also allows specific values to be replaced by pre-defined labels.
19705 * Smart callbacks one can register to:
19707 * - "changed" - Whenever the spinner value is changed.
19708 * - "delay,changed" - A short time after the value is changed by the user.
19709 * This will be called only when the user stops dragging for a very short
19710 * period or when they release their finger/mouse, so it avoids possibly
19711 * expensive reactions to the value change.
19713 * Available styles for it:
19715 * - @c "vertical": up/down buttons at the right side and text left aligned.
19717 * Here is an example on its usage:
19718 * @ref spinner_example
19722 * @addtogroup Spinner
19727 * Add a new spinner widget to the given parent Elementary
19728 * (container) object.
19730 * @param parent The parent object.
19731 * @return a new spinner widget handle or @c NULL, on errors.
19733 * This function inserts a new spinner widget on the canvas.
19738 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19741 * Set the format string of the displayed label.
19743 * @param obj The spinner object.
19744 * @param fmt The format string for the label display.
19746 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19747 * string for the label text. The label text is provided a floating point
19748 * value, so the label text can display up to 1 floating point value.
19749 * Note that this is optional.
19751 * Use a format string such as "%1.2f meters" for example, and it will
19752 * display values like: "3.14 meters" for a value equal to 3.14159.
19754 * Default is "%0.f".
19756 * @see elm_spinner_label_format_get()
19760 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19763 * Get the label format of the spinner.
19765 * @param obj The spinner object.
19766 * @return The text label format string in UTF-8.
19768 * @see elm_spinner_label_format_set() for details.
19772 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19775 * Set the minimum and maximum values for the spinner.
19777 * @param obj The spinner object.
19778 * @param min The minimum value.
19779 * @param max The maximum value.
19781 * Define the allowed range of values to be selected by the user.
19783 * If actual value is less than @p min, it will be updated to @p min. If it
19784 * is bigger then @p max, will be updated to @p max. Actual value can be
19785 * get with elm_spinner_value_get().
19787 * By default, min is equal to 0, and max is equal to 100.
19789 * @warning Maximum must be greater than minimum.
19791 * @see elm_spinner_min_max_get()
19795 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19798 * Get the minimum and maximum values of the spinner.
19800 * @param obj The spinner object.
19801 * @param min Pointer where to store the minimum value.
19802 * @param max Pointer where to store the maximum value.
19804 * @note If only one value is needed, the other pointer can be passed
19807 * @see elm_spinner_min_max_set() for details.
19811 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19814 * Set the step used to increment or decrement the spinner value.
19816 * @param obj The spinner object.
19817 * @param step The step value.
19819 * This value will be incremented or decremented to the displayed value.
19820 * It will be incremented while the user keep right or top arrow pressed,
19821 * and will be decremented while the user keep left or bottom arrow pressed.
19823 * The interval to increment / decrement can be set with
19824 * elm_spinner_interval_set().
19826 * By default step value is equal to 1.
19828 * @see elm_spinner_step_get()
19832 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19835 * Get the step used to increment or decrement the spinner value.
19837 * @param obj The spinner object.
19838 * @return The step value.
19840 * @see elm_spinner_step_get() for more details.
19844 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19847 * Set the value the spinner displays.
19849 * @param obj The spinner object.
19850 * @param val The value to be displayed.
19852 * Value will be presented on the label following format specified with
19853 * elm_spinner_format_set().
19855 * @warning The value must to be between min and max values. This values
19856 * are set by elm_spinner_min_max_set().
19858 * @see elm_spinner_value_get().
19859 * @see elm_spinner_format_set().
19860 * @see elm_spinner_min_max_set().
19864 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19867 * Get the value displayed by the spinner.
19869 * @param obj The spinner object.
19870 * @return The value displayed.
19872 * @see elm_spinner_value_set() for details.
19876 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19879 * Set whether the spinner should wrap when it reaches its
19880 * minimum or maximum value.
19882 * @param obj The spinner object.
19883 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19886 * Disabled by default. If disabled, when the user tries to increment the
19888 * but displayed value plus step value is bigger than maximum value,
19890 * won't allow it. The same happens when the user tries to decrement it,
19891 * but the value less step is less than minimum value.
19893 * When wrap is enabled, in such situations it will allow these changes,
19894 * but will get the value that would be less than minimum and subtracts
19895 * from maximum. Or add the value that would be more than maximum to
19899 * @li min value = 10
19900 * @li max value = 50
19901 * @li step value = 20
19902 * @li displayed value = 20
19904 * When the user decrement value (using left or bottom arrow), it will
19905 * displays @c 40, because max - (min - (displayed - step)) is
19906 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19908 * @see elm_spinner_wrap_get().
19912 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19915 * Get whether the spinner should wrap when it reaches its
19916 * minimum or maximum value.
19918 * @param obj The spinner object
19919 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19920 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19922 * @see elm_spinner_wrap_set() for details.
19926 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19929 * Set whether the spinner can be directly edited by the user or not.
19931 * @param obj The spinner object.
19932 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19933 * don't allow users to edit it directly.
19935 * Spinner objects can have edition @b disabled, in which state they will
19936 * be changed only by arrows.
19937 * Useful for contexts
19938 * where you don't want your users to interact with it writting the value.
19940 * when using special values, the user can see real value instead
19941 * of special label on edition.
19943 * It's enabled by default.
19945 * @see elm_spinner_editable_get()
19949 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19952 * Get whether the spinner can be directly edited by the user or not.
19954 * @param obj The spinner object.
19955 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19956 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19958 * @see elm_spinner_editable_set() for details.
19962 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19965 * Set a special string to display in the place of the numerical value.
19967 * @param obj The spinner object.
19968 * @param value The value to be replaced.
19969 * @param label The label to be used.
19971 * It's useful for cases when a user should select an item that is
19972 * better indicated by a label than a value. For example, weekdays or months.
19976 * sp = elm_spinner_add(win);
19977 * elm_spinner_min_max_set(sp, 1, 3);
19978 * elm_spinner_special_value_add(sp, 1, "January");
19979 * elm_spinner_special_value_add(sp, 2, "February");
19980 * elm_spinner_special_value_add(sp, 3, "March");
19981 * evas_object_show(sp);
19986 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19989 * Set the interval on time updates for an user mouse button hold
19990 * on spinner widgets' arrows.
19992 * @param obj The spinner object.
19993 * @param interval The (first) interval value in seconds.
19995 * This interval value is @b decreased while the user holds the
19996 * mouse pointer either incrementing or decrementing spinner's value.
19998 * This helps the user to get to a given value distant from the
19999 * current one easier/faster, as it will start to change quicker and
20000 * quicker on mouse button holds.
20002 * The calculation for the next change interval value, starting from
20003 * the one set with this call, is the previous interval divided by
20004 * @c 1.05, so it decreases a little bit.
20006 * The default starting interval value for automatic changes is
20009 * @see elm_spinner_interval_get()
20013 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20016 * Get the interval on time updates for an user mouse button hold
20017 * on spinner widgets' arrows.
20019 * @param obj The spinner object.
20020 * @return The (first) interval value, in seconds, set on it.
20022 * @see elm_spinner_interval_set() for more details.
20026 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20033 * @defgroup Index Index
20035 * @image html img/widget/index/preview-00.png
20036 * @image latex img/widget/index/preview-00.eps
20038 * An index widget gives you an index for fast access to whichever
20039 * group of other UI items one might have. It's a list of text
20040 * items (usually letters, for alphabetically ordered access).
20042 * Index widgets are by default hidden and just appear when the
20043 * user clicks over it's reserved area in the canvas. In its
20044 * default theme, it's an area one @ref Fingers "finger" wide on
20045 * the right side of the index widget's container.
20047 * When items on the index are selected, smart callbacks get
20048 * called, so that its user can make other container objects to
20049 * show a given area or child object depending on the index item
20050 * selected. You'd probably be using an index together with @ref
20051 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20054 * Smart events one can add callbacks for are:
20055 * - @c "changed" - When the selected index item changes. @c
20056 * event_info is the selected item's data pointer.
20057 * - @c "delay,changed" - When the selected index item changes, but
20058 * after a small idling period. @c event_info is the selected
20059 * item's data pointer.
20060 * - @c "selected" - When the user releases a mouse button and
20061 * selects an item. @c event_info is the selected item's data
20063 * - @c "level,up" - when the user moves a finger from the first
20064 * level to the second level
20065 * - @c "level,down" - when the user moves a finger from the second
20066 * level to the first level
20068 * The @c "delay,changed" event is so that it'll wait a small time
20069 * before actually reporting those events and, moreover, just the
20070 * last event happening on those time frames will actually be
20073 * Here are some examples on its usage:
20074 * @li @ref index_example_01
20075 * @li @ref index_example_02
20079 * @addtogroup Index
20083 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20086 * Add a new index widget to the given parent Elementary
20087 * (container) object
20089 * @param parent The parent object
20090 * @return a new index widget handle or @c NULL, on errors
20092 * This function inserts a new index widget on the canvas.
20096 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20099 * Set whether a given index widget is or not visible,
20102 * @param obj The index object
20103 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20105 * Not to be confused with visible as in @c evas_object_show() --
20106 * visible with regard to the widget's auto hiding feature.
20108 * @see elm_index_active_get()
20112 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20115 * Get whether a given index widget is currently visible or not.
20117 * @param obj The index object
20118 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20120 * @see elm_index_active_set() for more details
20124 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20127 * Set the items level for a given index widget.
20129 * @param obj The index object.
20130 * @param level @c 0 or @c 1, the currently implemented levels.
20132 * @see elm_index_item_level_get()
20136 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20139 * Get the items level set for a given index widget.
20141 * @param obj The index object.
20142 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20144 * @see elm_index_item_level_set() for more information
20148 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20151 * Returns the last selected item's data, for a given index widget.
20153 * @param obj The index object.
20154 * @return The item @b data associated to the last selected item on
20155 * @p obj (or @c NULL, on errors).
20157 * @warning The returned value is @b not an #Elm_Index_Item item
20158 * handle, but the data associated to it (see the @c item parameter
20159 * in elm_index_item_append(), as an example).
20163 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20166 * Append a new item on a given index widget.
20168 * @param obj The index object.
20169 * @param letter Letter under which the item should be indexed
20170 * @param item The item data to set for the index's item
20172 * Despite the most common usage of the @p letter argument is for
20173 * single char strings, one could use arbitrary strings as index
20176 * @c item will be the pointer returned back on @c "changed", @c
20177 * "delay,changed" and @c "selected" smart events.
20181 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20184 * Prepend a new item on a given index widget.
20186 * @param obj The index object.
20187 * @param letter Letter under which the item should be indexed
20188 * @param item The item data to set for the index's item
20190 * Despite the most common usage of the @p letter argument is for
20191 * single char strings, one could use arbitrary strings as index
20194 * @c item will be the pointer returned back on @c "changed", @c
20195 * "delay,changed" and @c "selected" smart events.
20199 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20202 * Append a new item, on a given index widget, <b>after the item
20203 * having @p relative as data</b>.
20205 * @param obj The index object.
20206 * @param letter Letter under which the item should be indexed
20207 * @param item The item data to set for the index's item
20208 * @param relative The item data of the index item to be the
20209 * predecessor of this new one
20211 * Despite the most common usage of the @p letter argument is for
20212 * single char strings, one could use arbitrary strings as index
20215 * @c item will be the pointer returned back on @c "changed", @c
20216 * "delay,changed" and @c "selected" smart events.
20218 * @note If @p relative is @c NULL or if it's not found to be data
20219 * set on any previous item on @p obj, this function will behave as
20220 * elm_index_item_append().
20224 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20227 * Prepend a new item, on a given index widget, <b>after the item
20228 * having @p relative as data</b>.
20230 * @param obj The index object.
20231 * @param letter Letter under which the item should be indexed
20232 * @param item The item data to set for the index's item
20233 * @param relative The item data of the index item to be the
20234 * successor of this new one
20236 * Despite the most common usage of the @p letter argument is for
20237 * single char strings, one could use arbitrary strings as index
20240 * @c item will be the pointer returned back on @c "changed", @c
20241 * "delay,changed" and @c "selected" smart events.
20243 * @note If @p relative is @c NULL or if it's not found to be data
20244 * set on any previous item on @p obj, this function will behave as
20245 * elm_index_item_prepend().
20249 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20252 * Insert a new item into the given index widget, using @p cmp_func
20253 * function to sort items (by item handles).
20255 * @param obj The index object.
20256 * @param letter Letter under which the item should be indexed
20257 * @param item The item data to set for the index's item
20258 * @param cmp_func The comparing function to be used to sort index
20259 * items <b>by #Elm_Index_Item item handles</b>
20260 * @param cmp_data_func A @b fallback function to be called for the
20261 * sorting of index items <b>by item data</b>). It will be used
20262 * when @p cmp_func returns @c 0 (equality), which means an index
20263 * item with provided item data already exists. To decide which
20264 * data item should be pointed to by the index item in question, @p
20265 * cmp_data_func will be used. If @p cmp_data_func returns a
20266 * non-negative value, the previous index item data will be
20267 * replaced by the given @p item pointer. If the previous data need
20268 * to be freed, it should be done by the @p cmp_data_func function,
20269 * because all references to it will be lost. If this function is
20270 * not provided (@c NULL is given), index items will be @b
20271 * duplicated, if @p cmp_func returns @c 0.
20273 * Despite the most common usage of the @p letter argument is for
20274 * single char strings, one could use arbitrary strings as index
20277 * @c item will be the pointer returned back on @c "changed", @c
20278 * "delay,changed" and @c "selected" smart events.
20282 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);
20285 * Remove an item from a given index widget, <b>to be referenced by
20286 * it's data value</b>.
20288 * @param obj The index object
20289 * @param item The item's data pointer for the item to be removed
20292 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20293 * that callback function will be called by this one.
20295 * @warning The item to be removed from @p obj will be found via
20296 * its item data pointer, and not by an #Elm_Index_Item handle.
20300 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20303 * Find a given index widget's item, <b>using item data</b>.
20305 * @param obj The index object
20306 * @param item The item data pointed to by the desired index item
20307 * @return The index item handle, if found, or @c NULL otherwise
20311 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20314 * Removes @b all items from a given index widget.
20316 * @param obj The index object.
20318 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20319 * that callback function will be called for each item in @p obj.
20323 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20326 * Go to a given items level on a index widget
20328 * @param obj The index object
20329 * @param level The index level (one of @c 0 or @c 1)
20333 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20336 * Return the data associated with a given index widget item
20338 * @param it The index widget item handle
20339 * @return The data associated with @p it
20341 * @see elm_index_item_data_set()
20345 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20348 * Set the data associated with a given index widget item
20350 * @param it The index widget item handle
20351 * @param data The new data pointer to set to @p it
20353 * This sets new item data on @p it.
20355 * @warning The old data pointer won't be touched by this function, so
20356 * the user had better to free that old data himself/herself.
20360 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20363 * Set the function to be called when a given index widget item is freed.
20365 * @param it The item to set the callback on
20366 * @param func The function to call on the item's deletion
20368 * When called, @p func will have both @c data and @c event_info
20369 * arguments with the @p it item's data value and, naturally, the
20370 * @c obj argument with a handle to the parent index widget.
20374 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20377 * Get the letter (string) set on a given index widget item.
20379 * @param it The index item handle
20380 * @return The letter string set on @p it
20384 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20391 * @defgroup Photocam Photocam
20393 * @image html img/widget/photocam/preview-00.png
20394 * @image latex img/widget/photocam/preview-00.eps
20396 * This is a widget specifically for displaying high-resolution digital
20397 * camera photos giving speedy feedback (fast load), low memory footprint
20398 * and zooming and panning as well as fitting logic. It is entirely focused
20399 * on jpeg images, and takes advantage of properties of the jpeg format (via
20400 * evas loader features in the jpeg loader).
20402 * Signals that you can add callbacks for are:
20403 * @li "clicked" - This is called when a user has clicked the photo without
20405 * @li "press" - This is called when a user has pressed down on the photo.
20406 * @li "longpressed" - This is called when a user has pressed down on the
20407 * photo for a long time without dragging around.
20408 * @li "clicked,double" - This is called when a user has double-clicked the
20410 * @li "load" - Photo load begins.
20411 * @li "loaded" - This is called when the image file load is complete for the
20412 * first view (low resolution blurry version).
20413 * @li "load,detail" - Photo detailed data load begins.
20414 * @li "loaded,detail" - This is called when the image file load is complete
20415 * for the detailed image data (full resolution needed).
20416 * @li "zoom,start" - Zoom animation started.
20417 * @li "zoom,stop" - Zoom animation stopped.
20418 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20419 * @li "scroll" - the content has been scrolled (moved)
20420 * @li "scroll,anim,start" - scrolling animation has started
20421 * @li "scroll,anim,stop" - scrolling animation has stopped
20422 * @li "scroll,drag,start" - dragging the contents around has started
20423 * @li "scroll,drag,stop" - dragging the contents around has stopped
20425 * @ref tutorial_photocam shows the API in action.
20429 * @brief Types of zoom available.
20431 typedef enum _Elm_Photocam_Zoom_Mode
20433 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20434 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20435 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20436 ELM_PHOTOCAM_ZOOM_MODE_LAST
20437 } Elm_Photocam_Zoom_Mode;
20439 * @brief Add a new Photocam object
20441 * @param parent The parent object
20442 * @return The new object or NULL if it cannot be created
20444 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20446 * @brief Set the photo file to be shown
20448 * @param obj The photocam object
20449 * @param file The photo file
20450 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20452 * This sets (and shows) the specified file (with a relative or absolute
20453 * path) and will return a load error (same error that
20454 * evas_object_image_load_error_get() will return). The image will change and
20455 * adjust its size at this point and begin a background load process for this
20456 * photo that at some time in the future will be displayed at the full
20459 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20461 * @brief Returns the path of the current image file
20463 * @param obj The photocam object
20464 * @return Returns the path
20466 * @see elm_photocam_file_set()
20468 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20470 * @brief Set the zoom level of the photo
20472 * @param obj The photocam object
20473 * @param zoom The zoom level to set
20475 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20476 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20477 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20478 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20481 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20483 * @brief Get the zoom level of the photo
20485 * @param obj The photocam object
20486 * @return The current zoom level
20488 * This returns the current zoom level of the photocam object. Note that if
20489 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20490 * (which is the default), the zoom level may be changed at any time by the
20491 * photocam object itself to account for photo size and photocam viewpoer
20494 * @see elm_photocam_zoom_set()
20495 * @see elm_photocam_zoom_mode_set()
20497 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20499 * @brief Set the zoom mode
20501 * @param obj The photocam object
20502 * @param mode The desired mode
20504 * This sets the zoom mode to manual or one of several automatic levels.
20505 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20506 * elm_photocam_zoom_set() and will stay at that level until changed by code
20507 * or until zoom mode is changed. This is the default mode. The Automatic
20508 * modes will allow the photocam object to automatically adjust zoom mode
20509 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20510 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20511 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20512 * pixels within the frame are left unfilled.
20514 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20516 * @brief Get the zoom mode
20518 * @param obj The photocam object
20519 * @return The current zoom mode
20521 * This gets the current zoom mode of the photocam object.
20523 * @see elm_photocam_zoom_mode_set()
20525 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20527 * @brief Get the current image pixel width and height
20529 * @param obj The photocam object
20530 * @param w A pointer to the width return
20531 * @param h A pointer to the height return
20533 * This gets the current photo pixel width and height (for the original).
20534 * The size will be returned in the integers @p w and @p h that are pointed
20537 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20539 * @brief Get the area of the image that is currently shown
20542 * @param x A pointer to the X-coordinate of region
20543 * @param y A pointer to the Y-coordinate of region
20544 * @param w A pointer to the width
20545 * @param h A pointer to the height
20547 * @see elm_photocam_image_region_show()
20548 * @see elm_photocam_image_region_bring_in()
20550 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20552 * @brief Set the viewed portion of the image
20554 * @param obj The photocam object
20555 * @param x X-coordinate of region in image original pixels
20556 * @param y Y-coordinate of region in image original pixels
20557 * @param w Width of region in image original pixels
20558 * @param h Height of region in image original pixels
20560 * This shows the region of the image without using animation.
20562 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20564 * @brief Bring in the viewed portion of the image
20566 * @param obj The photocam object
20567 * @param x X-coordinate of region in image original pixels
20568 * @param y Y-coordinate of region in image original pixels
20569 * @param w Width of region in image original pixels
20570 * @param h Height of region in image original pixels
20572 * This shows the region of the image using animation.
20574 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20576 * @brief Set the paused state for photocam
20578 * @param obj The photocam object
20579 * @param paused The pause state to set
20581 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20582 * photocam. The default is off. This will stop zooming using animation on
20583 * zoom levels changes and change instantly. This will stop any existing
20584 * animations that are running.
20586 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20588 * @brief Get the paused state for photocam
20590 * @param obj The photocam object
20591 * @return The current paused state
20593 * This gets the current paused state for the photocam object.
20595 * @see elm_photocam_paused_set()
20597 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20599 * @brief Get the internal low-res image used for photocam
20601 * @param obj The photocam object
20602 * @return The internal image object handle, or NULL if none exists
20604 * This gets the internal image object inside photocam. Do not modify it. It
20605 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20606 * deleted at any time as well.
20608 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20610 * @brief Set the photocam scrolling bouncing.
20612 * @param obj The photocam object
20613 * @param h_bounce bouncing for horizontal
20614 * @param v_bounce bouncing for vertical
20616 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20618 * @brief Get the photocam scrolling bouncing.
20620 * @param obj The photocam object
20621 * @param h_bounce bouncing for horizontal
20622 * @param v_bounce bouncing for vertical
20624 * @see elm_photocam_bounce_set()
20626 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20632 * @defgroup Map Map
20633 * @ingroup Elementary
20635 * @image html img/widget/map/preview-00.png
20636 * @image latex img/widget/map/preview-00.eps
20638 * This is a widget specifically for displaying a map. It uses basically
20639 * OpenStreetMap provider http://www.openstreetmap.org/,
20640 * but custom providers can be added.
20642 * It supports some basic but yet nice features:
20643 * @li zoom and scroll
20644 * @li markers with content to be displayed when user clicks over it
20645 * @li group of markers
20648 * Smart callbacks one can listen to:
20650 * - "clicked" - This is called when a user has clicked the map without
20652 * - "press" - This is called when a user has pressed down on the map.
20653 * - "longpressed" - This is called when a user has pressed down on the map
20654 * for a long time without dragging around.
20655 * - "clicked,double" - This is called when a user has double-clicked
20657 * - "load,detail" - Map detailed data load begins.
20658 * - "loaded,detail" - This is called when all currently visible parts of
20659 * the map are loaded.
20660 * - "zoom,start" - Zoom animation started.
20661 * - "zoom,stop" - Zoom animation stopped.
20662 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20663 * - "scroll" - the content has been scrolled (moved).
20664 * - "scroll,anim,start" - scrolling animation has started.
20665 * - "scroll,anim,stop" - scrolling animation has stopped.
20666 * - "scroll,drag,start" - dragging the contents around has started.
20667 * - "scroll,drag,stop" - dragging the contents around has stopped.
20668 * - "downloaded" - This is called when all currently required map images
20670 * - "route,load" - This is called when route request begins.
20671 * - "route,loaded" - This is called when route request ends.
20672 * - "name,load" - This is called when name request begins.
20673 * - "name,loaded- This is called when name request ends.
20675 * Available style for map widget:
20678 * Available style for markers:
20683 * Available style for marker bubble:
20686 * List of examples:
20687 * @li @ref map_example_01
20688 * @li @ref map_example_02
20689 * @li @ref map_example_03
20698 * @enum _Elm_Map_Zoom_Mode
20699 * @typedef Elm_Map_Zoom_Mode
20701 * Set map's zoom behavior. It can be set to manual or automatic.
20703 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20705 * Values <b> don't </b> work as bitmask, only one can be choosen.
20707 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20708 * than the scroller view.
20710 * @see elm_map_zoom_mode_set()
20711 * @see elm_map_zoom_mode_get()
20715 typedef enum _Elm_Map_Zoom_Mode
20717 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20718 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20719 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20720 ELM_MAP_ZOOM_MODE_LAST
20721 } Elm_Map_Zoom_Mode;
20724 * @enum _Elm_Map_Route_Sources
20725 * @typedef Elm_Map_Route_Sources
20727 * Set route service to be used. By default used source is
20728 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20730 * @see elm_map_route_source_set()
20731 * @see elm_map_route_source_get()
20735 typedef enum _Elm_Map_Route_Sources
20737 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20738 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. */
20739 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20740 ELM_MAP_ROUTE_SOURCE_LAST
20741 } Elm_Map_Route_Sources;
20743 typedef enum _Elm_Map_Name_Sources
20745 ELM_MAP_NAME_SOURCE_NOMINATIM,
20746 ELM_MAP_NAME_SOURCE_LAST
20747 } Elm_Map_Name_Sources;
20750 * @enum _Elm_Map_Route_Type
20751 * @typedef Elm_Map_Route_Type
20753 * Set type of transport used on route.
20755 * @see elm_map_route_add()
20759 typedef enum _Elm_Map_Route_Type
20761 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20762 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20763 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20764 ELM_MAP_ROUTE_TYPE_LAST
20765 } Elm_Map_Route_Type;
20768 * @enum _Elm_Map_Route_Method
20769 * @typedef Elm_Map_Route_Method
20771 * Set the routing method, what should be priorized, time or distance.
20773 * @see elm_map_route_add()
20777 typedef enum _Elm_Map_Route_Method
20779 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20780 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20781 ELM_MAP_ROUTE_METHOD_LAST
20782 } Elm_Map_Route_Method;
20784 typedef enum _Elm_Map_Name_Method
20786 ELM_MAP_NAME_METHOD_SEARCH,
20787 ELM_MAP_NAME_METHOD_REVERSE,
20788 ELM_MAP_NAME_METHOD_LAST
20789 } Elm_Map_Name_Method;
20791 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(). */
20792 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(). */
20793 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(). */
20794 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(). */
20795 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20796 typedef struct _Elm_Map_Track Elm_Map_Track;
20798 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. */
20799 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20800 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20801 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20803 typedef char *(*ElmMapModuleSourceFunc) (void);
20804 typedef int (*ElmMapModuleZoomMinFunc) (void);
20805 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20806 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20807 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20808 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20809 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20810 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20811 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20814 * Add a new map widget to the given parent Elementary (container) object.
20816 * @param parent The parent object.
20817 * @return a new map widget handle or @c NULL, on errors.
20819 * This function inserts a new map widget on the canvas.
20823 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20826 * Set the zoom level of the map.
20828 * @param obj The map object.
20829 * @param zoom The zoom level to set.
20831 * This sets the zoom level.
20833 * It will respect limits defined by elm_map_source_zoom_min_set() and
20834 * elm_map_source_zoom_max_set().
20836 * By default these values are 0 (world map) and 18 (maximum zoom).
20838 * This function should be used when zoom mode is set to
20839 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20840 * with elm_map_zoom_mode_set().
20842 * @see elm_map_zoom_mode_set().
20843 * @see elm_map_zoom_get().
20847 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20850 * Get the zoom level of the map.
20852 * @param obj The map object.
20853 * @return The current zoom level.
20855 * This returns the current zoom level of the map object.
20857 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20858 * (which is the default), the zoom level may be changed at any time by the
20859 * map object itself to account for map size and map viewport size.
20861 * @see elm_map_zoom_set() for details.
20865 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20868 * Set the zoom mode used by the map object.
20870 * @param obj The map object.
20871 * @param mode The zoom mode of the map, being it one of
20872 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20873 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20875 * This sets the zoom mode to manual or one of the automatic levels.
20876 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20877 * elm_map_zoom_set() and will stay at that level until changed by code
20878 * or until zoom mode is changed. This is the default mode.
20880 * The Automatic modes will allow the map object to automatically
20881 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20882 * adjust zoom so the map fits inside the scroll frame with no pixels
20883 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20884 * ensure no pixels within the frame are left unfilled. Do not forget that
20885 * the valid sizes are 2^zoom, consequently the map may be smaller than
20886 * the scroller view.
20888 * @see elm_map_zoom_set()
20892 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20895 * Get the zoom mode used by the map object.
20897 * @param obj The map object.
20898 * @return The zoom mode of the map, being it one of
20899 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20900 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20902 * This function returns the current zoom mode used by the map object.
20904 * @see elm_map_zoom_mode_set() for more details.
20908 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20911 * Get the current coordinates of the map.
20913 * @param obj The map object.
20914 * @param lon Pointer where to store longitude.
20915 * @param lat Pointer where to store latitude.
20917 * This gets the current center coordinates of the map object. It can be
20918 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20920 * @see elm_map_geo_region_bring_in()
20921 * @see elm_map_geo_region_show()
20925 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20928 * Animatedly bring in given coordinates to the center of the map.
20930 * @param obj The map object.
20931 * @param lon Longitude to center at.
20932 * @param lat Latitude to center at.
20934 * This causes map to jump to the given @p lat and @p lon coordinates
20935 * and show it (by scrolling) in the center of the viewport, if it is not
20936 * already centered. This will use animation to do so and take a period
20937 * of time to complete.
20939 * @see elm_map_geo_region_show() for a function to avoid animation.
20940 * @see elm_map_geo_region_get()
20944 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20947 * Show the given coordinates at the center of the map, @b immediately.
20949 * @param obj The map object.
20950 * @param lon Longitude to center at.
20951 * @param lat Latitude to center at.
20953 * This causes map to @b redraw its viewport's contents to the
20954 * region contining the given @p lat and @p lon, that will be moved to the
20955 * center of the map.
20957 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20958 * @see elm_map_geo_region_get()
20962 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20965 * Pause or unpause the map.
20967 * @param obj The map object.
20968 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20971 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20974 * The default is off.
20976 * This will stop zooming using animation, changing zoom levels will
20977 * change instantly. This will stop any existing animations that are running.
20979 * @see elm_map_paused_get()
20983 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20986 * Get a value whether map is paused or not.
20988 * @param obj The map object.
20989 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20990 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20992 * This gets the current paused state for the map object.
20994 * @see elm_map_paused_set() for details.
20998 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21001 * Set to show markers during zoom level changes or not.
21003 * @param obj The map object.
21004 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21007 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21010 * The default is off.
21012 * This will stop zooming using animation, changing zoom levels will
21013 * change instantly. This will stop any existing animations that are running.
21015 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21018 * The default is off.
21020 * Enabling it will force the map to stop displaying the markers during
21021 * zoom level changes. Set to on if you have a large number of markers.
21023 * @see elm_map_paused_markers_get()
21027 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21030 * Get a value whether markers will be displayed on zoom level changes or not
21032 * @param obj The map object.
21033 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21034 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21036 * This gets the current markers paused state for the map object.
21038 * @see elm_map_paused_markers_set() for details.
21042 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21045 * Get the information of downloading status.
21047 * @param obj The map object.
21048 * @param try_num Pointer where to store number of tiles being downloaded.
21049 * @param finish_num Pointer where to store number of tiles successfully
21052 * This gets the current downloading status for the map object, the number
21053 * of tiles being downloaded and the number of tiles already downloaded.
21057 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21060 * Convert a pixel coordinate (x,y) into a geographic coordinate
21061 * (longitude, latitude).
21063 * @param obj The map object.
21064 * @param x the coordinate.
21065 * @param y the coordinate.
21066 * @param size the size in pixels of the map.
21067 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21068 * @param lon Pointer where to store the longitude that correspond to x.
21069 * @param lat Pointer where to store the latitude that correspond to y.
21071 * @note Origin pixel point is the top left corner of the viewport.
21072 * Map zoom and size are taken on account.
21074 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21078 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);
21081 * Convert a geographic coordinate (longitude, latitude) into a pixel
21082 * coordinate (x, y).
21084 * @param obj The map object.
21085 * @param lon the longitude.
21086 * @param lat the latitude.
21087 * @param size the size in pixels of the map. The map is a square
21088 * and generally his size is : pow(2.0, zoom)*256.
21089 * @param x Pointer where to store the horizontal pixel coordinate that
21090 * correspond to the longitude.
21091 * @param y Pointer where to store the vertical pixel coordinate that
21092 * correspond to the latitude.
21094 * @note Origin pixel point is the top left corner of the viewport.
21095 * Map zoom and size are taken on account.
21097 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21101 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);
21104 * Convert a geographic coordinate (longitude, latitude) into a name
21107 * @param obj The map object.
21108 * @param lon the longitude.
21109 * @param lat the latitude.
21110 * @return name A #Elm_Map_Name handle for this coordinate.
21112 * To get the string for this address, elm_map_name_address_get()
21115 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21119 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21122 * Convert a name (address) into a geographic coordinate
21123 * (longitude, latitude).
21125 * @param obj The map object.
21126 * @param name The address.
21127 * @return name A #Elm_Map_Name handle for this address.
21129 * To get the longitude and latitude, elm_map_name_region_get()
21132 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21136 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21139 * Convert a pixel coordinate into a rotated pixel coordinate.
21141 * @param obj The map object.
21142 * @param x horizontal coordinate of the point to rotate.
21143 * @param y vertical coordinate of the point to rotate.
21144 * @param cx rotation's center horizontal position.
21145 * @param cy rotation's center vertical position.
21146 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21147 * @param xx Pointer where to store rotated x.
21148 * @param yy Pointer where to store rotated y.
21152 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);
21155 * Add a new marker to the map object.
21157 * @param obj The map object.
21158 * @param lon The longitude of the marker.
21159 * @param lat The latitude of the marker.
21160 * @param clas The class, to use when marker @b isn't grouped to others.
21161 * @param clas_group The class group, to use when marker is grouped to others
21162 * @param data The data passed to the callbacks.
21164 * @return The created marker or @c NULL upon failure.
21166 * A marker will be created and shown in a specific point of the map, defined
21167 * by @p lon and @p lat.
21169 * It will be displayed using style defined by @p class when this marker
21170 * is displayed alone (not grouped). A new class can be created with
21171 * elm_map_marker_class_new().
21173 * If the marker is grouped to other markers, it will be displayed with
21174 * style defined by @p class_group. Markers with the same group are grouped
21175 * if they are close. A new group class can be created with
21176 * elm_map_marker_group_class_new().
21178 * Markers created with this method can be deleted with
21179 * elm_map_marker_remove().
21181 * A marker can have associated content to be displayed by a bubble,
21182 * when a user click over it, as well as an icon. These objects will
21183 * be fetch using class' callback functions.
21185 * @see elm_map_marker_class_new()
21186 * @see elm_map_marker_group_class_new()
21187 * @see elm_map_marker_remove()
21191 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);
21194 * Set the maximum numbers of markers' content to be displayed in a group.
21196 * @param obj The map object.
21197 * @param max The maximum numbers of items displayed in a bubble.
21199 * A bubble will be displayed when the user clicks over the group,
21200 * and will place the content of markers that belong to this group
21203 * A group can have a long list of markers, consequently the creation
21204 * of the content of the bubble can be very slow.
21206 * In order to avoid this, a maximum number of items is displayed
21209 * By default this number is 30.
21211 * Marker with the same group class are grouped if they are close.
21213 * @see elm_map_marker_add()
21217 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21220 * Remove a marker from the map.
21222 * @param marker The marker to remove.
21224 * @see elm_map_marker_add()
21228 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21231 * Get the current coordinates of the marker.
21233 * @param marker marker.
21234 * @param lat Pointer where to store the marker's latitude.
21235 * @param lon Pointer where to store the marker's longitude.
21237 * These values are set when adding markers, with function
21238 * elm_map_marker_add().
21240 * @see elm_map_marker_add()
21244 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21247 * Animatedly bring in given marker to the center of the map.
21249 * @param marker The marker to center at.
21251 * This causes map to jump to the given @p marker's coordinates
21252 * and show it (by scrolling) in the center of the viewport, if it is not
21253 * already centered. This will use animation to do so and take a period
21254 * of time to complete.
21256 * @see elm_map_marker_show() for a function to avoid animation.
21257 * @see elm_map_marker_region_get()
21261 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21264 * Show the given marker at the center of the map, @b immediately.
21266 * @param marker The marker to center at.
21268 * This causes map to @b redraw its viewport's contents to the
21269 * region contining the given @p marker's coordinates, that will be
21270 * moved to the center of the map.
21272 * @see elm_map_marker_bring_in() for a function to move with animation.
21273 * @see elm_map_markers_list_show() if more than one marker need to be
21275 * @see elm_map_marker_region_get()
21279 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21282 * Move and zoom the map to display a list of markers.
21284 * @param markers A list of #Elm_Map_Marker handles.
21286 * The map will be centered on the center point of the markers in the list.
21287 * Then the map will be zoomed in order to fit the markers using the maximum
21288 * zoom which allows display of all the markers.
21290 * @warning All the markers should belong to the same map object.
21292 * @see elm_map_marker_show() to show a single marker.
21293 * @see elm_map_marker_bring_in()
21297 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21300 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21302 * @param marker The marker wich content should be returned.
21303 * @return Return the evas object if it exists, else @c NULL.
21305 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21306 * elm_map_marker_class_get_cb_set() should be used.
21308 * This content is what will be inside the bubble that will be displayed
21309 * when an user clicks over the marker.
21311 * This returns the actual Evas object used to be placed inside
21312 * the bubble. This may be @c NULL, as it may
21313 * not have been created or may have been deleted, at any time, by
21314 * the map. <b>Do not modify this object</b> (move, resize,
21315 * show, hide, etc.), as the map is controlling it. This
21316 * function is for querying, emitting custom signals or hooking
21317 * lower level callbacks for events on that object. Do not delete
21318 * this object under any circumstances.
21322 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21325 * Update the marker
21327 * @param marker The marker to be updated.
21329 * If a content is set to this marker, it will call function to delete it,
21330 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21331 * #ElmMapMarkerGetFunc.
21333 * These functions are set for the marker class with
21334 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21338 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21341 * Close all the bubbles opened by the user.
21343 * @param obj The map object.
21345 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21346 * when the user clicks on a marker.
21348 * This functions is set for the marker class with
21349 * elm_map_marker_class_get_cb_set().
21353 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21356 * Create a new group class.
21358 * @param obj The map object.
21359 * @return Returns the new group class.
21361 * Each marker must be associated to a group class. Markers in the same
21362 * group are grouped if they are close.
21364 * The group class defines the style of the marker when a marker is grouped
21365 * to others markers. When it is alone, another class will be used.
21367 * A group class will need to be provided when creating a marker with
21368 * elm_map_marker_add().
21370 * Some properties and functions can be set by class, as:
21371 * - style, with elm_map_group_class_style_set()
21372 * - data - to be associated to the group class. It can be set using
21373 * elm_map_group_class_data_set().
21374 * - min zoom to display markers, set with
21375 * elm_map_group_class_zoom_displayed_set().
21376 * - max zoom to group markers, set using
21377 * elm_map_group_class_zoom_grouped_set().
21378 * - visibility - set if markers will be visible or not, set with
21379 * elm_map_group_class_hide_set().
21380 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21381 * It can be set using elm_map_group_class_icon_cb_set().
21383 * @see elm_map_marker_add()
21384 * @see elm_map_group_class_style_set()
21385 * @see elm_map_group_class_data_set()
21386 * @see elm_map_group_class_zoom_displayed_set()
21387 * @see elm_map_group_class_zoom_grouped_set()
21388 * @see elm_map_group_class_hide_set()
21389 * @see elm_map_group_class_icon_cb_set()
21393 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21396 * Set the marker's style of a group class.
21398 * @param clas The group class.
21399 * @param style The style to be used by markers.
21401 * Each marker must be associated to a group class, and will use the style
21402 * defined by such class when grouped to other markers.
21404 * The following styles are provided by default theme:
21405 * @li @c radio - blue circle
21406 * @li @c radio2 - green circle
21409 * @see elm_map_group_class_new() for more details.
21410 * @see elm_map_marker_add()
21414 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21417 * Set the icon callback function of a group class.
21419 * @param clas The group class.
21420 * @param icon_get The callback function that will return the icon.
21422 * Each marker must be associated to a group class, and it can display a
21423 * custom icon. The function @p icon_get must return this icon.
21425 * @see elm_map_group_class_new() for more details.
21426 * @see elm_map_marker_add()
21430 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21433 * Set the data associated to the group class.
21435 * @param clas The group class.
21436 * @param data The new user data.
21438 * This data will be passed for callback functions, like icon get callback,
21439 * that can be set with elm_map_group_class_icon_cb_set().
21441 * If a data was previously set, the object will lose the pointer for it,
21442 * so if needs to be freed, you must do it yourself.
21444 * @see elm_map_group_class_new() for more details.
21445 * @see elm_map_group_class_icon_cb_set()
21446 * @see elm_map_marker_add()
21450 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21453 * Set the minimum zoom from where the markers are displayed.
21455 * @param clas The group class.
21456 * @param zoom The minimum zoom.
21458 * Markers only will be displayed when the map is displayed at @p zoom
21461 * @see elm_map_group_class_new() for more details.
21462 * @see elm_map_marker_add()
21466 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21469 * Set the zoom from where the markers are no more grouped.
21471 * @param clas The group class.
21472 * @param zoom The maximum zoom.
21474 * Markers only will be grouped when the map is displayed at
21475 * less than @p zoom.
21477 * @see elm_map_group_class_new() for more details.
21478 * @see elm_map_marker_add()
21482 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21485 * Set if the markers associated to the group class @clas are hidden or not.
21487 * @param clas The group class.
21488 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21491 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21496 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21499 * Create a new marker class.
21501 * @param obj The map object.
21502 * @return Returns the new group class.
21504 * Each marker must be associated to a class.
21506 * The marker class defines the style of the marker when a marker is
21507 * displayed alone, i.e., not grouped to to others markers. When grouped
21508 * it will use group class style.
21510 * A marker class will need to be provided when creating a marker with
21511 * elm_map_marker_add().
21513 * Some properties and functions can be set by class, as:
21514 * - style, with elm_map_marker_class_style_set()
21515 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21516 * It can be set using elm_map_marker_class_icon_cb_set().
21517 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21518 * Set using elm_map_marker_class_get_cb_set().
21519 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21520 * Set using elm_map_marker_class_del_cb_set().
21522 * @see elm_map_marker_add()
21523 * @see elm_map_marker_class_style_set()
21524 * @see elm_map_marker_class_icon_cb_set()
21525 * @see elm_map_marker_class_get_cb_set()
21526 * @see elm_map_marker_class_del_cb_set()
21530 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21533 * Set the marker's style of a marker class.
21535 * @param clas The marker class.
21536 * @param style The style to be used by markers.
21538 * Each marker must be associated to a marker class, and will use the style
21539 * defined by such class when alone, i.e., @b not grouped to other markers.
21541 * The following styles are provided by default theme:
21546 * @see elm_map_marker_class_new() for more details.
21547 * @see elm_map_marker_add()
21551 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21554 * Set the icon callback function of a marker class.
21556 * @param clas The marker class.
21557 * @param icon_get The callback function that will return the icon.
21559 * Each marker must be associated to a marker class, and it can display a
21560 * custom icon. The function @p icon_get must return this icon.
21562 * @see elm_map_marker_class_new() for more details.
21563 * @see elm_map_marker_add()
21567 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21570 * Set the bubble content callback function of a marker class.
21572 * @param clas The marker class.
21573 * @param get The callback function that will return the content.
21575 * Each marker must be associated to a marker class, and it can display a
21576 * a content on a bubble that opens when the user click over the marker.
21577 * The function @p get must return this content object.
21579 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21582 * @see elm_map_marker_class_new() for more details.
21583 * @see elm_map_marker_class_del_cb_set()
21584 * @see elm_map_marker_add()
21588 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21591 * Set the callback function used to delete bubble content of a marker class.
21593 * @param clas The marker class.
21594 * @param del The callback function that will delete the content.
21596 * Each marker must be associated to a marker class, and it can display a
21597 * a content on a bubble that opens when the user click over the marker.
21598 * The function to return such content can be set with
21599 * elm_map_marker_class_get_cb_set().
21601 * If this content must be freed, a callback function need to be
21602 * set for that task with this function.
21604 * If this callback is defined it will have to delete (or not) the
21605 * object inside, but if the callback is not defined the object will be
21606 * destroyed with evas_object_del().
21608 * @see elm_map_marker_class_new() for more details.
21609 * @see elm_map_marker_class_get_cb_set()
21610 * @see elm_map_marker_add()
21614 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21617 * Get the list of available sources.
21619 * @param obj The map object.
21620 * @return The source names list.
21622 * It will provide a list with all available sources, that can be set as
21623 * current source with elm_map_source_name_set(), or get with
21624 * elm_map_source_name_get().
21626 * Available sources:
21632 * @see elm_map_source_name_set() for more details.
21633 * @see elm_map_source_name_get()
21637 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21640 * Set the source of the map.
21642 * @param obj The map object.
21643 * @param source The source to be used.
21645 * Map widget retrieves images that composes the map from a web service.
21646 * This web service can be set with this method.
21648 * A different service can return a different maps with different
21649 * information and it can use different zoom values.
21651 * The @p source_name need to match one of the names provided by
21652 * elm_map_source_names_get().
21654 * The current source can be get using elm_map_source_name_get().
21656 * @see elm_map_source_names_get()
21657 * @see elm_map_source_name_get()
21662 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21665 * Get the name of currently used source.
21667 * @param obj The map object.
21668 * @return Returns the name of the source in use.
21670 * @see elm_map_source_name_set() for more details.
21674 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21677 * Set the source of the route service to be used by the map.
21679 * @param obj The map object.
21680 * @param source The route service to be used, being it one of
21681 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21682 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21684 * Each one has its own algorithm, so the route retrieved may
21685 * differ depending on the source route. Now, only the default is working.
21687 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21688 * http://www.yournavigation.org/.
21690 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21691 * assumptions. Its routing core is based on Contraction Hierarchies.
21693 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21695 * @see elm_map_route_source_get().
21699 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21702 * Get the current route source.
21704 * @param obj The map object.
21705 * @return The source of the route service used by the map.
21707 * @see elm_map_route_source_set() for details.
21711 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21714 * Set the minimum zoom of the source.
21716 * @param obj The map object.
21717 * @param zoom New minimum zoom value to be used.
21719 * By default, it's 0.
21723 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21726 * Get the minimum zoom of the source.
21728 * @param obj The map object.
21729 * @return Returns the minimum zoom of the source.
21731 * @see elm_map_source_zoom_min_set() for details.
21735 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21738 * Set the maximum zoom of the source.
21740 * @param obj The map object.
21741 * @param zoom New maximum zoom value to be used.
21743 * By default, it's 18.
21747 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21750 * Get the maximum zoom of the source.
21752 * @param obj The map object.
21753 * @return Returns the maximum zoom of the source.
21755 * @see elm_map_source_zoom_min_set() for details.
21759 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21762 * Set the user agent used by the map object to access routing services.
21764 * @param obj The map object.
21765 * @param user_agent The user agent to be used by the map.
21767 * User agent is a client application implementing a network protocol used
21768 * in communications within a client–server distributed computing system
21770 * The @p user_agent identification string will transmitted in a header
21771 * field @c User-Agent.
21773 * @see elm_map_user_agent_get()
21777 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21780 * Get the user agent used by the map object.
21782 * @param obj The map object.
21783 * @return The user agent identification string used by the map.
21785 * @see elm_map_user_agent_set() for details.
21789 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21792 * Add a new route to the map object.
21794 * @param obj The map object.
21795 * @param type The type of transport to be considered when tracing a route.
21796 * @param method The routing method, what should be priorized.
21797 * @param flon The start longitude.
21798 * @param flat The start latitude.
21799 * @param tlon The destination longitude.
21800 * @param tlat The destination latitude.
21802 * @return The created route or @c NULL upon failure.
21804 * A route will be traced by point on coordinates (@p flat, @p flon)
21805 * to point on coordinates (@p tlat, @p tlon), using the route service
21806 * set with elm_map_route_source_set().
21808 * It will take @p type on consideration to define the route,
21809 * depending if the user will be walking or driving, the route may vary.
21810 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21811 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21813 * Another parameter is what the route should priorize, the minor distance
21814 * or the less time to be spend on the route. So @p method should be one
21815 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21817 * Routes created with this method can be deleted with
21818 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21819 * and distance can be get with elm_map_route_distance_get().
21821 * @see elm_map_route_remove()
21822 * @see elm_map_route_color_set()
21823 * @see elm_map_route_distance_get()
21824 * @see elm_map_route_source_set()
21828 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);
21831 * Remove a route from the map.
21833 * @param route The route to remove.
21835 * @see elm_map_route_add()
21839 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21842 * Set the route color.
21844 * @param route The route object.
21845 * @param r Red channel value, from 0 to 255.
21846 * @param g Green channel value, from 0 to 255.
21847 * @param b Blue channel value, from 0 to 255.
21848 * @param a Alpha channel value, from 0 to 255.
21850 * It uses an additive color model, so each color channel represents
21851 * how much of each primary colors must to be used. 0 represents
21852 * ausence of this color, so if all of the three are set to 0,
21853 * the color will be black.
21855 * These component values should be integers in the range 0 to 255,
21856 * (single 8-bit byte).
21858 * This sets the color used for the route. By default, it is set to
21859 * solid red (r = 255, g = 0, b = 0, a = 255).
21861 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21863 * @see elm_map_route_color_get()
21867 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21870 * Get the route color.
21872 * @param route The route object.
21873 * @param r Pointer where to store the red channel value.
21874 * @param g Pointer where to store the green channel value.
21875 * @param b Pointer where to store the blue channel value.
21876 * @param a Pointer where to store the alpha channel value.
21878 * @see elm_map_route_color_set() for details.
21882 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21885 * Get the route distance in kilometers.
21887 * @param route The route object.
21888 * @return The distance of route (unit : km).
21892 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21895 * Get the information of route nodes.
21897 * @param route The route object.
21898 * @return Returns a string with the nodes of route.
21902 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21905 * Get the information of route waypoint.
21907 * @param route the route object.
21908 * @return Returns a string with information about waypoint of route.
21912 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21915 * Get the address of the name.
21917 * @param name The name handle.
21918 * @return Returns the address string of @p name.
21920 * This gets the coordinates of the @p name, created with one of the
21921 * conversion functions.
21923 * @see elm_map_utils_convert_name_into_coord()
21924 * @see elm_map_utils_convert_coord_into_name()
21928 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21931 * Get the current coordinates of the name.
21933 * @param name The name handle.
21934 * @param lat Pointer where to store the latitude.
21935 * @param lon Pointer where to store The longitude.
21937 * This gets the coordinates of the @p name, created with one of the
21938 * conversion functions.
21940 * @see elm_map_utils_convert_name_into_coord()
21941 * @see elm_map_utils_convert_coord_into_name()
21945 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21948 * Remove a name from the map.
21950 * @param name The name to remove.
21952 * Basically the struct handled by @p name will be freed, so convertions
21953 * between address and coordinates will be lost.
21955 * @see elm_map_utils_convert_name_into_coord()
21956 * @see elm_map_utils_convert_coord_into_name()
21960 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21965 * @param obj The map object.
21966 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21967 * @param cx Rotation's center horizontal position.
21968 * @param cy Rotation's center vertical position.
21970 * @see elm_map_rotate_get()
21974 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21977 * Get the rotate degree of the map
21979 * @param obj The map object
21980 * @param degree Pointer where to store degrees from 0.0 to 360.0
21981 * to rotate arount Z axis.
21982 * @param cx Pointer where to store rotation's center horizontal position.
21983 * @param cy Pointer where to store rotation's center vertical position.
21985 * @see elm_map_rotate_set() to set map rotation.
21989 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);
21992 * Enable or disable mouse wheel to be used to zoom in / out the map.
21994 * @param obj The map object.
21995 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21998 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22000 * It's disabled by default.
22002 * @see elm_map_wheel_disabled_get()
22006 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22009 * Get a value whether mouse wheel is enabled or not.
22011 * @param obj The map object.
22012 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22013 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22015 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22017 * @see elm_map_wheel_disabled_set() for details.
22021 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22025 * Add a track on the map
22027 * @param obj The map object.
22028 * @param emap The emap route object.
22029 * @return The route object. This is an elm object of type Route.
22031 * @see elm_route_add() for details.
22035 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22039 * Remove a track from the map
22041 * @param obj The map object.
22042 * @param route The track to remove.
22046 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22053 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22055 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22057 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22058 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22059 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22060 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22064 * @defgroup Panel Panel
22066 * @image html img/widget/panel/preview-00.png
22067 * @image latex img/widget/panel/preview-00.eps
22069 * @brief A panel is a type of animated container that contains subobjects.
22070 * It can be expanded or contracted by clicking the button on it's edge.
22072 * Orientations are as follows:
22073 * @li ELM_PANEL_ORIENT_TOP
22074 * @li ELM_PANEL_ORIENT_LEFT
22075 * @li ELM_PANEL_ORIENT_RIGHT
22077 * @ref tutorial_panel shows one way to use this widget.
22080 typedef enum _Elm_Panel_Orient
22082 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22083 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22084 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22085 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22086 } Elm_Panel_Orient;
22088 * @brief Adds a panel object
22090 * @param parent The parent object
22092 * @return The panel object, or NULL on failure
22094 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22096 * @brief Sets the orientation of the panel
22098 * @param parent The parent object
22099 * @param orient The panel orientation. Can be one of the following:
22100 * @li ELM_PANEL_ORIENT_TOP
22101 * @li ELM_PANEL_ORIENT_LEFT
22102 * @li ELM_PANEL_ORIENT_RIGHT
22104 * Sets from where the panel will (dis)appear.
22106 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22108 * @brief Get the orientation of the panel.
22110 * @param obj The panel object
22111 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22113 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22115 * @brief Set the content of the panel.
22117 * @param obj The panel object
22118 * @param content The panel content
22120 * Once the content object is set, a previously set one will be deleted.
22121 * If you want to keep that old content object, use the
22122 * elm_panel_content_unset() function.
22124 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22126 * @brief Get the content of the panel.
22128 * @param obj The panel object
22129 * @return The content that is being used
22131 * Return the content object which is set for this widget.
22133 * @see elm_panel_content_set()
22135 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22137 * @brief Unset the content of the panel.
22139 * @param obj The panel object
22140 * @return The content that was being used
22142 * Unparent and return the content object which was set for this widget.
22144 * @see elm_panel_content_set()
22146 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22148 * @brief Set the state of the panel.
22150 * @param obj The panel object
22151 * @param hidden If true, the panel will run the animation to contract
22153 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22155 * @brief Get the state of the panel.
22157 * @param obj The panel object
22158 * @param hidden If true, the panel is in the "hide" state
22160 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22162 * @brief Toggle the hidden state of the panel from code
22164 * @param obj The panel object
22166 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22172 * @defgroup Panes Panes
22173 * @ingroup Elementary
22175 * @image html img/widget/panes/preview-00.png
22176 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22178 * @image html img/panes.png
22179 * @image latex img/panes.eps width=\textwidth
22181 * The panes adds a dragable bar between two contents. When dragged
22182 * this bar will resize contents size.
22184 * Panes can be displayed vertically or horizontally, and contents
22185 * size proportion can be customized (homogeneous by default).
22187 * Smart callbacks one can listen to:
22188 * - "press" - The panes has been pressed (button wasn't released yet).
22189 * - "unpressed" - The panes was released after being pressed.
22190 * - "clicked" - The panes has been clicked>
22191 * - "clicked,double" - The panes has been double clicked
22193 * Available styles for it:
22196 * Here is an example on its usage:
22197 * @li @ref panes_example
22201 * @addtogroup Panes
22206 * Add a new panes widget to the given parent Elementary
22207 * (container) object.
22209 * @param parent The parent object.
22210 * @return a new panes widget handle or @c NULL, on errors.
22212 * This function inserts a new panes widget on the canvas.
22216 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22219 * Set the left content of the panes widget.
22221 * @param obj The panes object.
22222 * @param content The new left content object.
22224 * Once the content object is set, a previously set one will be deleted.
22225 * If you want to keep that old content object, use the
22226 * elm_panes_content_left_unset() function.
22228 * If panes is displayed vertically, left content will be displayed at
22231 * @see elm_panes_content_left_get()
22232 * @see elm_panes_content_right_set() to set content on the other side.
22236 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22239 * Set the right content of the panes widget.
22241 * @param obj The panes object.
22242 * @param content The new right content object.
22244 * Once the content object is set, a previously set one will be deleted.
22245 * If you want to keep that old content object, use the
22246 * elm_panes_content_right_unset() function.
22248 * If panes is displayed vertically, left content will be displayed at
22251 * @see elm_panes_content_right_get()
22252 * @see elm_panes_content_left_set() to set content on the other side.
22256 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22259 * Get the left content of the panes.
22261 * @param obj The panes object.
22262 * @return The left content object that is being used.
22264 * Return the left content object which is set for this widget.
22266 * @see elm_panes_content_left_set() for details.
22270 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22273 * Get the right content of the panes.
22275 * @param obj The panes object
22276 * @return The right content object that is being used
22278 * Return the right content object which is set for this widget.
22280 * @see elm_panes_content_right_set() for details.
22284 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22287 * Unset the left content used for the panes.
22289 * @param obj The panes object.
22290 * @return The left content object that was being used.
22292 * Unparent and return the left content object which was set for this widget.
22294 * @see elm_panes_content_left_set() for details.
22295 * @see elm_panes_content_left_get().
22299 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22302 * Unset the right content used for the panes.
22304 * @param obj The panes object.
22305 * @return The right content object that was being used.
22307 * Unparent and return the right content object which was set for this
22310 * @see elm_panes_content_right_set() for details.
22311 * @see elm_panes_content_right_get().
22315 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22318 * Get the size proportion of panes widget's left side.
22320 * @param obj The panes object.
22321 * @return float value between 0.0 and 1.0 representing size proportion
22324 * @see elm_panes_content_left_size_set() for more details.
22328 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22331 * Set the size proportion of panes widget's left side.
22333 * @param obj The panes object.
22334 * @param size Value between 0.0 and 1.0 representing size proportion
22337 * By default it's homogeneous, i.e., both sides have the same size.
22339 * If something different is required, it can be set with this function.
22340 * For example, if the left content should be displayed over
22341 * 75% of the panes size, @p size should be passed as @c 0.75.
22342 * This way, right content will be resized to 25% of panes size.
22344 * If displayed vertically, left content is displayed at top, and
22345 * right content at bottom.
22347 * @note This proportion will change when user drags the panes bar.
22349 * @see elm_panes_content_left_size_get()
22353 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22356 * Set the orientation of a given panes widget.
22358 * @param obj The panes object.
22359 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22360 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22362 * Use this function to change how your panes is to be
22363 * disposed: vertically or horizontally.
22365 * By default it's displayed horizontally.
22367 * @see elm_panes_horizontal_get()
22371 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22374 * Retrieve the orientation of a given panes widget.
22376 * @param obj The panes object.
22377 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22378 * @c EINA_FALSE if it's @b vertical (and on errors).
22380 * @see elm_panes_horizontal_set() for more details.
22384 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22391 * @defgroup Flip Flip
22393 * @image html img/widget/flip/preview-00.png
22394 * @image latex img/widget/flip/preview-00.eps
22396 * This widget holds 2 content objects(Evas_Object): one on the front and one
22397 * on the back. It allows you to flip from front to back and vice-versa using
22398 * various animations.
22400 * If either the front or back contents are not set the flip will treat that
22401 * as transparent. So if you wore to set the front content but not the back,
22402 * and then call elm_flip_go() you would see whatever is below the flip.
22404 * For a list of supported animations see elm_flip_go().
22406 * Signals that you can add callbacks for are:
22407 * "animate,begin" - when a flip animation was started
22408 * "animate,done" - when a flip animation is finished
22410 * @ref tutorial_flip show how to use most of the API.
22414 typedef enum _Elm_Flip_Mode
22416 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22417 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22418 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22419 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22420 ELM_FLIP_CUBE_LEFT,
22421 ELM_FLIP_CUBE_RIGHT,
22423 ELM_FLIP_CUBE_DOWN,
22424 ELM_FLIP_PAGE_LEFT,
22425 ELM_FLIP_PAGE_RIGHT,
22429 typedef enum _Elm_Flip_Interaction
22431 ELM_FLIP_INTERACTION_NONE,
22432 ELM_FLIP_INTERACTION_ROTATE,
22433 ELM_FLIP_INTERACTION_CUBE,
22434 ELM_FLIP_INTERACTION_PAGE
22435 } Elm_Flip_Interaction;
22436 typedef enum _Elm_Flip_Direction
22438 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22439 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22440 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22441 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22442 } Elm_Flip_Direction;
22444 * @brief Add a new flip to the parent
22446 * @param parent The parent object
22447 * @return The new object or NULL if it cannot be created
22449 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22451 * @brief Set the front content of the flip widget.
22453 * @param obj The flip object
22454 * @param content The new front content object
22456 * Once the content object is set, a previously set one will be deleted.
22457 * If you want to keep that old content object, use the
22458 * elm_flip_content_front_unset() function.
22460 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22462 * @brief Set the back content of the flip widget.
22464 * @param obj The flip object
22465 * @param content The new back content object
22467 * Once the content object is set, a previously set one will be deleted.
22468 * If you want to keep that old content object, use the
22469 * elm_flip_content_back_unset() function.
22471 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22473 * @brief Get the front content used for the flip
22475 * @param obj The flip object
22476 * @return The front content object that is being used
22478 * Return the front content object which is set for this widget.
22480 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22482 * @brief Get the back content used for the flip
22484 * @param obj The flip object
22485 * @return The back content object that is being used
22487 * Return the back content object which is set for this widget.
22489 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22491 * @brief Unset the front content used for the flip
22493 * @param obj The flip object
22494 * @return The front content object that was being used
22496 * Unparent and return the front content object which was set for this widget.
22498 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22500 * @brief Unset the back content used for the flip
22502 * @param obj The flip object
22503 * @return The back content object that was being used
22505 * Unparent and return the back content object which was set for this widget.
22507 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22509 * @brief Get flip front visibility state
22511 * @param obj The flip objct
22512 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22515 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22517 * @brief Set flip perspective
22519 * @param obj The flip object
22520 * @param foc The coordinate to set the focus on
22521 * @param x The X coordinate
22522 * @param y The Y coordinate
22524 * @warning This function currently does nothing.
22526 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22528 * @brief Runs the flip animation
22530 * @param obj The flip object
22531 * @param mode The mode type
22533 * Flips the front and back contents using the @p mode animation. This
22534 * efectively hides the currently visible content and shows the hidden one.
22536 * There a number of possible animations to use for the flipping:
22537 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22538 * around a horizontal axis in the middle of its height, the other content
22539 * is shown as the other side of the flip.
22540 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22541 * around a vertical axis in the middle of its width, the other content is
22542 * shown as the other side of the flip.
22543 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22544 * around a diagonal axis in the middle of its width, the other content is
22545 * shown as the other side of the flip.
22546 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22547 * around a diagonal axis in the middle of its height, the other content is
22548 * shown as the other side of the flip.
22549 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22550 * as if the flip was a cube, the other content is show as the right face of
22552 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22553 * right as if the flip was a cube, the other content is show as the left
22554 * face of the cube.
22555 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22556 * flip was a cube, the other content is show as the bottom face of the cube.
22557 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22558 * the flip was a cube, the other content is show as the upper face of the
22560 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22561 * if the flip was a book, the other content is shown as the page below that.
22562 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22563 * as if the flip was a book, the other content is shown as the page below
22565 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22566 * flip was a book, the other content is shown as the page below that.
22567 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22568 * flip was a book, the other content is shown as the page below that.
22570 * @image html elm_flip.png
22571 * @image latex elm_flip.eps width=\textwidth
22573 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22575 * @brief Set the interactive flip mode
22577 * @param obj The flip object
22578 * @param mode The interactive flip mode to use
22580 * This sets if the flip should be interactive (allow user to click and
22581 * drag a side of the flip to reveal the back page and cause it to flip).
22582 * By default a flip is not interactive. You may also need to set which
22583 * sides of the flip are "active" for flipping and how much space they use
22584 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22585 * and elm_flip_interacton_direction_hitsize_set()
22587 * The four avilable mode of interaction are:
22588 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22589 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22590 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22591 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22593 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22594 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22595 * happen, those can only be acheived with elm_flip_go();
22597 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22599 * @brief Get the interactive flip mode
22601 * @param obj The flip object
22602 * @return The interactive flip mode
22604 * Returns the interactive flip mode set by elm_flip_interaction_set()
22606 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22608 * @brief Set which directions of the flip respond to interactive flip
22610 * @param obj The flip object
22611 * @param dir The direction to change
22612 * @param enabled If that direction is enabled or not
22614 * By default all directions are disabled, so you may want to enable the
22615 * desired directions for flipping if you need interactive flipping. You must
22616 * call this function once for each direction that should be enabled.
22618 * @see elm_flip_interaction_set()
22620 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22622 * @brief Get the enabled state of that flip direction
22624 * @param obj The flip object
22625 * @param dir The direction to check
22626 * @return If that direction is enabled or not
22628 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22630 * @see elm_flip_interaction_set()
22632 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22634 * @brief Set the amount of the flip that is sensitive to interactive flip
22636 * @param obj The flip object
22637 * @param dir The direction to modify
22638 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22640 * Set the amount of the flip that is sensitive to interactive flip, with 0
22641 * representing no area in the flip and 1 representing the entire flip. There
22642 * is however a consideration to be made in that the area will never be
22643 * smaller than the finger size set(as set in your Elementary configuration).
22645 * @see elm_flip_interaction_set()
22647 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22649 * @brief Get the amount of the flip that is sensitive to interactive flip
22651 * @param obj The flip object
22652 * @param dir The direction to check
22653 * @return The size set for that direction
22655 * Returns the amount os sensitive area set by
22656 * elm_flip_interacton_direction_hitsize_set().
22658 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22663 /* scrolledentry */
22664 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22665 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22666 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22667 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22668 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22669 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22670 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22671 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22672 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22673 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22674 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22675 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22676 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22677 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22678 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22679 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22680 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22681 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22682 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22683 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22684 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22685 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22686 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22687 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22688 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22689 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22690 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22691 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22692 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22693 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22694 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22695 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22696 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22697 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22698 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22699 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);
22700 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22701 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22702 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);
22703 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22704 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);
22705 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22706 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22707 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22708 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22709 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22710 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22711 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22712 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22713 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);
22714 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);
22715 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);
22716 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);
22717 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);
22718 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);
22719 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22720 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22721 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22722 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22723 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22724 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22725 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22728 * @defgroup Conformant Conformant
22729 * @ingroup Elementary
22731 * @image html img/widget/conformant/preview-00.png
22732 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22734 * @image html img/conformant.png
22735 * @image latex img/conformant.eps width=\textwidth
22737 * The aim is to provide a widget that can be used in elementary apps to
22738 * account for space taken up by the indicator, virtual keypad & softkey
22739 * windows when running the illume2 module of E17.
22741 * So conformant content will be sized and positioned considering the
22742 * space required for such stuff, and when they popup, as a keyboard
22743 * shows when an entry is selected, conformant content won't change.
22745 * Available styles for it:
22748 * See how to use this widget in this example:
22749 * @ref conformant_example
22753 * @addtogroup Conformant
22758 * Add a new conformant widget to the given parent Elementary
22759 * (container) object.
22761 * @param parent The parent object.
22762 * @return A new conformant widget handle or @c NULL, on errors.
22764 * This function inserts a new conformant widget on the canvas.
22766 * @ingroup Conformant
22768 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22771 * Set the content of the conformant widget.
22773 * @param obj The conformant object.
22774 * @param content The content to be displayed by the conformant.
22776 * Content will be sized and positioned considering the space required
22777 * to display a virtual keyboard. So it won't fill all the conformant
22778 * size. This way is possible to be sure that content won't resize
22779 * or be re-positioned after the keyboard is displayed.
22781 * Once the content object is set, a previously set one will be deleted.
22782 * If you want to keep that old content object, use the
22783 * elm_conformat_content_unset() function.
22785 * @see elm_conformant_content_unset()
22786 * @see elm_conformant_content_get()
22788 * @ingroup Conformant
22790 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22793 * Get the content of the conformant widget.
22795 * @param obj The conformant object.
22796 * @return The content that is being used.
22798 * Return the content object which is set for this widget.
22799 * It won't be unparent from conformant. For that, use
22800 * elm_conformant_content_unset().
22802 * @see elm_conformant_content_set() for more details.
22803 * @see elm_conformant_content_unset()
22805 * @ingroup Conformant
22807 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22810 * Unset the content of the conformant widget.
22812 * @param obj The conformant object.
22813 * @return The content that was being used.
22815 * Unparent and return the content object which was set for this widget.
22817 * @see elm_conformant_content_set() for more details.
22819 * @ingroup Conformant
22821 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 * Returns the Evas_Object that represents the content area.
22826 * @param obj The conformant object.
22827 * @return The content area of the widget.
22829 * @ingroup Conformant
22831 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22838 * @defgroup Mapbuf Mapbuf
22839 * @ingroup Elementary
22841 * @image html img/widget/mapbuf/preview-00.png
22842 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22844 * This holds one content object and uses an Evas Map of transformation
22845 * points to be later used with this content. So the content will be
22846 * moved, resized, etc as a single image. So it will improve performance
22847 * when you have a complex interafce, with a lot of elements, and will
22848 * need to resize or move it frequently (the content object and its
22851 * See how to use this widget in this example:
22852 * @ref mapbuf_example
22856 * @addtogroup Mapbuf
22861 * Add a new mapbuf widget to the given parent Elementary
22862 * (container) object.
22864 * @param parent The parent object.
22865 * @return A new mapbuf widget handle or @c NULL, on errors.
22867 * This function inserts a new mapbuf widget on the canvas.
22871 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22874 * Set the content of the mapbuf.
22876 * @param obj The mapbuf object.
22877 * @param content The content that will be filled in this mapbuf object.
22879 * Once the content object is set, a previously set one will be deleted.
22880 * If you want to keep that old content object, use the
22881 * elm_mapbuf_content_unset() function.
22883 * To enable map, elm_mapbuf_enabled_set() should be used.
22887 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22890 * Get the content of the mapbuf.
22892 * @param obj The mapbuf object.
22893 * @return The content that is being used.
22895 * Return the content object which is set for this widget.
22897 * @see elm_mapbuf_content_set() for details.
22901 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22904 * Unset the content of the mapbuf.
22906 * @param obj The mapbuf object.
22907 * @return The content that was being used.
22909 * Unparent and return the content object which was set for this widget.
22911 * @see elm_mapbuf_content_set() for details.
22915 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22918 * Enable or disable the map.
22920 * @param obj The mapbuf object.
22921 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22923 * This enables the map that is set or disables it. On enable, the object
22924 * geometry will be saved, and the new geometry will change (position and
22925 * size) to reflect the map geometry set.
22927 * Also, when enabled, alpha and smooth states will be used, so if the
22928 * content isn't solid, alpha should be enabled, for example, otherwise
22929 * a black retangle will fill the content.
22931 * When disabled, the stored map will be freed and geometry prior to
22932 * enabling the map will be restored.
22934 * It's disabled by default.
22936 * @see elm_mapbuf_alpha_set()
22937 * @see elm_mapbuf_smooth_set()
22941 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22944 * Get a value whether map is enabled or not.
22946 * @param obj The mapbuf object.
22947 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22948 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22950 * @see elm_mapbuf_enabled_set() for details.
22954 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22957 * Enable or disable smooth map rendering.
22959 * @param obj The mapbuf object.
22960 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22963 * This sets smoothing for map rendering. If the object is a type that has
22964 * its own smoothing settings, then both the smooth settings for this object
22965 * and the map must be turned off.
22967 * By default smooth maps are enabled.
22971 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22974 * Get a value whether smooth map rendering is enabled or not.
22976 * @param obj The mapbuf object.
22977 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22978 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22980 * @see elm_mapbuf_smooth_set() for details.
22984 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22987 * Set or unset alpha flag for map rendering.
22989 * @param obj The mapbuf object.
22990 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22993 * This sets alpha flag for map rendering. If the object is a type that has
22994 * its own alpha settings, then this will take precedence. Only image objects
22995 * have this currently. It stops alpha blending of the map area, and is
22996 * useful if you know the object and/or all sub-objects is 100% solid.
22998 * Alpha is enabled by default.
23002 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23005 * Get a value whether alpha blending is enabled or not.
23007 * @param obj The mapbuf object.
23008 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23009 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23011 * @see elm_mapbuf_alpha_set() for details.
23015 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23022 * @defgroup Flipselector Flip Selector
23024 * @image html img/widget/flipselector/preview-00.png
23025 * @image latex img/widget/flipselector/preview-00.eps
23027 * A flip selector is a widget to show a set of @b text items, one
23028 * at a time, with the same sheet switching style as the @ref Clock
23029 * "clock" widget, when one changes the current displaying sheet
23030 * (thus, the "flip" in the name).
23032 * User clicks to flip sheets which are @b held for some time will
23033 * make the flip selector to flip continuosly and automatically for
23034 * the user. The interval between flips will keep growing in time,
23035 * so that it helps the user to reach an item which is distant from
23036 * the current selection.
23038 * Smart callbacks one can register to:
23039 * - @c "selected" - when the widget's selected text item is changed
23040 * - @c "overflowed" - when the widget's current selection is changed
23041 * from the first item in its list to the last
23042 * - @c "underflowed" - when the widget's current selection is changed
23043 * from the last item in its list to the first
23045 * Available styles for it:
23048 * Here is an example on its usage:
23049 * @li @ref flipselector_example
23053 * @addtogroup Flipselector
23057 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23060 * Add a new flip selector widget to the given parent Elementary
23061 * (container) widget
23063 * @param parent The parent object
23064 * @return a new flip selector widget handle or @c NULL, on errors
23066 * This function inserts a new flip selector widget on the canvas.
23068 * @ingroup Flipselector
23070 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23073 * Programmatically select the next item of a flip selector widget
23075 * @param obj The flipselector object
23077 * @note The selection will be animated. Also, if it reaches the
23078 * end of its list of member items, it will continue with the first
23081 * @ingroup Flipselector
23083 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23086 * Programmatically select the previous item of a flip selector
23089 * @param obj The flipselector object
23091 * @note The selection will be animated. Also, if it reaches the
23092 * beginning of its list of member items, it will continue with the
23093 * last one backwards.
23095 * @ingroup Flipselector
23097 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23100 * Append a (text) item to a flip selector widget
23102 * @param obj The flipselector object
23103 * @param label The (text) label of the new item
23104 * @param func Convenience callback function to take place when
23106 * @param data Data passed to @p func, above
23107 * @return A handle to the item added or @c NULL, on errors
23109 * The widget's list of labels to show will be appended with the
23110 * given value. If the user wishes so, a callback function pointer
23111 * can be passed, which will get called when this same item is
23114 * @note The current selection @b won't be modified by appending an
23115 * element to the list.
23117 * @note The maximum length of the text label is going to be
23118 * determined <b>by the widget's theme</b>. Strings larger than
23119 * that value are going to be @b truncated.
23121 * @ingroup Flipselector
23123 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23126 * Prepend a (text) item to a flip selector widget
23128 * @param obj The flipselector object
23129 * @param label The (text) label of the new item
23130 * @param func Convenience callback function to take place when
23132 * @param data Data passed to @p func, above
23133 * @return A handle to the item added or @c NULL, on errors
23135 * The widget's list of labels to show will be prepended with the
23136 * given value. If the user wishes so, a callback function pointer
23137 * can be passed, which will get called when this same item is
23140 * @note The current selection @b won't be modified by prepending
23141 * an element to the list.
23143 * @note The maximum length of the text label is going to be
23144 * determined <b>by the widget's theme</b>. Strings larger than
23145 * that value are going to be @b truncated.
23147 * @ingroup Flipselector
23149 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23152 * Get the internal list of items in a given flip selector widget.
23154 * @param obj The flipselector object
23155 * @return The list of items (#Elm_Flipselector_Item as data) or
23156 * @c NULL on errors.
23158 * This list is @b not to be modified in any way and must not be
23159 * freed. Use the list members with functions like
23160 * elm_flipselector_item_label_set(),
23161 * elm_flipselector_item_label_get(),
23162 * elm_flipselector_item_del(),
23163 * elm_flipselector_item_selected_get(),
23164 * elm_flipselector_item_selected_set().
23166 * @warning This list is only valid until @p obj object's internal
23167 * items list is changed. It should be fetched again with another
23168 * call to this function when changes happen.
23170 * @ingroup Flipselector
23172 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23175 * Get the first item in the given flip selector widget's list of
23178 * @param obj The flipselector object
23179 * @return The first item or @c NULL, if it has no items (and on
23182 * @see elm_flipselector_item_append()
23183 * @see elm_flipselector_last_item_get()
23185 * @ingroup Flipselector
23187 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23190 * Get the last item in the given flip selector widget's list of
23193 * @param obj The flipselector object
23194 * @return The last item or @c NULL, if it has no items (and on
23197 * @see elm_flipselector_item_prepend()
23198 * @see elm_flipselector_first_item_get()
23200 * @ingroup Flipselector
23202 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23205 * Get the currently selected item in a flip selector widget.
23207 * @param obj The flipselector object
23208 * @return The selected item or @c NULL, if the widget has no items
23211 * @ingroup Flipselector
23213 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23216 * Set whether a given flip selector widget's item should be the
23217 * currently selected one.
23219 * @param item The flip selector item
23220 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23222 * This sets whether @p item is or not the selected (thus, under
23223 * display) one. If @p item is different than one under display,
23224 * the latter will be unselected. If the @p item is set to be
23225 * unselected, on the other hand, the @b first item in the widget's
23226 * internal members list will be the new selected one.
23228 * @see elm_flipselector_item_selected_get()
23230 * @ingroup Flipselector
23232 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23235 * Get whether a given flip selector widget's item is the currently
23238 * @param item The flip selector item
23239 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23242 * @see elm_flipselector_item_selected_set()
23244 * @ingroup Flipselector
23246 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23249 * Delete a given item from a flip selector widget.
23251 * @param item The item to delete
23253 * @ingroup Flipselector
23255 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23258 * Get the label of a given flip selector widget's item.
23260 * @param item The item to get label from
23261 * @return The text label of @p item or @c NULL, on errors
23263 * @see elm_flipselector_item_label_set()
23265 * @ingroup Flipselector
23267 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23270 * Set the label of a given flip selector widget's item.
23272 * @param item The item to set label on
23273 * @param label The text label string, in UTF-8 encoding
23275 * @see elm_flipselector_item_label_get()
23277 * @ingroup Flipselector
23279 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23282 * Gets the item before @p item in a flip selector widget's
23283 * internal list of items.
23285 * @param item The item to fetch previous from
23286 * @return The item before the @p item, in its parent's list. If
23287 * there is no previous item for @p item or there's an
23288 * error, @c NULL is returned.
23290 * @see elm_flipselector_item_next_get()
23292 * @ingroup Flipselector
23294 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23297 * Gets the item after @p item in a flip selector widget's
23298 * internal list of items.
23300 * @param item The item to fetch next from
23301 * @return The item after the @p item, in its parent's list. If
23302 * there is no next item for @p item or there's an
23303 * error, @c NULL is returned.
23305 * @see elm_flipselector_item_next_get()
23307 * @ingroup Flipselector
23309 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23312 * Set the interval on time updates for an user mouse button hold
23313 * on a flip selector widget.
23315 * @param obj The flip selector object
23316 * @param interval The (first) interval value in seconds
23318 * This interval value is @b decreased while the user holds the
23319 * mouse pointer either flipping up or flipping doww a given flip
23322 * This helps the user to get to a given item distant from the
23323 * current one easier/faster, as it will start to flip quicker and
23324 * quicker on mouse button holds.
23326 * The calculation for the next flip interval value, starting from
23327 * the one set with this call, is the previous interval divided by
23328 * 1.05, so it decreases a little bit.
23330 * The default starting interval value for automatic flips is
23333 * @see elm_flipselector_interval_get()
23335 * @ingroup Flipselector
23337 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23340 * Get the interval on time updates for an user mouse button hold
23341 * on a flip selector widget.
23343 * @param obj The flip selector object
23344 * @return The (first) interval value, in seconds, set on it
23346 * @see elm_flipselector_interval_set() for more details
23348 * @ingroup Flipselector
23350 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23356 * @addtogroup Calendar
23361 * @enum _Elm_Calendar_Mark_Repeat
23362 * @typedef Elm_Calendar_Mark_Repeat
23364 * Event periodicity, used to define if a mark should be repeated
23365 * @b beyond event's day. It's set when a mark is added.
23367 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23368 * there will be marks every week after this date. Marks will be displayed
23369 * at 13th, 20th, 27th, 3rd June ...
23371 * Values don't work as bitmask, only one can be choosen.
23373 * @see elm_calendar_mark_add()
23375 * @ingroup Calendar
23377 typedef enum _Elm_Calendar_Mark_Repeat
23379 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23380 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23381 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23382 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*/
23383 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. */
23384 } Elm_Calendar_Mark_Repeat;
23386 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(). */
23389 * Add a new calendar widget to the given parent Elementary
23390 * (container) object.
23392 * @param parent The parent object.
23393 * @return a new calendar widget handle or @c NULL, on errors.
23395 * This function inserts a new calendar widget on the canvas.
23397 * @ref calendar_example_01
23399 * @ingroup Calendar
23401 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23404 * Get weekdays names displayed by the calendar.
23406 * @param obj The calendar object.
23407 * @return Array of seven strings to be used as weekday names.
23409 * By default, weekdays abbreviations get from system are displayed:
23410 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23411 * The first string is related to Sunday, the second to Monday...
23413 * @see elm_calendar_weekdays_name_set()
23415 * @ref calendar_example_05
23417 * @ingroup Calendar
23419 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23422 * Set weekdays names to be displayed by the calendar.
23424 * @param obj The calendar object.
23425 * @param weekdays Array of seven strings to be used as weekday names.
23426 * @warning It must have 7 elements, or it will access invalid memory.
23427 * @warning The strings must be NULL terminated ('@\0').
23429 * By default, weekdays abbreviations get from system are displayed:
23430 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23432 * The first string should be related to Sunday, the second to Monday...
23434 * The usage should be like this:
23436 * const char *weekdays[] =
23438 * "Sunday", "Monday", "Tuesday", "Wednesday",
23439 * "Thursday", "Friday", "Saturday"
23441 * elm_calendar_weekdays_names_set(calendar, weekdays);
23444 * @see elm_calendar_weekdays_name_get()
23446 * @ref calendar_example_02
23448 * @ingroup Calendar
23450 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23453 * Set the minimum and maximum values for the year
23455 * @param obj The calendar object
23456 * @param min The minimum year, greater than 1901;
23457 * @param max The maximum year;
23459 * Maximum must be greater than minimum, except if you don't wan't to set
23461 * Default values are 1902 and -1.
23463 * If the maximum year is a negative value, it will be limited depending
23464 * on the platform architecture (year 2037 for 32 bits);
23466 * @see elm_calendar_min_max_year_get()
23468 * @ref calendar_example_03
23470 * @ingroup Calendar
23472 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23475 * Get the minimum and maximum values for the year
23477 * @param obj The calendar object.
23478 * @param min The minimum year.
23479 * @param max The maximum year.
23481 * Default values are 1902 and -1.
23483 * @see elm_calendar_min_max_year_get() for more details.
23485 * @ref calendar_example_05
23487 * @ingroup Calendar
23489 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23492 * Enable or disable day selection
23494 * @param obj The calendar object.
23495 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23498 * Enabled by default. If disabled, the user still can select months,
23499 * but not days. Selected days are highlighted on calendar.
23500 * It should be used if you won't need such selection for the widget usage.
23502 * When a day is selected, or month is changed, smart callbacks for
23503 * signal "changed" will be called.
23505 * @see elm_calendar_day_selection_enable_get()
23507 * @ref calendar_example_04
23509 * @ingroup Calendar
23511 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23514 * Get a value whether day selection is enabled or not.
23516 * @see elm_calendar_day_selection_enable_set() for details.
23518 * @param obj The calendar object.
23519 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23520 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23522 * @ref calendar_example_05
23524 * @ingroup Calendar
23526 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23530 * Set selected date to be highlighted on calendar.
23532 * @param obj The calendar object.
23533 * @param selected_time A @b tm struct to represent the selected date.
23535 * Set the selected date, changing the displayed month if needed.
23536 * Selected date changes when the user goes to next/previous month or
23537 * select a day pressing over it on calendar.
23539 * @see elm_calendar_selected_time_get()
23541 * @ref calendar_example_04
23543 * @ingroup Calendar
23545 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23548 * Get selected date.
23550 * @param obj The calendar object
23551 * @param selected_time A @b tm struct to point to selected date
23552 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23555 * Get date selected by the user or set by function
23556 * elm_calendar_selected_time_set().
23557 * Selected date changes when the user goes to next/previous month or
23558 * select a day pressing over it on calendar.
23560 * @see elm_calendar_selected_time_get()
23562 * @ref calendar_example_05
23564 * @ingroup Calendar
23566 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23569 * Set a function to format the string that will be used to display
23572 * @param obj The calendar object
23573 * @param format_function Function to set the month-year string given
23574 * the selected date
23576 * By default it uses strftime with "%B %Y" format string.
23577 * It should allocate the memory that will be used by the string,
23578 * that will be freed by the widget after usage.
23579 * A pointer to the string and a pointer to the time struct will be provided.
23584 * _format_month_year(struct tm *selected_time)
23587 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23588 * return strdup(buf);
23591 * elm_calendar_format_function_set(calendar, _format_month_year);
23594 * @ref calendar_example_02
23596 * @ingroup Calendar
23598 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23601 * Add a new mark to the calendar
23603 * @param obj The calendar object
23604 * @param mark_type A string used to define the type of mark. It will be
23605 * emitted to the theme, that should display a related modification on these
23606 * days representation.
23607 * @param mark_time A time struct to represent the date of inclusion of the
23608 * mark. For marks that repeats it will just be displayed after the inclusion
23609 * date in the calendar.
23610 * @param repeat Repeat the event following this periodicity. Can be a unique
23611 * mark (that don't repeat), daily, weekly, monthly or annually.
23612 * @return The created mark or @p NULL upon failure.
23614 * Add a mark that will be drawn in the calendar respecting the insertion
23615 * time and periodicity. It will emit the type as signal to the widget theme.
23616 * Default theme supports "holiday" and "checked", but it can be extended.
23618 * It won't immediately update the calendar, drawing the marks.
23619 * For this, call elm_calendar_marks_draw(). However, when user selects
23620 * next or previous month calendar forces marks drawn.
23622 * Marks created with this method can be deleted with
23623 * elm_calendar_mark_del().
23627 * struct tm selected_time;
23628 * time_t current_time;
23630 * current_time = time(NULL) + 5 * 84600;
23631 * localtime_r(¤t_time, &selected_time);
23632 * elm_calendar_mark_add(cal, "holiday", selected_time,
23633 * ELM_CALENDAR_ANNUALLY);
23635 * current_time = time(NULL) + 1 * 84600;
23636 * localtime_r(¤t_time, &selected_time);
23637 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23639 * elm_calendar_marks_draw(cal);
23642 * @see elm_calendar_marks_draw()
23643 * @see elm_calendar_mark_del()
23645 * @ref calendar_example_06
23647 * @ingroup Calendar
23649 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);
23652 * Delete mark from the calendar.
23654 * @param mark The mark to be deleted.
23656 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23657 * should be used instead of getting marks list and deleting each one.
23659 * @see elm_calendar_mark_add()
23661 * @ref calendar_example_06
23663 * @ingroup Calendar
23665 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23668 * Remove all calendar's marks
23670 * @param obj The calendar object.
23672 * @see elm_calendar_mark_add()
23673 * @see elm_calendar_mark_del()
23675 * @ingroup Calendar
23677 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23681 * Get a list of all the calendar marks.
23683 * @param obj The calendar object.
23684 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23686 * @see elm_calendar_mark_add()
23687 * @see elm_calendar_mark_del()
23688 * @see elm_calendar_marks_clear()
23690 * @ingroup Calendar
23692 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23695 * Draw calendar marks.
23697 * @param obj The calendar object.
23699 * Should be used after adding, removing or clearing marks.
23700 * It will go through the entire marks list updating the calendar.
23701 * If lots of marks will be added, add all the marks and then call
23704 * When the month is changed, i.e. user selects next or previous month,
23705 * marks will be drawed.
23707 * @see elm_calendar_mark_add()
23708 * @see elm_calendar_mark_del()
23709 * @see elm_calendar_marks_clear()
23711 * @ref calendar_example_06
23713 * @ingroup Calendar
23715 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23718 * Set a day text color to the same that represents Saturdays.
23720 * @param obj The calendar object.
23721 * @param pos The text position. Position is the cell counter, from left
23722 * to right, up to down. It starts on 0 and ends on 41.
23724 * @deprecated use elm_calendar_mark_add() instead like:
23727 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23728 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23731 * @see elm_calendar_mark_add()
23733 * @ingroup Calendar
23735 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23738 * Set a day text color to the same that represents Sundays.
23740 * @param obj The calendar object.
23741 * @param pos The text position. Position is the cell counter, from left
23742 * to right, up to down. It starts on 0 and ends on 41.
23744 * @deprecated use elm_calendar_mark_add() instead like:
23747 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23748 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23751 * @see elm_calendar_mark_add()
23753 * @ingroup Calendar
23755 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23758 * Set a day text color to the same that represents Weekdays.
23760 * @param obj The calendar object
23761 * @param pos The text position. Position is the cell counter, from left
23762 * to right, up to down. It starts on 0 and ends on 41.
23764 * @deprecated use elm_calendar_mark_add() instead like:
23767 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23769 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23770 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23771 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23772 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23773 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23774 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23775 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23776 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23777 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23780 * @see elm_calendar_mark_add()
23782 * @ingroup Calendar
23784 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23787 * Set the interval on time updates for an user mouse button hold
23788 * on calendar widgets' month selection.
23790 * @param obj The calendar object
23791 * @param interval The (first) interval value in seconds
23793 * This interval value is @b decreased while the user holds the
23794 * mouse pointer either selecting next or previous month.
23796 * This helps the user to get to a given month distant from the
23797 * current one easier/faster, as it will start to change quicker and
23798 * quicker on mouse button holds.
23800 * The calculation for the next change interval value, starting from
23801 * the one set with this call, is the previous interval divided by
23802 * 1.05, so it decreases a little bit.
23804 * The default starting interval value for automatic changes is
23807 * @see elm_calendar_interval_get()
23809 * @ingroup Calendar
23811 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23814 * Get the interval on time updates for an user mouse button hold
23815 * on calendar widgets' month selection.
23817 * @param obj The calendar object
23818 * @return The (first) interval value, in seconds, set on it
23820 * @see elm_calendar_interval_set() for more details
23822 * @ingroup Calendar
23824 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23831 * @defgroup Diskselector Diskselector
23832 * @ingroup Elementary
23834 * @image html img/widget/diskselector/preview-00.png
23835 * @image latex img/widget/diskselector/preview-00.eps
23837 * A diskselector is a kind of list widget. It scrolls horizontally,
23838 * and can contain label and icon objects. Three items are displayed
23839 * with the selected one in the middle.
23841 * It can act like a circular list with round mode and labels can be
23842 * reduced for a defined length for side items.
23844 * Smart callbacks one can listen to:
23845 * - "selected" - when item is selected, i.e. scroller stops.
23847 * Available styles for it:
23850 * List of examples:
23851 * @li @ref diskselector_example_01
23852 * @li @ref diskselector_example_02
23856 * @addtogroup Diskselector
23860 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(). */
23863 * Add a new diskselector widget to the given parent Elementary
23864 * (container) object.
23866 * @param parent The parent object.
23867 * @return a new diskselector widget handle or @c NULL, on errors.
23869 * This function inserts a new diskselector widget on the canvas.
23871 * @ingroup Diskselector
23873 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23876 * Enable or disable round mode.
23878 * @param obj The diskselector object.
23879 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23882 * Disabled by default. If round mode is enabled the items list will
23883 * work like a circle list, so when the user reaches the last item,
23884 * the first one will popup.
23886 * @see elm_diskselector_round_get()
23888 * @ingroup Diskselector
23890 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23893 * Get a value whether round mode is enabled or not.
23895 * @see elm_diskselector_round_set() for details.
23897 * @param obj The diskselector object.
23898 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23899 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23901 * @ingroup Diskselector
23903 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23906 * Get the side labels max length.
23908 * @deprecated use elm_diskselector_side_label_length_get() instead:
23910 * @param obj The diskselector object.
23911 * @return The max length defined for side labels, or 0 if not a valid
23914 * @ingroup Diskselector
23916 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23919 * Set the side labels max length.
23921 * @deprecated use elm_diskselector_side_label_length_set() instead:
23923 * @param obj The diskselector object.
23924 * @param len The max length defined for side labels.
23926 * @ingroup Diskselector
23928 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23931 * Get the side labels max length.
23933 * @see elm_diskselector_side_label_length_set() for details.
23935 * @param obj The diskselector object.
23936 * @return The max length defined for side labels, or 0 if not a valid
23939 * @ingroup Diskselector
23941 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23944 * Set the side labels max length.
23946 * @param obj The diskselector object.
23947 * @param len The max length defined for side labels.
23949 * Length is the number of characters of items' label that will be
23950 * visible when it's set on side positions. It will just crop
23951 * the string after defined size. E.g.:
23953 * An item with label "January" would be displayed on side position as
23954 * "Jan" if max length is set to 3, or "Janu", if this property
23957 * When it's selected, the entire label will be displayed, except for
23958 * width restrictions. In this case label will be cropped and "..."
23959 * will be concatenated.
23961 * Default side label max length is 3.
23963 * This property will be applyed over all items, included before or
23964 * later this function call.
23966 * @ingroup Diskselector
23968 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23971 * Set the number of items to be displayed.
23973 * @param obj The diskselector object.
23974 * @param num The number of items the diskselector will display.
23976 * Default value is 3, and also it's the minimun. If @p num is less
23977 * than 3, it will be set to 3.
23979 * Also, it can be set on theme, using data item @c display_item_num
23980 * on group "elm/diskselector/item/X", where X is style set.
23983 * group { name: "elm/diskselector/item/X";
23985 * item: "display_item_num" "5";
23988 * @ingroup Diskselector
23990 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23993 * Set bouncing behaviour when the scrolled content reaches an edge.
23995 * Tell the internal scroller object whether it should bounce or not
23996 * when it reaches the respective edges for each axis.
23998 * @param obj The diskselector object.
23999 * @param h_bounce Whether to bounce or not in the horizontal axis.
24000 * @param v_bounce Whether to bounce or not in the vertical axis.
24002 * @see elm_scroller_bounce_set()
24004 * @ingroup Diskselector
24006 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24009 * Get the bouncing behaviour of the internal scroller.
24011 * Get whether the internal scroller should bounce when the edge of each
24012 * axis is reached scrolling.
24014 * @param obj The diskselector object.
24015 * @param h_bounce Pointer where to store the bounce state of the horizontal
24017 * @param v_bounce Pointer where to store the bounce state of the vertical
24020 * @see elm_scroller_bounce_get()
24021 * @see elm_diskselector_bounce_set()
24023 * @ingroup Diskselector
24025 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24028 * Get the scrollbar policy.
24030 * @see elm_diskselector_scroller_policy_get() for details.
24032 * @param obj The diskselector object.
24033 * @param policy_h Pointer where to store horizontal scrollbar policy.
24034 * @param policy_v Pointer where to store vertical scrollbar policy.
24036 * @ingroup Diskselector
24038 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);
24041 * Set the scrollbar policy.
24043 * @param obj The diskselector object.
24044 * @param policy_h Horizontal scrollbar policy.
24045 * @param policy_v Vertical scrollbar policy.
24047 * This sets the scrollbar visibility policy for the given scroller.
24048 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24049 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24050 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24051 * This applies respectively for the horizontal and vertical scrollbars.
24053 * The both are disabled by default, i.e., are set to
24054 * #ELM_SCROLLER_POLICY_OFF.
24056 * @ingroup Diskselector
24058 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24061 * Remove all diskselector's items.
24063 * @param obj The diskselector object.
24065 * @see elm_diskselector_item_del()
24066 * @see elm_diskselector_item_append()
24068 * @ingroup Diskselector
24070 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24073 * Get a list of all the diskselector items.
24075 * @param obj The diskselector object.
24076 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24077 * or @c NULL on failure.
24079 * @see elm_diskselector_item_append()
24080 * @see elm_diskselector_item_del()
24081 * @see elm_diskselector_clear()
24083 * @ingroup Diskselector
24085 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24088 * Appends a new item to the diskselector object.
24090 * @param obj The diskselector object.
24091 * @param label The label of the diskselector item.
24092 * @param icon The icon object to use at left side of the item. An
24093 * icon can be any Evas object, but usually it is an icon created
24094 * with elm_icon_add().
24095 * @param func The function to call when the item is selected.
24096 * @param data The data to associate with the item for related callbacks.
24098 * @return The created item or @c NULL upon failure.
24100 * A new item will be created and appended to the diskselector, i.e., will
24101 * be set as last item. Also, if there is no selected item, it will
24102 * be selected. This will always happens for the first appended item.
24104 * If no icon is set, label will be centered on item position, otherwise
24105 * the icon will be placed at left of the label, that will be shifted
24108 * Items created with this method can be deleted with
24109 * elm_diskselector_item_del().
24111 * Associated @p data can be properly freed when item is deleted if a
24112 * callback function is set with elm_diskselector_item_del_cb_set().
24114 * If a function is passed as argument, it will be called everytime this item
24115 * is selected, i.e., the user stops the diskselector with this
24116 * item on center position. If such function isn't needed, just passing
24117 * @c NULL as @p func is enough. The same should be done for @p data.
24119 * Simple example (with no function callback or data associated):
24121 * disk = elm_diskselector_add(win);
24122 * ic = elm_icon_add(win);
24123 * elm_icon_file_set(ic, "path/to/image", NULL);
24124 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24125 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24128 * @see elm_diskselector_item_del()
24129 * @see elm_diskselector_item_del_cb_set()
24130 * @see elm_diskselector_clear()
24131 * @see elm_icon_add()
24133 * @ingroup Diskselector
24135 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);
24139 * Delete them item from the diskselector.
24141 * @param it The item of diskselector to be deleted.
24143 * If deleting all diskselector items is required, elm_diskselector_clear()
24144 * should be used instead of getting items list and deleting each one.
24146 * @see elm_diskselector_clear()
24147 * @see elm_diskselector_item_append()
24148 * @see elm_diskselector_item_del_cb_set()
24150 * @ingroup Diskselector
24152 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24155 * Set the function called when a diskselector item is freed.
24157 * @param it The item to set the callback on
24158 * @param func The function called
24160 * If there is a @p func, then it will be called prior item's memory release.
24161 * That will be called with the following arguments:
24163 * @li item's Evas object;
24166 * This way, a data associated to a diskselector item could be properly
24169 * @ingroup Diskselector
24171 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24174 * Get the data associated to the item.
24176 * @param it The diskselector item
24177 * @return The data associated to @p it
24179 * The return value is a pointer to data associated to @p item when it was
24180 * created, with function elm_diskselector_item_append(). If no data
24181 * was passed as argument, it will return @c NULL.
24183 * @see elm_diskselector_item_append()
24185 * @ingroup Diskselector
24187 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24190 * Set the icon associated to the item.
24192 * @param it The diskselector item
24193 * @param icon The icon object to associate with @p it
24195 * The icon object to use at left side of the item. An
24196 * icon can be any Evas object, but usually it is an icon created
24197 * with elm_icon_add().
24199 * Once the icon object is set, a previously set one will be deleted.
24200 * @warning Setting the same icon for two items will cause the icon to
24201 * dissapear from the first item.
24203 * If an icon was passed as argument on item creation, with function
24204 * elm_diskselector_item_append(), it will be already
24205 * associated to the item.
24207 * @see elm_diskselector_item_append()
24208 * @see elm_diskselector_item_icon_get()
24210 * @ingroup Diskselector
24212 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24215 * Get the icon associated to the item.
24217 * @param it The diskselector item
24218 * @return The icon associated to @p it
24220 * The return value is a pointer to the icon associated to @p item when it was
24221 * created, with function elm_diskselector_item_append(), or later
24222 * with function elm_diskselector_item_icon_set. If no icon
24223 * was passed as argument, it will return @c NULL.
24225 * @see elm_diskselector_item_append()
24226 * @see elm_diskselector_item_icon_set()
24228 * @ingroup Diskselector
24230 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24233 * Set the label of item.
24235 * @param it The item of diskselector.
24236 * @param label The label of item.
24238 * The label to be displayed by the item.
24240 * If no icon is set, label will be centered on item position, otherwise
24241 * the icon will be placed at left of the label, that will be shifted
24244 * An item with label "January" would be displayed on side position as
24245 * "Jan" if max length is set to 3 with function
24246 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24249 * When this @p item is selected, the entire label will be displayed,
24250 * except for width restrictions.
24251 * In this case label will be cropped and "..." will be concatenated,
24252 * but only for display purposes. It will keep the entire string, so
24253 * if diskselector is resized the remaining characters will be displayed.
24255 * If a label was passed as argument on item creation, with function
24256 * elm_diskselector_item_append(), it will be already
24257 * displayed by the item.
24259 * @see elm_diskselector_side_label_lenght_set()
24260 * @see elm_diskselector_item_label_get()
24261 * @see elm_diskselector_item_append()
24263 * @ingroup Diskselector
24265 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24268 * Get the label of item.
24270 * @param it The item of diskselector.
24271 * @return The label of item.
24273 * The return value is a pointer to the label associated to @p item when it was
24274 * created, with function elm_diskselector_item_append(), or later
24275 * with function elm_diskselector_item_label_set. If no label
24276 * was passed as argument, it will return @c NULL.
24278 * @see elm_diskselector_item_label_set() for more details.
24279 * @see elm_diskselector_item_append()
24281 * @ingroup Diskselector
24283 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24286 * Get the selected item.
24288 * @param obj The diskselector object.
24289 * @return The selected diskselector item.
24291 * The selected item can be unselected with function
24292 * elm_diskselector_item_selected_set(), and the first item of
24293 * diskselector will be selected.
24295 * The selected item always will be centered on diskselector, with
24296 * full label displayed, i.e., max lenght set to side labels won't
24297 * apply on the selected item. More details on
24298 * elm_diskselector_side_label_length_set().
24300 * @ingroup Diskselector
24302 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24305 * Set the selected state of an item.
24307 * @param it The diskselector item
24308 * @param selected The selected state
24310 * This sets the selected state of the given item @p it.
24311 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24313 * If a new item is selected the previosly selected will be unselected.
24314 * Previoulsy selected item can be get with function
24315 * elm_diskselector_selected_item_get().
24317 * If the item @p it is unselected, the first item of diskselector will
24320 * Selected items will be visible on center position of diskselector.
24321 * So if it was on another position before selected, or was invisible,
24322 * diskselector will animate items until the selected item reaches center
24325 * @see elm_diskselector_item_selected_get()
24326 * @see elm_diskselector_selected_item_get()
24328 * @ingroup Diskselector
24330 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24333 * Get whether the @p item is selected or not.
24335 * @param it The diskselector item.
24336 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24337 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24339 * @see elm_diskselector_selected_item_set() for details.
24340 * @see elm_diskselector_item_selected_get()
24342 * @ingroup Diskselector
24344 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24347 * Get the first item of the diskselector.
24349 * @param obj The diskselector object.
24350 * @return The first item, or @c NULL if none.
24352 * The list of items follows append order. So it will return the first
24353 * item appended to the widget that wasn't deleted.
24355 * @see elm_diskselector_item_append()
24356 * @see elm_diskselector_items_get()
24358 * @ingroup Diskselector
24360 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 * Get the last item of the diskselector.
24365 * @param obj The diskselector object.
24366 * @return The last item, or @c NULL if none.
24368 * The list of items follows append order. So it will return last first
24369 * item appended to the widget that wasn't deleted.
24371 * @see elm_diskselector_item_append()
24372 * @see elm_diskselector_items_get()
24374 * @ingroup Diskselector
24376 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24379 * Get the item before @p item in diskselector.
24381 * @param it The diskselector item.
24382 * @return The item before @p item, or @c NULL if none or on failure.
24384 * The list of items follows append order. So it will return item appended
24385 * just before @p item and that wasn't deleted.
24387 * If it is the first item, @c NULL will be returned.
24388 * First item can be get by elm_diskselector_first_item_get().
24390 * @see elm_diskselector_item_append()
24391 * @see elm_diskselector_items_get()
24393 * @ingroup Diskselector
24395 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24398 * Get the item after @p item in diskselector.
24400 * @param it The diskselector item.
24401 * @return The item after @p item, or @c NULL if none or on failure.
24403 * The list of items follows append order. So it will return item appended
24404 * just after @p item and that wasn't deleted.
24406 * If it is the last item, @c NULL will be returned.
24407 * Last item can be get by elm_diskselector_last_item_get().
24409 * @see elm_diskselector_item_append()
24410 * @see elm_diskselector_items_get()
24412 * @ingroup Diskselector
24414 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24417 * Set the text to be shown in the diskselector item.
24419 * @param item Target item
24420 * @param text The text to set in the content
24422 * Setup the text as tooltip to object. The item can have only one tooltip,
24423 * so any previous tooltip data is removed.
24425 * @see elm_object_tooltip_text_set() for more details.
24427 * @ingroup Diskselector
24429 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24432 * Set the content to be shown in the tooltip item.
24434 * Setup the tooltip to item. The item can have only one tooltip,
24435 * so any previous tooltip data is removed. @p func(with @p data) will
24436 * be called every time that need show the tooltip and it should
24437 * return a valid Evas_Object. This object is then managed fully by
24438 * tooltip system and is deleted when the tooltip is gone.
24440 * @param item the diskselector item being attached a tooltip.
24441 * @param func the function used to create the tooltip contents.
24442 * @param data what to provide to @a func as callback data/context.
24443 * @param del_cb called when data is not needed anymore, either when
24444 * another callback replaces @p func, the tooltip is unset with
24445 * elm_diskselector_item_tooltip_unset() or the owner @a item
24446 * dies. This callback receives as the first parameter the
24447 * given @a data, and @c event_info is the item.
24449 * @see elm_object_tooltip_content_cb_set() for more details.
24451 * @ingroup Diskselector
24453 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);
24456 * Unset tooltip from item.
24458 * @param item diskselector item to remove previously set tooltip.
24460 * Remove tooltip from item. The callback provided as del_cb to
24461 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24462 * it is not used anymore.
24464 * @see elm_object_tooltip_unset() for more details.
24465 * @see elm_diskselector_item_tooltip_content_cb_set()
24467 * @ingroup Diskselector
24469 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24473 * Sets a different style for this item tooltip.
24475 * @note before you set a style you should define a tooltip with
24476 * elm_diskselector_item_tooltip_content_cb_set() or
24477 * elm_diskselector_item_tooltip_text_set()
24479 * @param item diskselector item with tooltip already set.
24480 * @param style the theme style to use (default, transparent, ...)
24482 * @see elm_object_tooltip_style_set() for more details.
24484 * @ingroup Diskselector
24486 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24489 * Get the style for this item tooltip.
24491 * @param item diskselector item with tooltip already set.
24492 * @return style the theme style in use, defaults to "default". If the
24493 * object does not have a tooltip set, then NULL is returned.
24495 * @see elm_object_tooltip_style_get() for more details.
24496 * @see elm_diskselector_item_tooltip_style_set()
24498 * @ingroup Diskselector
24500 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24503 * Set the cursor to be shown when mouse is over the diskselector item
24505 * @param item Target item
24506 * @param cursor the cursor name to be used.
24508 * @see elm_object_cursor_set() for more details.
24510 * @ingroup Diskselector
24512 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24515 * Get the cursor to be shown when mouse is over the diskselector item
24517 * @param item diskselector item with cursor already set.
24518 * @return the cursor name.
24520 * @see elm_object_cursor_get() for more details.
24521 * @see elm_diskselector_cursor_set()
24523 * @ingroup Diskselector
24525 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24529 * Unset the cursor to be shown when mouse is over the diskselector item
24531 * @param item Target item
24533 * @see elm_object_cursor_unset() for more details.
24534 * @see elm_diskselector_cursor_set()
24536 * @ingroup Diskselector
24538 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24541 * Sets a different style for this item cursor.
24543 * @note before you set a style you should define a cursor with
24544 * elm_diskselector_item_cursor_set()
24546 * @param item diskselector item with cursor already set.
24547 * @param style the theme style to use (default, transparent, ...)
24549 * @see elm_object_cursor_style_set() for more details.
24551 * @ingroup Diskselector
24553 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24557 * Get the style for this item cursor.
24559 * @param item diskselector item with cursor already set.
24560 * @return style the theme style in use, defaults to "default". If the
24561 * object does not have a cursor set, then @c NULL is returned.
24563 * @see elm_object_cursor_style_get() for more details.
24564 * @see elm_diskselector_item_cursor_style_set()
24566 * @ingroup Diskselector
24568 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24572 * Set if the cursor set should be searched on the theme or should use
24573 * the provided by the engine, only.
24575 * @note before you set if should look on theme you should define a cursor
24576 * with elm_diskselector_item_cursor_set().
24577 * By default it will only look for cursors provided by the engine.
24579 * @param item widget item with cursor already set.
24580 * @param engine_only boolean to define if cursors set with
24581 * elm_diskselector_item_cursor_set() should be searched only
24582 * between cursors provided by the engine or searched on widget's
24585 * @see elm_object_cursor_engine_only_set() for more details.
24587 * @ingroup Diskselector
24589 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24592 * Get the cursor engine only usage for this item cursor.
24594 * @param item widget item with cursor already set.
24595 * @return engine_only boolean to define it cursors should be looked only
24596 * between the provided by the engine or searched on widget's theme as well.
24597 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24599 * @see elm_object_cursor_engine_only_get() for more details.
24600 * @see elm_diskselector_item_cursor_engine_only_set()
24602 * @ingroup Diskselector
24604 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24611 * @defgroup Colorselector Colorselector
24615 * @image html img/widget/colorselector/preview-00.png
24616 * @image latex img/widget/colorselector/preview-00.eps
24618 * @brief Widget for user to select a color.
24620 * Signals that you can add callbacks for are:
24621 * "changed" - When the color value changes(event_info is NULL).
24623 * See @ref tutorial_colorselector.
24626 * @brief Add a new colorselector to the parent
24628 * @param parent The parent object
24629 * @return The new object or NULL if it cannot be created
24631 * @ingroup Colorselector
24633 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24635 * Set a color for the colorselector
24637 * @param obj Colorselector object
24638 * @param r r-value of color
24639 * @param g g-value of color
24640 * @param b b-value of color
24641 * @param a a-value of color
24643 * @ingroup Colorselector
24645 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24647 * Get a color from the colorselector
24649 * @param obj Colorselector object
24650 * @param r integer pointer for r-value of color
24651 * @param g integer pointer for g-value of color
24652 * @param b integer pointer for b-value of color
24653 * @param a integer pointer for a-value of color
24655 * @ingroup Colorselector
24657 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24663 * @defgroup Ctxpopup Ctxpopup
24665 * @image html img/widget/ctxpopup/preview-00.png
24666 * @image latex img/widget/ctxpopup/preview-00.eps
24668 * @brief Context popup widet.
24670 * A ctxpopup is a widget that, when shown, pops up a list of items.
24671 * It automatically chooses an area inside its parent object's view
24672 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24673 * optimally fit into it. In the default theme, it will also point an
24674 * arrow to it's top left position at the time one shows it. Ctxpopup
24675 * items have a label and/or an icon. It is intended for a small
24676 * number of items (hence the use of list, not genlist).
24678 * @note Ctxpopup is a especialization of @ref Hover.
24680 * Signals that you can add callbacks for are:
24681 * "dismissed" - the ctxpopup was dismissed
24683 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24686 typedef enum _Elm_Ctxpopup_Direction
24688 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24690 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24691 the clicked area */
24692 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24693 the clicked area */
24694 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24696 } Elm_Ctxpopup_Direction;
24699 * @brief Add a new Ctxpopup object to the parent.
24701 * @param parent Parent object
24702 * @return New object or @c NULL, if it cannot be created
24704 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24706 * @brief Set the Ctxpopup's parent
24708 * @param obj The ctxpopup object
24709 * @param area The parent to use
24711 * Set the parent object.
24713 * @note elm_ctxpopup_add() will automatically call this function
24714 * with its @c parent argument.
24716 * @see elm_ctxpopup_add()
24717 * @see elm_hover_parent_set()
24719 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24721 * @brief Get the Ctxpopup's parent
24723 * @param obj The ctxpopup object
24725 * @see elm_ctxpopup_hover_parent_set() for more information
24727 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24729 * @brief Clear all items in the given ctxpopup object.
24731 * @param obj Ctxpopup object
24733 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24735 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24737 * @param obj Ctxpopup object
24738 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24740 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24742 * @brief Get the value of current ctxpopup object's orientation.
24744 * @param obj Ctxpopup object
24745 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24747 * @see elm_ctxpopup_horizontal_set()
24749 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24751 * @brief Add a new item to a ctxpopup object.
24753 * @param obj Ctxpopup object
24754 * @param icon Icon to be set on new item
24755 * @param label The Label of the new item
24756 * @param func Convenience function called when item selected
24757 * @param data Data passed to @p func
24758 * @return A handle to the item added or @c NULL, on errors
24760 * @warning Ctxpopup can't hold both an item list and a content at the same
24761 * time. When an item is added, any previous content will be removed.
24763 * @see elm_ctxpopup_content_set()
24765 Elm_Object_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);
24767 * @brief Delete the given item in a ctxpopup object.
24769 * @param it Ctxpopup item to be deleted
24771 * @see elm_ctxpopup_item_append()
24773 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24775 * @brief Set the ctxpopup item's state as disabled or enabled.
24777 * @param it Ctxpopup item to be enabled/disabled
24778 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24780 * When disabled the item is greyed out to indicate it's state.
24782 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24784 * @brief Get the ctxpopup item's disabled/enabled state.
24786 * @param it Ctxpopup item to be enabled/disabled
24787 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24789 * @see elm_ctxpopup_item_disabled_set()
24791 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24793 * @brief Get the icon object for the given ctxpopup item.
24795 * @param it Ctxpopup item
24796 * @return icon object or @c NULL, if the item does not have icon or an error
24799 * @see elm_ctxpopup_item_append()
24800 * @see elm_ctxpopup_item_icon_set()
24802 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24804 * @brief Sets the side icon associated with the ctxpopup item
24806 * @param it Ctxpopup item
24807 * @param icon Icon object to be set
24809 * Once the icon object is set, a previously set one will be deleted.
24810 * @warning Setting the same icon for two items will cause the icon to
24811 * dissapear from the first item.
24813 * @see elm_ctxpopup_item_append()
24815 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24817 * @brief Get the label for the given ctxpopup item.
24819 * @param it Ctxpopup item
24820 * @return label string or @c NULL, if the item does not have label or an
24823 * @see elm_ctxpopup_item_append()
24824 * @see elm_ctxpopup_item_label_set()
24826 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24828 * @brief (Re)set the label on the given ctxpopup item.
24830 * @param it Ctxpopup item
24831 * @param label String to set as label
24833 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24835 * @brief Set an elm widget as the content of the ctxpopup.
24837 * @param obj Ctxpopup object
24838 * @param content Content to be swallowed
24840 * If the content object is already set, a previous one will bedeleted. If
24841 * you want to keep that old content object, use the
24842 * elm_ctxpopup_content_unset() function.
24844 * @deprecated use elm_object_content_set()
24846 * @warning Ctxpopup can't hold both a item list and a content at the same
24847 * time. When a content is set, any previous items will be removed.
24849 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24851 * @brief Unset the ctxpopup content
24853 * @param obj Ctxpopup object
24854 * @return The content that was being used
24856 * Unparent and return the content object which was set for this widget.
24858 * @deprecated use elm_object_content_unset()
24860 * @see elm_ctxpopup_content_set()
24862 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24864 * @brief Set the direction priority of a ctxpopup.
24866 * @param obj Ctxpopup object
24867 * @param first 1st priority of direction
24868 * @param second 2nd priority of direction
24869 * @param third 3th priority of direction
24870 * @param fourth 4th priority of direction
24872 * This functions gives a chance to user to set the priority of ctxpopup
24873 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24874 * requested direction.
24876 * @see Elm_Ctxpopup_Direction
24878 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);
24880 * @brief Get the direction priority of a ctxpopup.
24882 * @param obj Ctxpopup object
24883 * @param first 1st priority of direction to be returned
24884 * @param second 2nd priority of direction to be returned
24885 * @param third 3th priority of direction to be returned
24886 * @param fourth 4th priority of direction to be returned
24888 * @see elm_ctxpopup_direction_priority_set() for more information.
24890 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);
24898 * @defgroup Transit Transit
24899 * @ingroup Elementary
24901 * Transit is designed to apply various animated transition effects to @c
24902 * Evas_Object, such like translation, rotation, etc. For using these
24903 * effects, create an @ref Elm_Transit and add the desired transition effects.
24905 * Once the effects are added into transit, they will be automatically
24906 * managed (their callback will be called until the duration is ended, and
24907 * they will be deleted on completion).
24911 * Elm_Transit *trans = elm_transit_add();
24912 * elm_transit_object_add(trans, obj);
24913 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24914 * elm_transit_duration_set(transit, 1);
24915 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24916 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24917 * elm_transit_repeat_times_set(transit, 3);
24920 * Some transition effects are used to change the properties of objects. They
24922 * @li @ref elm_transit_effect_translation_add
24923 * @li @ref elm_transit_effect_color_add
24924 * @li @ref elm_transit_effect_rotation_add
24925 * @li @ref elm_transit_effect_wipe_add
24926 * @li @ref elm_transit_effect_zoom_add
24927 * @li @ref elm_transit_effect_resizing_add
24929 * Other transition effects are used to make one object disappear and another
24930 * object appear on its old place. These effects are:
24932 * @li @ref elm_transit_effect_flip_add
24933 * @li @ref elm_transit_effect_resizable_flip_add
24934 * @li @ref elm_transit_effect_fade_add
24935 * @li @ref elm_transit_effect_blend_add
24937 * It's also possible to make a transition chain with @ref
24938 * elm_transit_chain_transit_add.
24940 * @warning We strongly recommend to use elm_transit just when edje can not do
24941 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24942 * animations can be manipulated inside the theme.
24944 * List of examples:
24945 * @li @ref transit_example_01_explained
24946 * @li @ref transit_example_02_explained
24947 * @li @ref transit_example_03_c
24948 * @li @ref transit_example_04_c
24954 * @enum Elm_Transit_Tween_Mode
24956 * The type of acceleration used in the transition.
24960 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24961 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24962 over time, then decrease again
24964 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24966 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24968 } Elm_Transit_Tween_Mode;
24971 * @enum Elm_Transit_Effect_Flip_Axis
24973 * The axis where flip effect should be applied.
24977 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24978 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24979 } Elm_Transit_Effect_Flip_Axis;
24981 * @enum Elm_Transit_Effect_Wipe_Dir
24983 * The direction where the wipe effect should occur.
24987 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24988 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24989 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24990 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24991 } Elm_Transit_Effect_Wipe_Dir;
24992 /** @enum Elm_Transit_Effect_Wipe_Type
24994 * Whether the wipe effect should show or hide the object.
24998 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25000 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25002 } Elm_Transit_Effect_Wipe_Type;
25005 * @typedef Elm_Transit
25007 * The Transit created with elm_transit_add(). This type has the information
25008 * about the objects which the transition will be applied, and the
25009 * transition effects that will be used. It also contains info about
25010 * duration, number of repetitions, auto-reverse, etc.
25012 typedef struct _Elm_Transit Elm_Transit;
25013 typedef void Elm_Transit_Effect;
25015 * @typedef Elm_Transit_Effect_Transition_Cb
25017 * Transition callback called for this effect on each transition iteration.
25019 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25021 * Elm_Transit_Effect_End_Cb
25023 * Transition callback called for this effect when the transition is over.
25025 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25028 * Elm_Transit_Del_Cb
25030 * A callback called when the transit is deleted.
25032 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25037 * @note Is not necessary to delete the transit object, it will be deleted at
25038 * the end of its operation.
25039 * @note The transit will start playing when the program enter in the main loop, is not
25040 * necessary to give a start to the transit.
25042 * @return The transit object.
25046 EAPI Elm_Transit *elm_transit_add(void);
25049 * Stops the animation and delete the @p transit object.
25051 * Call this function if you wants to stop the animation before the duration
25052 * time. Make sure the @p transit object is still alive with
25053 * elm_transit_del_cb_set() function.
25054 * All added effects will be deleted, calling its repective data_free_cb
25055 * functions. The function setted by elm_transit_del_cb_set() will be called.
25057 * @see elm_transit_del_cb_set()
25059 * @param transit The transit object to be deleted.
25062 * @warning Just call this function if you are sure the transit is alive.
25064 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25067 * Add a new effect to the transit.
25069 * @note The cb function and the data are the key to the effect. If you try to
25070 * add an already added effect, nothing is done.
25071 * @note After the first addition of an effect in @p transit, if its
25072 * effect list become empty again, the @p transit will be killed by
25073 * elm_transit_del(transit) function.
25077 * Elm_Transit *transit = elm_transit_add();
25078 * elm_transit_effect_add(transit,
25079 * elm_transit_effect_blend_op,
25080 * elm_transit_effect_blend_context_new(),
25081 * elm_transit_effect_blend_context_free);
25084 * @param transit The transit object.
25085 * @param transition_cb The operation function. It is called when the
25086 * animation begins, it is the function that actually performs the animation.
25087 * It is called with the @p data, @p transit and the time progression of the
25088 * animation (a double value between 0.0 and 1.0).
25089 * @param effect The context data of the effect.
25090 * @param end_cb The function to free the context data, it will be called
25091 * at the end of the effect, it must finalize the animation and free the
25095 * @warning The transit free the context data at the and of the transition with
25096 * the data_free_cb function, do not use the context data in another transit.
25098 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);
25101 * Delete an added effect.
25103 * This function will remove the effect from the @p transit, calling the
25104 * data_free_cb to free the @p data.
25106 * @see elm_transit_effect_add()
25108 * @note If the effect is not found, nothing is done.
25109 * @note If the effect list become empty, this function will call
25110 * elm_transit_del(transit), that is, it will kill the @p transit.
25112 * @param transit The transit object.
25113 * @param transition_cb The operation function.
25114 * @param effect The context data of the effect.
25118 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);
25121 * Add new object to apply the effects.
25123 * @note After the first addition of an object in @p transit, if its
25124 * object list become empty again, the @p transit will be killed by
25125 * elm_transit_del(transit) function.
25126 * @note If the @p obj belongs to another transit, the @p obj will be
25127 * removed from it and it will only belong to the @p transit. If the old
25128 * transit stays without objects, it will die.
25129 * @note When you add an object into the @p transit, its state from
25130 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25131 * transit ends, if you change this state whith evas_object_pass_events_set()
25132 * after add the object, this state will change again when @p transit stops to
25135 * @param transit The transit object.
25136 * @param obj Object to be animated.
25139 * @warning It is not allowed to add a new object after transit begins to go.
25141 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25144 * Removes an added object from the transit.
25146 * @note If the @p obj is not in the @p transit, nothing is done.
25147 * @note If the list become empty, this function will call
25148 * elm_transit_del(transit), that is, it will kill the @p transit.
25150 * @param transit The transit object.
25151 * @param obj Object to be removed from @p transit.
25154 * @warning It is not allowed to remove objects after transit begins to go.
25156 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25159 * Get the objects of the transit.
25161 * @param transit The transit object.
25162 * @return a Eina_List with the objects from the transit.
25166 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25169 * Enable/disable keeping up the objects states.
25170 * If it is not kept, the objects states will be reset when transition ends.
25172 * @note @p transit can not be NULL.
25173 * @note One state includes geometry, color, map data.
25175 * @param transit The transit object.
25176 * @param state_keep Keeping or Non Keeping.
25180 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25183 * Get a value whether the objects states will be reset or not.
25185 * @note @p transit can not be NULL
25187 * @see elm_transit_objects_final_state_keep_set()
25189 * @param transit The transit object.
25190 * @return EINA_TRUE means the states of the objects will be reset.
25191 * If @p transit is NULL, EINA_FALSE is returned
25195 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25198 * Set the event enabled when transit is operating.
25200 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25201 * events from mouse and keyboard during the animation.
25202 * @note When you add an object with elm_transit_object_add(), its state from
25203 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25204 * transit ends, if you change this state with evas_object_pass_events_set()
25205 * after adding the object, this state will change again when @p transit stops
25208 * @param transit The transit object.
25209 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25210 * ignored otherwise.
25214 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25217 * Get the value of event enabled status.
25219 * @see elm_transit_event_enabled_set()
25221 * @param transit The Transit object
25222 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25223 * EINA_FALSE is returned
25227 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25230 * Set the user-callback function when the transit is deleted.
25232 * @note Using this function twice will overwrite the first function setted.
25233 * @note the @p transit object will be deleted after call @p cb function.
25235 * @param transit The transit object.
25236 * @param cb Callback function pointer. This function will be called before
25237 * the deletion of the transit.
25238 * @param data Callback funtion user data. It is the @p op parameter.
25242 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25245 * Set reverse effect automatically.
25247 * If auto reverse is setted, after running the effects with the progress
25248 * parameter from 0 to 1, it will call the effecs again with the progress
25249 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25250 * where the duration was setted with the function elm_transit_add and
25251 * the repeat with the function elm_transit_repeat_times_set().
25253 * @param transit The transit object.
25254 * @param reverse EINA_TRUE means the auto_reverse is on.
25258 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25261 * Get if the auto reverse is on.
25263 * @see elm_transit_auto_reverse_set()
25265 * @param transit The transit object.
25266 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25267 * EINA_FALSE is returned
25271 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25274 * Set the transit repeat count. Effect will be repeated by repeat count.
25276 * This function sets the number of repetition the transit will run after
25277 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25278 * If the @p repeat is a negative number, it will repeat infinite times.
25280 * @note If this function is called during the transit execution, the transit
25281 * will run @p repeat times, ignoring the times it already performed.
25283 * @param transit The transit object
25284 * @param repeat Repeat count
25288 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25291 * Get the transit repeat count.
25293 * @see elm_transit_repeat_times_set()
25295 * @param transit The Transit object.
25296 * @return The repeat count. If @p transit is NULL
25301 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25304 * Set the transit animation acceleration type.
25306 * This function sets the tween mode of the transit that can be:
25307 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25308 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25309 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25310 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25312 * @param transit The transit object.
25313 * @param tween_mode The tween type.
25317 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25320 * Get the transit animation acceleration type.
25322 * @note @p transit can not be NULL
25324 * @param transit The transit object.
25325 * @return The tween type. If @p transit is NULL
25326 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25330 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25333 * Set the transit animation time
25335 * @note @p transit can not be NULL
25337 * @param transit The transit object.
25338 * @param duration The animation time.
25342 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25345 * Get the transit animation time
25347 * @note @p transit can not be NULL
25349 * @param transit The transit object.
25351 * @return The transit animation time.
25355 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25358 * Starts the transition.
25359 * Once this API is called, the transit begins to measure the time.
25361 * @note @p transit can not be NULL
25363 * @param transit The transit object.
25367 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25370 * Pause/Resume the transition.
25372 * If you call elm_transit_go again, the transit will be started from the
25373 * beginning, and will be unpaused.
25375 * @note @p transit can not be NULL
25377 * @param transit The transit object.
25378 * @param paused Whether the transition should be paused or not.
25382 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25385 * Get the value of paused status.
25387 * @see elm_transit_paused_set()
25389 * @note @p transit can not be NULL
25391 * @param transit The transit object.
25392 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25393 * EINA_FALSE is returned
25397 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25400 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25402 * The value returned is a fraction (current time / total time). It
25403 * represents the progression position relative to the total.
25405 * @note @p transit can not be NULL
25407 * @param transit The transit object.
25409 * @return The time progression value. If @p transit is NULL
25414 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25417 * Makes the chain relationship between two transits.
25419 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25420 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25422 * @param transit The transit object.
25423 * @param chain_transit The chain transit object. This transit will be operated
25424 * after transit is done.
25426 * This function adds @p chain_transit transition to a chain after the @p
25427 * transit, and will be started as soon as @p transit ends. See @ref
25428 * transit_example_02_explained for a full example.
25432 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25435 * Cut off the chain relationship between two transits.
25437 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25438 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25440 * @param transit The transit object.
25441 * @param chain_transit The chain transit object.
25443 * This function remove the @p chain_transit transition from the @p transit.
25447 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25450 * Get the current chain transit list.
25452 * @note @p transit can not be NULL.
25454 * @param transit The transit object.
25455 * @return chain transit list.
25459 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25462 * Add the Resizing Effect to Elm_Transit.
25464 * @note This API is one of the facades. It creates resizing effect context
25465 * and add it's required APIs to elm_transit_effect_add.
25467 * @see elm_transit_effect_add()
25469 * @param transit Transit object.
25470 * @param from_w Object width size when effect begins.
25471 * @param from_h Object height size when effect begins.
25472 * @param to_w Object width size when effect ends.
25473 * @param to_h Object height size when effect ends.
25474 * @return Resizing effect context data.
25478 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);
25481 * Add the Translation Effect to Elm_Transit.
25483 * @note This API is one of the facades. It creates translation effect context
25484 * and add it's required APIs to elm_transit_effect_add.
25486 * @see elm_transit_effect_add()
25488 * @param transit Transit object.
25489 * @param from_dx X Position variation when effect begins.
25490 * @param from_dy Y Position variation when effect begins.
25491 * @param to_dx X Position variation when effect ends.
25492 * @param to_dy Y Position variation when effect ends.
25493 * @return Translation effect context data.
25496 * @warning It is highly recommended just create a transit with this effect when
25497 * the window that the objects of the transit belongs has already been created.
25498 * This is because this effect needs the geometry information about the objects,
25499 * and if the window was not created yet, it can get a wrong information.
25501 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);
25504 * Add the Zoom Effect to Elm_Transit.
25506 * @note This API is one of the facades. It creates zoom effect context
25507 * and add it's required APIs to elm_transit_effect_add.
25509 * @see elm_transit_effect_add()
25511 * @param transit Transit object.
25512 * @param from_rate Scale rate when effect begins (1 is current rate).
25513 * @param to_rate Scale rate when effect ends.
25514 * @return Zoom effect context data.
25517 * @warning It is highly recommended just create a transit with this effect when
25518 * the window that the objects of the transit belongs has already been created.
25519 * This is because this effect needs the geometry information about the objects,
25520 * and if the window was not created yet, it can get a wrong information.
25522 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25525 * Add the Flip Effect to Elm_Transit.
25527 * @note This API is one of the facades. It creates flip effect context
25528 * and add it's required APIs to elm_transit_effect_add.
25529 * @note This effect is applied to each pair of objects in the order they are listed
25530 * in the transit list of objects. The first object in the pair will be the
25531 * "front" object and the second will be the "back" object.
25533 * @see elm_transit_effect_add()
25535 * @param transit Transit object.
25536 * @param axis Flipping Axis(X or Y).
25537 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25538 * @return Flip effect context data.
25541 * @warning It is highly recommended just create a transit with this effect when
25542 * the window that the objects of the transit belongs has already been created.
25543 * This is because this effect needs the geometry information about the objects,
25544 * and if the window was not created yet, it can get a wrong information.
25546 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25549 * Add the Resizable Flip Effect to Elm_Transit.
25551 * @note This API is one of the facades. It creates resizable flip effect context
25552 * and add it's required APIs to elm_transit_effect_add.
25553 * @note This effect is applied to each pair of objects in the order they are listed
25554 * in the transit list of objects. The first object in the pair will be the
25555 * "front" object and the second will be the "back" object.
25557 * @see elm_transit_effect_add()
25559 * @param transit Transit object.
25560 * @param axis Flipping Axis(X or Y).
25561 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25562 * @return Resizable flip effect context data.
25565 * @warning It is highly recommended just create a transit with this effect when
25566 * the window that the objects of the transit belongs has already been created.
25567 * This is because this effect needs the geometry information about the objects,
25568 * and if the window was not created yet, it can get a wrong information.
25570 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25573 * Add the Wipe Effect to Elm_Transit.
25575 * @note This API is one of the facades. It creates wipe effect context
25576 * and add it's required APIs to elm_transit_effect_add.
25578 * @see elm_transit_effect_add()
25580 * @param transit Transit object.
25581 * @param type Wipe type. Hide or show.
25582 * @param dir Wipe Direction.
25583 * @return Wipe effect context data.
25586 * @warning It is highly recommended just create a transit with this effect when
25587 * the window that the objects of the transit belongs has already been created.
25588 * This is because this effect needs the geometry information about the objects,
25589 * and if the window was not created yet, it can get a wrong information.
25591 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25594 * Add the Color Effect to Elm_Transit.
25596 * @note This API is one of the facades. It creates color effect context
25597 * and add it's required APIs to elm_transit_effect_add.
25599 * @see elm_transit_effect_add()
25601 * @param transit Transit object.
25602 * @param from_r RGB R when effect begins.
25603 * @param from_g RGB G when effect begins.
25604 * @param from_b RGB B when effect begins.
25605 * @param from_a RGB A when effect begins.
25606 * @param to_r RGB R when effect ends.
25607 * @param to_g RGB G when effect ends.
25608 * @param to_b RGB B when effect ends.
25609 * @param to_a RGB A when effect ends.
25610 * @return Color effect context data.
25614 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);
25617 * Add the Fade Effect to Elm_Transit.
25619 * @note This API is one of the facades. It creates fade effect context
25620 * and add it's required APIs to elm_transit_effect_add.
25621 * @note This effect is applied to each pair of objects in the order they are listed
25622 * in the transit list of objects. The first object in the pair will be the
25623 * "before" object and the second will be the "after" object.
25625 * @see elm_transit_effect_add()
25627 * @param transit Transit object.
25628 * @return Fade effect context data.
25631 * @warning It is highly recommended just create a transit with this effect when
25632 * the window that the objects of the transit belongs has already been created.
25633 * This is because this effect needs the color information about the objects,
25634 * and if the window was not created yet, it can get a wrong information.
25636 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25639 * Add the Blend Effect to Elm_Transit.
25641 * @note This API is one of the facades. It creates blend effect context
25642 * and add it's required APIs to elm_transit_effect_add.
25643 * @note This effect is applied to each pair of objects in the order they are listed
25644 * in the transit list of objects. The first object in the pair will be the
25645 * "before" object and the second will be the "after" object.
25647 * @see elm_transit_effect_add()
25649 * @param transit Transit object.
25650 * @return Blend effect context data.
25653 * @warning It is highly recommended just create a transit with this effect when
25654 * the window that the objects of the transit belongs has already been created.
25655 * This is because this effect needs the color information about the objects,
25656 * and if the window was not created yet, it can get a wrong information.
25658 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25661 * Add the Rotation Effect to Elm_Transit.
25663 * @note This API is one of the facades. It creates rotation effect context
25664 * and add it's required APIs to elm_transit_effect_add.
25666 * @see elm_transit_effect_add()
25668 * @param transit Transit object.
25669 * @param from_degree Degree when effect begins.
25670 * @param to_degree Degree when effect is ends.
25671 * @return Rotation effect context data.
25674 * @warning It is highly recommended just create a transit with this effect when
25675 * the window that the objects of the transit belongs has already been created.
25676 * This is because this effect needs the geometry information about the objects,
25677 * and if the window was not created yet, it can get a wrong information.
25679 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25682 * Add the ImageAnimation Effect to Elm_Transit.
25684 * @note This API is one of the facades. It creates image animation effect context
25685 * and add it's required APIs to elm_transit_effect_add.
25686 * The @p images parameter is a list images paths. This list and
25687 * its contents will be deleted at the end of the effect by
25688 * elm_transit_effect_image_animation_context_free() function.
25692 * char buf[PATH_MAX];
25693 * Eina_List *images = NULL;
25694 * Elm_Transit *transi = elm_transit_add();
25696 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25697 * images = eina_list_append(images, eina_stringshare_add(buf));
25699 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25700 * images = eina_list_append(images, eina_stringshare_add(buf));
25701 * elm_transit_effect_image_animation_add(transi, images);
25705 * @see elm_transit_effect_add()
25707 * @param transit Transit object.
25708 * @param images Eina_List of images file paths. This list and
25709 * its contents will be deleted at the end of the effect by
25710 * elm_transit_effect_image_animation_context_free() function.
25711 * @return Image Animation effect context data.
25715 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25720 typedef struct _Elm_Store Elm_Store;
25721 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25722 typedef struct _Elm_Store_Item Elm_Store_Item;
25723 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25724 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25725 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25726 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25727 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25728 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25729 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25730 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25732 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25733 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25734 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25735 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25739 ELM_STORE_ITEM_MAPPING_NONE = 0,
25740 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25741 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25742 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25743 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25744 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25745 // can add more here as needed by common apps
25746 ELM_STORE_ITEM_MAPPING_LAST
25747 } Elm_Store_Item_Mapping_Type;
25749 struct _Elm_Store_Item_Mapping_Icon
25751 // FIXME: allow edje file icons
25753 Elm_Icon_Lookup_Order lookup_order;
25754 Eina_Bool standard_name : 1;
25755 Eina_Bool no_scale : 1;
25756 Eina_Bool smooth : 1;
25757 Eina_Bool scale_up : 1;
25758 Eina_Bool scale_down : 1;
25761 struct _Elm_Store_Item_Mapping_Empty
25766 struct _Elm_Store_Item_Mapping_Photo
25771 struct _Elm_Store_Item_Mapping_Custom
25773 Elm_Store_Item_Mapping_Cb func;
25776 struct _Elm_Store_Item_Mapping
25778 Elm_Store_Item_Mapping_Type type;
25783 Elm_Store_Item_Mapping_Empty empty;
25784 Elm_Store_Item_Mapping_Icon icon;
25785 Elm_Store_Item_Mapping_Photo photo;
25786 Elm_Store_Item_Mapping_Custom custom;
25787 // add more types here
25791 struct _Elm_Store_Item_Info
25793 Elm_Genlist_Item_Class *item_class;
25794 const Elm_Store_Item_Mapping *mapping;
25799 struct _Elm_Store_Item_Info_Filesystem
25801 Elm_Store_Item_Info base;
25805 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25806 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25808 EAPI void elm_store_free(Elm_Store *st);
25810 EAPI Elm_Store *elm_store_filesystem_new(void);
25811 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25812 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25813 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25815 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25817 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25818 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25819 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25820 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25821 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25822 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25824 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25825 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25826 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25827 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25828 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25829 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25830 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25833 * @defgroup SegmentControl SegmentControl
25834 * @ingroup Elementary
25836 * @image html img/widget/segment_control/preview-00.png
25837 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25839 * @image html img/segment_control.png
25840 * @image latex img/segment_control.eps width=\textwidth
25842 * Segment control widget is a horizontal control made of multiple segment
25843 * items, each segment item functioning similar to discrete two state button.
25844 * A segment control groups the items together and provides compact
25845 * single button with multiple equal size segments.
25847 * Segment item size is determined by base widget
25848 * size and the number of items added.
25849 * Only one segment item can be at selected state. A segment item can display
25850 * combination of Text and any Evas_Object like Images or other widget.
25852 * Smart callbacks one can listen to:
25853 * - "changed" - When the user clicks on a segment item which is not
25854 * previously selected and get selected. The event_info parameter is the
25855 * segment item index.
25857 * Available styles for it:
25860 * Here is an example on its usage:
25861 * @li @ref segment_control_example
25865 * @addtogroup SegmentControl
25869 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25872 * Add a new segment control widget to the given parent Elementary
25873 * (container) object.
25875 * @param parent The parent object.
25876 * @return a new segment control widget handle or @c NULL, on errors.
25878 * This function inserts a new segment control widget on the canvas.
25880 * @ingroup SegmentControl
25882 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25885 * Append a new item to the segment control object.
25887 * @param obj The segment control object.
25888 * @param icon The icon object to use for the left side of the item. An
25889 * icon can be any Evas object, but usually it is an icon created
25890 * with elm_icon_add().
25891 * @param label The label of the item.
25892 * Note that, NULL is different from empty string "".
25893 * @return The created item or @c NULL upon failure.
25895 * A new item will be created and appended to the segment control, i.e., will
25896 * be set as @b last item.
25898 * If it should be inserted at another position,
25899 * elm_segment_control_item_insert_at() should be used instead.
25901 * Items created with this function can be deleted with function
25902 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25904 * @note @p label set to @c NULL is different from empty string "".
25906 * only has icon, it will be displayed bigger and centered. If it has
25907 * icon and label, even that an empty string, icon will be smaller and
25908 * positioned at left.
25912 * sc = elm_segment_control_add(win);
25913 * ic = elm_icon_add(win);
25914 * elm_icon_file_set(ic, "path/to/image", NULL);
25915 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25916 * elm_segment_control_item_add(sc, ic, "label");
25917 * evas_object_show(sc);
25920 * @see elm_segment_control_item_insert_at()
25921 * @see elm_segment_control_item_del()
25923 * @ingroup SegmentControl
25925 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25928 * Insert a new item to the segment control object at specified position.
25930 * @param obj The segment control object.
25931 * @param icon The icon object to use for the left side of the item. An
25932 * icon can be any Evas object, but usually it is an icon created
25933 * with elm_icon_add().
25934 * @param label The label of the item.
25935 * @param index Item position. Value should be between 0 and items count.
25936 * @return The created item or @c NULL upon failure.
25938 * Index values must be between @c 0, when item will be prepended to
25939 * segment control, and items count, that can be get with
25940 * elm_segment_control_item_count_get(), case when item will be appended
25941 * to segment control, just like elm_segment_control_item_add().
25943 * Items created with this function can be deleted with function
25944 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25946 * @note @p label set to @c NULL is different from empty string "".
25948 * only has icon, it will be displayed bigger and centered. If it has
25949 * icon and label, even that an empty string, icon will be smaller and
25950 * positioned at left.
25952 * @see elm_segment_control_item_add()
25953 * @see elm_segment_control_count_get()
25954 * @see elm_segment_control_item_del()
25956 * @ingroup SegmentControl
25958 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);
25961 * Remove a segment control item from its parent, deleting it.
25963 * @param it The item to be removed.
25965 * Items can be added with elm_segment_control_item_add() or
25966 * elm_segment_control_item_insert_at().
25968 * @ingroup SegmentControl
25970 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25973 * Remove a segment control item at given index from its parent,
25976 * @param obj The segment control object.
25977 * @param index The position of the segment control item to be deleted.
25979 * Items can be added with elm_segment_control_item_add() or
25980 * elm_segment_control_item_insert_at().
25982 * @ingroup SegmentControl
25984 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25987 * Get the Segment items count from segment control.
25989 * @param obj The segment control object.
25990 * @return Segment items count.
25992 * It will just return the number of items added to segment control @p obj.
25994 * @ingroup SegmentControl
25996 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25999 * Get the item placed at specified index.
26001 * @param obj The segment control object.
26002 * @param index The index of the segment item.
26003 * @return The segment control item or @c NULL on failure.
26005 * Index is the position of an item in segment control widget. Its
26006 * range is from @c 0 to <tt> count - 1 </tt>.
26007 * Count is the number of items, that can be get with
26008 * elm_segment_control_item_count_get().
26010 * @ingroup SegmentControl
26012 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26015 * Get the label of item.
26017 * @param obj The segment control object.
26018 * @param index The index of the segment item.
26019 * @return The label of the item at @p index.
26021 * The return value is a pointer to the label associated to the item when
26022 * it was created, with function elm_segment_control_item_add(), or later
26023 * with function elm_segment_control_item_label_set. If no label
26024 * was passed as argument, it will return @c NULL.
26026 * @see elm_segment_control_item_label_set() for more details.
26027 * @see elm_segment_control_item_add()
26029 * @ingroup SegmentControl
26031 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26034 * Set the label of item.
26036 * @param it The item of segment control.
26037 * @param text The label of item.
26039 * The label to be displayed by the item.
26040 * Label will be at right of the icon (if set).
26042 * If a label was passed as argument on item creation, with function
26043 * elm_control_segment_item_add(), it will be already
26044 * displayed by the item.
26046 * @see elm_segment_control_item_label_get()
26047 * @see elm_segment_control_item_add()
26049 * @ingroup SegmentControl
26051 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26054 * Get the icon associated to the item.
26056 * @param obj The segment control object.
26057 * @param index The index of the segment item.
26058 * @return The left side icon associated to the item at @p index.
26060 * The return value is a pointer to the icon associated to the item when
26061 * it was created, with function elm_segment_control_item_add(), or later
26062 * with function elm_segment_control_item_icon_set(). If no icon
26063 * was passed as argument, it will return @c NULL.
26065 * @see elm_segment_control_item_add()
26066 * @see elm_segment_control_item_icon_set()
26068 * @ingroup SegmentControl
26070 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26073 * Set the icon associated to the item.
26075 * @param it The segment control item.
26076 * @param icon The icon object to associate with @p it.
26078 * The icon object to use at left side of the item. An
26079 * icon can be any Evas object, but usually it is an icon created
26080 * with elm_icon_add().
26082 * Once the icon object is set, a previously set one will be deleted.
26083 * @warning Setting the same icon for two items will cause the icon to
26084 * dissapear from the first item.
26086 * If an icon was passed as argument on item creation, with function
26087 * elm_segment_control_item_add(), it will be already
26088 * associated to the item.
26090 * @see elm_segment_control_item_add()
26091 * @see elm_segment_control_item_icon_get()
26093 * @ingroup SegmentControl
26095 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26098 * Get the index of an item.
26100 * @param it The segment control item.
26101 * @return The position of item in segment control widget.
26103 * Index is the position of an item in segment control widget. Its
26104 * range is from @c 0 to <tt> count - 1 </tt>.
26105 * Count is the number of items, that can be get with
26106 * elm_segment_control_item_count_get().
26108 * @ingroup SegmentControl
26110 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26113 * Get the base object of the item.
26115 * @param it The segment control item.
26116 * @return The base object associated with @p it.
26118 * Base object is the @c Evas_Object that represents that item.
26120 * @ingroup SegmentControl
26122 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26125 * Get the selected item.
26127 * @param obj The segment control object.
26128 * @return The selected item or @c NULL if none of segment items is
26131 * The selected item can be unselected with function
26132 * elm_segment_control_item_selected_set().
26134 * The selected item always will be highlighted on segment control.
26136 * @ingroup SegmentControl
26138 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26141 * Set the selected state of an item.
26143 * @param it The segment control item
26144 * @param select The selected state
26146 * This sets the selected state of the given item @p it.
26147 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26149 * If a new item is selected the previosly selected will be unselected.
26150 * Previoulsy selected item can be get with function
26151 * elm_segment_control_item_selected_get().
26153 * The selected item always will be highlighted on segment control.
26155 * @see elm_segment_control_item_selected_get()
26157 * @ingroup SegmentControl
26159 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26166 * @defgroup Grid Grid
26168 * The grid is a grid layout widget that lays out a series of children as a
26169 * fixed "grid" of widgets using a given percentage of the grid width and
26170 * height each using the child object.
26172 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26173 * widgets size itself. The default is 100 x 100, so that means the
26174 * position and sizes of children will effectively be percentages (0 to 100)
26175 * of the width or height of the grid widget
26181 * Add a new grid to the parent
26183 * @param parent The parent object
26184 * @return The new object or NULL if it cannot be created
26188 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26191 * Set the virtual size of the grid
26193 * @param obj The grid object
26194 * @param w The virtual width of the grid
26195 * @param h The virtual height of the grid
26199 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26202 * Get the virtual size of the grid
26204 * @param obj The grid object
26205 * @param w Pointer to integer to store the virtual width of the grid
26206 * @param h Pointer to integer to store the virtual height of the grid
26210 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26213 * Pack child at given position and size
26215 * @param obj The grid object
26216 * @param subobj The child to pack
26217 * @param x The virtual x coord at which to pack it
26218 * @param y The virtual y coord at which to pack it
26219 * @param w The virtual width at which to pack it
26220 * @param h The virtual height at which to pack it
26224 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26227 * Unpack a child from a grid object
26229 * @param obj The grid object
26230 * @param subobj The child to unpack
26234 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26237 * Faster way to remove all child objects from a grid object.
26239 * @param obj The grid object
26240 * @param clear If true, it will delete just removed children
26244 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26247 * Set packing of an existing child at to position and size
26249 * @param subobj The child to set packing of
26250 * @param x The virtual x coord at which to pack it
26251 * @param y The virtual y coord at which to pack it
26252 * @param w The virtual width at which to pack it
26253 * @param h The virtual height at which to pack it
26257 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26260 * get packing of a child
26262 * @param subobj The child to query
26263 * @param x Pointer to integer to store the virtual x coord
26264 * @param y Pointer to integer to store the virtual y coord
26265 * @param w Pointer to integer to store the virtual width
26266 * @param h Pointer to integer to store the virtual height
26270 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26276 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26277 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26278 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26281 * @defgroup Video Video
26283 * This object display an player that let you control an Elm_Video
26284 * object. It take care of updating it's content according to what is
26285 * going on inside the Emotion object. It does activate the remember
26286 * function on the linked Elm_Video object.
26288 * Signals that you cann add callback for are :
26290 * "forward,clicked" - the user clicked the forward button.
26291 * "info,clicked" - the user clicked the info button.
26292 * "next,clicked" - the user clicked the next button.
26293 * "pause,clicked" - the user clicked the pause button.
26294 * "play,clicked" - the user clicked the play button.
26295 * "prev,clicked" - the user clicked the prev button.
26296 * "rewind,clicked" - the user clicked the rewind button.
26297 * "stop,clicked" - the user clicked the stop button.
26299 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26300 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26301 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26302 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26303 EAPI void elm_video_play(Evas_Object *video);
26304 EAPI void elm_video_pause(Evas_Object *video);
26305 EAPI void elm_video_stop(Evas_Object *video);
26306 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26307 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26308 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26309 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26310 EAPI double elm_video_audio_level_get(Evas_Object *video);
26311 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26312 EAPI double elm_video_play_position_get(Evas_Object *video);
26313 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26314 EAPI double elm_video_play_length_get(Evas_Object *video);
26315 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26316 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26317 EAPI const char *elm_video_title_get(Evas_Object *video);
26319 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26320 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26323 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26324 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);
26325 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26326 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26327 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26328 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26329 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26330 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26331 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26332 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26333 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26334 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26335 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26336 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26337 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);