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 which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320 /* Standard headers for standard system calls etc. */
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #include <sys/param.h>
341 # ifdef ELM_LIBINTL_H
342 # include <libintl.h>
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # define alloca _alloca
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Ecore_Con.h>
379 # include <Efreet_Mime.h>
380 # include <Efreet_Trash.h>
384 # include <Ethumb_Client.h>
396 # ifdef ELEMENTARY_BUILD
398 # define EAPI __declspec(dllexport)
401 # endif /* ! DLL_EXPORT */
403 # define EAPI __declspec(dllimport)
404 # endif /* ! EFL_EVAS_BUILD */
408 # define EAPI __attribute__ ((visibility("default")))
415 #endif /* ! _WIN32 */
418 /* allow usage from c++ */
423 #define ELM_VERSION_MAJOR @VMAJ@
424 #define ELM_VERSION_MINOR @VMIN@
426 typedef struct _Elm_Version
434 EAPI extern Elm_Version *elm_version;
437 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
438 #define ELM_PI 3.14159265358979323846
441 * @defgroup General General
443 * @brief General Elementary API. Functions that don't relate to
444 * Elementary objects specifically.
446 * Here are documented functions which init/shutdown the library,
447 * that apply to generic Elementary objects, that deal with
448 * configuration, et cetera.
450 * @ref general_functions_example_page "This" example contemplates
451 * some of these functions.
455 * @addtogroup General
460 * Defines couple of standard Evas_Object layers to be used
461 * with evas_object_layer_set().
463 * @note whenever extending with new values, try to keep some padding
464 * to siblings so there is room for further extensions.
466 typedef enum _Elm_Object_Layer
468 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
469 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
470 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
471 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
472 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
473 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
476 /**************************************************************************/
477 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
480 * Emitted when any Elementary's policy value is changed.
482 EAPI extern int ELM_EVENT_POLICY_CHANGED;
485 * @typedef Elm_Event_Policy_Changed
487 * Data on the event when an Elementary policy has changed
489 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
492 * @struct _Elm_Event_Policy_Changed
494 * Data on the event when an Elementary policy has changed
496 struct _Elm_Event_Policy_Changed
498 unsigned int policy; /**< the policy identifier */
499 int new_value; /**< value the policy had before the change */
500 int old_value; /**< new value the policy got */
504 * Policy identifiers.
506 typedef enum _Elm_Policy
508 ELM_POLICY_QUIT, /**< under which circumstances the application
509 * should quit automatically. @see
513 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
516 typedef enum _Elm_Policy_Quit
518 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
520 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
522 * window is closed */
523 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
525 typedef enum _Elm_Focus_Direction
529 } Elm_Focus_Direction;
531 typedef enum _Elm_Text_Format
533 ELM_TEXT_FORMAT_PLAIN_UTF8,
534 ELM_TEXT_FORMAT_MARKUP_UTF8
538 * Line wrapping types.
540 typedef enum _Elm_Wrap_Type
542 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
543 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
544 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
545 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
551 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
552 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
553 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
554 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
555 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
556 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
557 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
559 ELM_INPUT_PANEL_LAYOUT_INVALID
560 } Elm_Input_Panel_Layout;
564 ELM_AUTOCAPITAL_TYPE_NONE,
565 ELM_AUTOCAPITAL_TYPE_WORD,
566 ELM_AUTOCAPITAL_TYPE_SENTENCE,
567 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
568 } Elm_Autocapital_Type;
571 * @typedef Elm_Object_Item
572 * An Elementary Object item handle.
575 typedef struct _Elm_Object_Item Elm_Object_Item;
579 * Called back when a widget's tooltip is activated and needs content.
580 * @param data user-data given to elm_object_tooltip_content_cb_set()
581 * @param obj owner widget.
583 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
586 * Called back when a widget's item tooltip is activated and needs content.
587 * @param data user-data given to elm_object_tooltip_content_cb_set()
588 * @param obj owner widget.
589 * @param item context dependent item. As an example, if tooltip was
590 * set on Elm_List_Item, then it is of this type.
592 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
594 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
596 #ifndef ELM_LIB_QUICKLAUNCH
597 #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 */
599 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
602 /**************************************************************************/
606 * Initialize Elementary
608 * @param[in] argc System's argument count value
609 * @param[in] argv System's pointer to array of argument strings
610 * @return The init counter value.
612 * This function initializes Elementary and increments a counter of
613 * the number of calls to it. It returns the new counter's value.
615 * @warning This call is exported only for use by the @c ELM_MAIN()
616 * macro. There is no need to use this if you use this macro (which
617 * is highly advisable). An elm_main() should contain the entry
618 * point code for your application, having the same prototype as
619 * elm_init(), and @b not being static (putting the @c EAPI symbol
620 * in front of its type declaration is advisable). The @c
621 * ELM_MAIN() call should be placed just after it.
624 * @dontinclude bg_example_01.c
628 * See the full @ref bg_example_01_c "example".
630 * @see elm_shutdown().
633 EAPI int elm_init(int argc, char **argv);
636 * Shut down Elementary
638 * @return The init counter value.
640 * This should be called at the end of your application, just
641 * before it ceases to do any more processing. This will clean up
642 * any permanent resources your application may have allocated via
643 * Elementary that would otherwise persist.
645 * @see elm_init() for an example
649 EAPI int elm_shutdown(void);
652 * Run Elementary's main loop
654 * This call should be issued just after all initialization is
655 * completed. This function will not return until elm_exit() is
656 * called. It will keep looping, running the main
657 * (event/processing) loop for Elementary.
659 * @see elm_init() for an example
663 EAPI void elm_run(void);
666 * Exit Elementary's main loop
668 * If this call is issued, it will flag the main loop to cease
669 * processing and return back to its parent function (usually your
670 * elm_main() function).
672 * @see elm_init() for an example. There, just after a request to
673 * close the window comes, the main loop will be left.
675 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
676 * applications, you'll be able to get this function called automatically for you.
680 EAPI void elm_exit(void);
683 * Provide information in order to make Elementary determine the @b
684 * run time location of the software in question, so other data files
685 * such as images, sound files, executable utilities, libraries,
686 * modules and locale files can be found.
688 * @param mainfunc This is your application's main function name,
689 * whose binary's location is to be found. Providing @c NULL
690 * will make Elementary not to use it
691 * @param dom This will be used as the application's "domain", in the
692 * form of a prefix to any environment variables that may
693 * override prefix detection and the directory name, inside the
694 * standard share or data directories, where the software's
695 * data files will be looked for.
696 * @param checkfile This is an (optional) magic file's path to check
697 * for existence (and it must be located in the data directory,
698 * under the share directory provided above). Its presence will
699 * help determine the prefix found was correct. Pass @c NULL if
700 * the check is not to be done.
702 * This function allows one to re-locate the application somewhere
703 * else after compilation, if the developer wishes for easier
704 * distribution of pre-compiled binaries.
706 * The prefix system is designed to locate where the given software is
707 * installed (under a common path prefix) at run time and then report
708 * specific locations of this prefix and common directories inside
709 * this prefix like the binary, library, data and locale directories,
710 * through the @c elm_app_*_get() family of functions.
712 * Call elm_app_info_set() early on before you change working
713 * directory or anything about @c argv[0], so it gets accurate
716 * It will then try and trace back which file @p mainfunc comes from,
717 * if provided, to determine the application's prefix directory.
719 * The @p dom parameter provides a string prefix to prepend before
720 * environment variables, allowing a fallback to @b specific
721 * environment variables to locate the software. You would most
722 * probably provide a lowercase string there, because it will also
723 * serve as directory domain, explained next. For environment
724 * variables purposes, this string is made uppercase. For example if
725 * @c "myapp" is provided as the prefix, then the program would expect
726 * @c "MYAPP_PREFIX" as a master environment variable to specify the
727 * exact install prefix for the software, or more specific environment
728 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
729 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
730 * the user or scripts before launching. If not provided (@c NULL),
731 * environment variables will not be used to override compiled-in
732 * defaults or auto detections.
734 * The @p dom string also provides a subdirectory inside the system
735 * shared data directory for data files. For example, if the system
736 * directory is @c /usr/local/share, then this directory name is
737 * appended, creating @c /usr/local/share/myapp, if it @p was @c
738 * "myapp". It is expected that the application installs data files in
741 * The @p checkfile is a file name or path of something inside the
742 * share or data directory to be used to test that the prefix
743 * detection worked. For example, your app will install a wallpaper
744 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
745 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
748 * @see elm_app_compile_bin_dir_set()
749 * @see elm_app_compile_lib_dir_set()
750 * @see elm_app_compile_data_dir_set()
751 * @see elm_app_compile_locale_set()
752 * @see elm_app_prefix_dir_get()
753 * @see elm_app_bin_dir_get()
754 * @see elm_app_lib_dir_get()
755 * @see elm_app_data_dir_get()
756 * @see elm_app_locale_dir_get()
758 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
761 * Provide information on the @b fallback application's binaries
762 * directory, in scenarios where they get overriden by
763 * elm_app_info_set().
765 * @param dir The path to the default binaries directory (compile time
768 * @note Elementary will as well use this path to determine actual
769 * names of binaries' directory paths, maybe changing it to be @c
770 * something/local/bin instead of @c something/bin, only, for
773 * @warning You should call this function @b before
774 * elm_app_info_set().
776 EAPI void elm_app_compile_bin_dir_set(const char *dir);
779 * Provide information on the @b fallback application's libraries
780 * directory, on scenarios where they get overriden by
781 * elm_app_info_set().
783 * @param dir The path to the default libraries directory (compile
786 * @note Elementary will as well use this path to determine actual
787 * names of libraries' directory paths, maybe changing it to be @c
788 * something/lib32 or @c something/lib64 instead of @c something/lib,
791 * @warning You should call this function @b before
792 * elm_app_info_set().
794 EAPI void elm_app_compile_lib_dir_set(const char *dir);
797 * Provide information on the @b fallback application's data
798 * directory, on scenarios where they get overriden by
799 * elm_app_info_set().
801 * @param dir The path to the default data directory (compile time
804 * @note Elementary will as well use this path to determine actual
805 * names of data directory paths, maybe changing it to be @c
806 * something/local/share instead of @c something/share, only, for
809 * @warning You should call this function @b before
810 * elm_app_info_set().
812 EAPI void elm_app_compile_data_dir_set(const char *dir);
815 * Provide information on the @b fallback application's locale
816 * directory, on scenarios where they get overriden by
817 * elm_app_info_set().
819 * @param dir The path to the default locale directory (compile time
822 * @warning You should call this function @b before
823 * elm_app_info_set().
825 EAPI void elm_app_compile_locale_set(const char *dir);
828 * Retrieve the application's run time prefix directory, as set by
829 * elm_app_info_set() and the way (environment) the application was
832 * @return The directory prefix the application is actually using.
834 EAPI const char *elm_app_prefix_dir_get(void);
837 * Retrieve the application's run time binaries prefix directory, as
838 * set by elm_app_info_set() and the way (environment) the application
841 * @return The binaries directory prefix the application is actually
844 EAPI const char *elm_app_bin_dir_get(void);
847 * Retrieve the application's run time libraries prefix directory, as
848 * set by elm_app_info_set() and the way (environment) the application
851 * @return The libraries directory prefix the application is actually
854 EAPI const char *elm_app_lib_dir_get(void);
857 * Retrieve the application's run time data prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The data directory prefix the application is actually
864 EAPI const char *elm_app_data_dir_get(void);
867 * Retrieve the application's run time locale prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The locale directory prefix the application is actually
874 EAPI const char *elm_app_locale_dir_get(void);
876 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
877 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
878 EAPI int elm_quicklaunch_init(int argc, char **argv);
879 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
880 EAPI int elm_quicklaunch_sub_shutdown(void);
881 EAPI int elm_quicklaunch_shutdown(void);
882 EAPI void elm_quicklaunch_seed(void);
883 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
884 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
885 EAPI void elm_quicklaunch_cleanup(void);
886 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
887 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
889 EAPI Eina_Bool elm_need_efreet(void);
890 EAPI Eina_Bool elm_need_e_dbus(void);
891 EAPI Eina_Bool elm_need_ethumb(void);
894 * Set a new policy's value (for a given policy group/identifier).
896 * @param policy policy identifier, as in @ref Elm_Policy.
897 * @param value policy value, which depends on the identifier
899 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
901 * Elementary policies define applications' behavior,
902 * somehow. These behaviors are divided in policy groups (see
903 * #Elm_Policy enumeration). This call will emit the Ecore event
904 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
905 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
908 * @note Currently, we have only one policy identifier/group
909 * (#ELM_POLICY_QUIT), which has two possible values.
913 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
916 * Gets the policy value for given policy identifier.
918 * @param policy policy identifier, as in #Elm_Policy.
919 * @return The currently set policy value, for that
920 * identifier. Will be @c 0 if @p policy passed is invalid.
924 EAPI int elm_policy_get(unsigned int policy);
927 * Change the language of the current application
929 * The @p lang passed must be the full name of the locale to use, for
930 * example "en_US.utf8" or "es_ES@euro".
932 * Changing language with this function will make Elementary run through
933 * all its widgets, translating strings set with
934 * elm_object_domain_translatable_text_part_set(). This way, an entire
935 * UI can have its language changed without having to restart the program.
937 * For more complex cases, like having formatted strings that need
938 * translation, widgets will also emit a "language,changed" signal that
939 * the user can listen to to manually translate the text.
941 * @param lang Language to set, must be the full name of the locale
945 EAPI void elm_language_set(const char *lang);
948 * Set a label of an object
950 * @param obj The Elementary object
951 * @param part The text part name to set (NULL for the default label)
952 * @param label The new text of the label
954 * @note Elementary objects may have many labels (e.g. Action Slider)
958 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
960 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
963 * Get a label of an object
965 * @param obj The Elementary object
966 * @param part The text part name to get (NULL for the default label)
967 * @return text of the label or NULL for any error
969 * @note Elementary objects may have many labels (e.g. Action Slider)
973 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
975 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
978 * Set a content of an object
980 * @param obj The Elementary object
981 * @param part The content part name to set (NULL for the default content)
982 * @param content The new content of the object
984 * @note Elementary objects may have many contents
988 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
990 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
993 * Get a content of an object
995 * @param obj The Elementary object
996 * @param item The content part name to get (NULL for the default content)
997 * @return content of the object or NULL for any error
999 * @note Elementary objects may have many contents
1003 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1005 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1008 * Unset a content of an object
1010 * @param obj The Elementary object
1011 * @param item The content part name to unset (NULL for the default content)
1013 * @note Elementary objects may have many contents
1017 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1019 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1022 * Set a content of an object item
1024 * @param it The Elementary object item
1025 * @param part The content part name to set (NULL for the default content)
1026 * @param content The new content of the object item
1028 * @note Elementary object items may have many contents
1032 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1034 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1037 * Get a content of an object item
1039 * @param it The Elementary object item
1040 * @param part The content part name to unset (NULL for the default content)
1041 * @return content of the object item or NULL for any error
1043 * @note Elementary object items may have many contents
1047 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1049 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1052 * Unset a content of an object item
1054 * @param it The Elementary object item
1055 * @param part The content part name to unset (NULL for the default content)
1057 * @note Elementary object items may have many contents
1061 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1063 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1066 * Set a label of an object item
1068 * @param it The Elementary object item
1069 * @param part The text part name to set (NULL for the default label)
1070 * @param label The new text of the label
1072 * @note Elementary object items may have many labels
1076 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1078 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1081 * Get a label of an object item
1083 * @param it The Elementary object item
1084 * @param part The text part name to get (NULL for the default label)
1085 * @return text of the label or NULL for any error
1087 * @note Elementary object items may have many labels
1091 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1093 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1096 * Set the text to read out when in accessibility mode
1098 * @param obj The object which is to be described
1099 * @param txt The text that describes the widget to people with poor or no vision
1103 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1106 * Set the text to read out when in accessibility mode
1108 * @param it The object item which is to be described
1109 * @param txt The text that describes the widget to people with poor or no vision
1113 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1116 * Get the data associated with an object item
1117 * @param it The object item
1118 * @return The data associated with @p it
1122 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1125 * Set the data associated with an object item
1126 * @param it The object item
1127 * @param data The data to be associated with @p it
1131 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1134 * Send a signal to the edje object of the widget item.
1136 * This function sends a signal to the edje object of the obj item. An
1137 * edje program can respond to a signal by specifying matching
1138 * 'signal' and 'source' fields.
1140 * @param it The Elementary object item
1141 * @param emission The signal's name.
1142 * @param source The signal's source.
1145 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1152 * @defgroup Caches Caches
1154 * These are functions which let one fine-tune some cache values for
1155 * Elementary applications, thus allowing for performance adjustments.
1161 * @brief Flush all caches.
1163 * Frees all data that was in cache and is not currently being used to reduce
1164 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1165 * to calling all of the following functions:
1166 * @li edje_file_cache_flush()
1167 * @li edje_collection_cache_flush()
1168 * @li eet_clearcache()
1169 * @li evas_image_cache_flush()
1170 * @li evas_font_cache_flush()
1171 * @li evas_render_dump()
1172 * @note Evas caches are flushed for every canvas associated with a window.
1176 EAPI void elm_all_flush(void);
1179 * Get the configured cache flush interval time
1181 * This gets the globally configured cache flush interval time, in
1184 * @return The cache flush interval time
1187 * @see elm_all_flush()
1189 EAPI int elm_cache_flush_interval_get(void);
1192 * Set the configured cache flush interval time
1194 * This sets the globally configured cache flush interval time, in ticks
1196 * @param size The cache flush interval time
1199 * @see elm_all_flush()
1201 EAPI void elm_cache_flush_interval_set(int size);
1204 * Set the configured cache flush interval time for all applications on the
1207 * This sets the globally configured cache flush interval time -- in ticks
1208 * -- for all applications on the display.
1210 * @param size The cache flush interval time
1213 EAPI void elm_cache_flush_interval_all_set(int size);
1216 * Get the configured cache flush enabled state
1218 * This gets the globally configured cache flush state - if it is enabled
1219 * or not. When cache flushing is enabled, elementary will regularly
1220 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1221 * memory and allow usage to re-seed caches and data in memory where it
1222 * can do so. An idle application will thus minimise its memory usage as
1223 * data will be freed from memory and not be re-loaded as it is idle and
1224 * not rendering or doing anything graphically right now.
1226 * @return The cache flush state
1229 * @see elm_all_flush()
1231 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1234 * Set the configured cache flush enabled state
1236 * This sets the globally configured cache flush enabled state.
1238 * @param size The cache flush enabled state
1241 * @see elm_all_flush()
1243 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1246 * Set the configured cache flush enabled state for all applications on the
1249 * This sets the globally configured cache flush enabled state for all
1250 * applications on the display.
1252 * @param size The cache flush enabled state
1255 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1258 * Get the configured font cache size
1260 * This gets the globally configured font cache size, in bytes.
1262 * @return The font cache size
1265 EAPI int elm_font_cache_get(void);
1268 * Set the configured font cache size
1270 * This sets the globally configured font cache size, in bytes
1272 * @param size The font cache size
1275 EAPI void elm_font_cache_set(int size);
1278 * Set the configured font cache size for all applications on the
1281 * This sets the globally configured font cache size -- in bytes
1282 * -- for all applications on the display.
1284 * @param size The font cache size
1287 EAPI void elm_font_cache_all_set(int size);
1290 * Get the configured image cache size
1292 * This gets the globally configured image cache size, in bytes
1294 * @return The image cache size
1297 EAPI int elm_image_cache_get(void);
1300 * Set the configured image cache size
1302 * This sets the globally configured image cache size, in bytes
1304 * @param size The image cache size
1307 EAPI void elm_image_cache_set(int size);
1310 * Set the configured image cache size for all applications on the
1313 * This sets the globally configured image cache size -- in bytes
1314 * -- for all applications on the display.
1316 * @param size The image cache size
1319 EAPI void elm_image_cache_all_set(int size);
1322 * Get the configured edje file cache size.
1324 * This gets the globally configured edje file cache size, in number
1327 * @return The edje file cache size
1330 EAPI int elm_edje_file_cache_get(void);
1333 * Set the configured edje file cache size
1335 * This sets the globally configured edje file cache size, in number
1338 * @param size The edje file cache size
1341 EAPI void elm_edje_file_cache_set(int size);
1344 * Set the configured edje file cache size for all applications on the
1347 * This sets the globally configured edje file cache size -- in number
1348 * of files -- for all applications on the display.
1350 * @param size The edje file cache size
1353 EAPI void elm_edje_file_cache_all_set(int size);
1356 * Get the configured edje collections (groups) cache size.
1358 * This gets the globally configured edje collections cache size, in
1359 * number of collections.
1361 * @return The edje collections cache size
1364 EAPI int elm_edje_collection_cache_get(void);
1367 * Set the configured edje collections (groups) cache size
1369 * This sets the globally configured edje collections cache size, in
1370 * number of collections.
1372 * @param size The edje collections cache size
1375 EAPI void elm_edje_collection_cache_set(int size);
1378 * Set the configured edje collections (groups) cache size for all
1379 * applications on the display
1381 * This sets the globally configured edje collections cache size -- in
1382 * number of collections -- for all applications on the display.
1384 * @param size The edje collections cache size
1387 EAPI void elm_edje_collection_cache_all_set(int size);
1394 * @defgroup Scaling Widget Scaling
1396 * Different widgets can be scaled independently. These functions
1397 * allow you to manipulate this scaling on a per-widget basis. The
1398 * object and all its children get their scaling factors multiplied
1399 * by the scale factor set. This is multiplicative, in that if a
1400 * child also has a scale size set it is in turn multiplied by its
1401 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1402 * double size, @c 0.5 is half, etc.
1404 * @ref general_functions_example_page "This" example contemplates
1405 * some of these functions.
1409 * Set the scaling factor for a given Elementary object
1411 * @param obj The Elementary to operate on
1412 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1417 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1420 * Get the scaling factor for a given Elementary object
1422 * @param obj The object
1423 * @return The scaling factor set by elm_object_scale_set()
1427 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1430 * @defgroup Password_last_show Password last input show
1432 * Last show feature of password mode enables user to view
1433 * the last input entered for few seconds before masking it.
1434 * These functions allow to set this feature in password mode
1435 * of entry widget and also allow to manipulate the duration
1436 * for which the input has to be visible.
1442 * Get show last setting of password mode.
1444 * This gets the show last input setting of password mode which might be
1445 * enabled or disabled.
1447 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1449 * @ingroup Password_last_show
1451 EAPI Eina_Bool elm_password_show_last_get(void);
1454 * Set show last setting in password mode.
1456 * This enables or disables show last setting of password mode.
1458 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1459 * @see elm_password_show_last_timeout_set()
1460 * @ingroup Password_last_show
1462 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1465 * Get's the timeout value in last show password mode.
1467 * This gets the time out value for which the last input entered in password
1468 * mode will be visible.
1470 * @return The timeout value of last show password mode.
1471 * @ingroup Password_last_show
1473 EAPI double elm_password_show_last_timeout_get(void);
1476 * Set's the timeout value in last show password mode.
1478 * This sets the time out value for which the last input entered in password
1479 * mode will be visible.
1481 * @param password_show_last_timeout The timeout value.
1482 * @see elm_password_show_last_set()
1483 * @ingroup Password_last_show
1485 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1492 * @defgroup UI-Mirroring Selective Widget mirroring
1494 * These functions allow you to set ui-mirroring on specific
1495 * widgets or the whole interface. Widgets can be in one of two
1496 * modes, automatic and manual. Automatic means they'll be changed
1497 * according to the system mirroring mode and manual means only
1498 * explicit changes will matter. You are not supposed to change
1499 * mirroring state of a widget set to automatic, will mostly work,
1500 * but the behavior is not really defined.
1506 * Get the system mirrored mode. This determines the default mirrored mode
1509 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1511 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1514 * Set the system mirrored mode. This determines the default mirrored mode
1517 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1519 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1522 * Returns the widget's mirrored mode setting.
1524 * @param obj The widget.
1525 * @return mirrored mode setting of the object.
1528 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1531 * Sets the widget's mirrored mode setting.
1532 * When widget in automatic mode, it follows the system mirrored mode set by
1533 * elm_mirrored_set().
1534 * @param obj The widget.
1535 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1537 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1544 * Set the style to use by a widget
1546 * Sets the style name that will define the appearance of a widget. Styles
1547 * vary from widget to widget and may also be defined by other themes
1548 * by means of extensions and overlays.
1550 * @param obj The Elementary widget to style
1551 * @param style The style name to use
1553 * @see elm_theme_extension_add()
1554 * @see elm_theme_extension_del()
1555 * @see elm_theme_overlay_add()
1556 * @see elm_theme_overlay_del()
1560 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1562 * Get the style used by the widget
1564 * This gets the style being used for that widget. Note that the string
1565 * pointer is only valid as longas the object is valid and the style doesn't
1568 * @param obj The Elementary widget to query for its style
1569 * @return The style name used
1571 * @see elm_object_style_set()
1575 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1578 * @defgroup Styles Styles
1580 * Widgets can have different styles of look. These generic API's
1581 * set styles of widgets, if they support them (and if the theme(s)
1584 * @ref general_functions_example_page "This" example contemplates
1585 * some of these functions.
1589 * Set the disabled state of an Elementary object.
1591 * @param obj The Elementary object to operate on
1592 * @param disabled The state to put in in: @c EINA_TRUE for
1593 * disabled, @c EINA_FALSE for enabled
1595 * Elementary objects can be @b disabled, in which state they won't
1596 * receive input and, in general, will be themed differently from
1597 * their normal state, usually greyed out. Useful for contexts
1598 * where you don't want your users to interact with some of the
1599 * parts of you interface.
1601 * This sets the state for the widget, either disabling it or
1606 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1609 * Get the disabled state of an Elementary object.
1611 * @param obj The Elementary object to operate on
1612 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1613 * if it's enabled (or on errors)
1615 * This gets the state of the widget, which might be enabled or disabled.
1619 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1622 * @defgroup WidgetNavigation Widget Tree Navigation.
1624 * How to check if an Evas Object is an Elementary widget? How to
1625 * get the first elementary widget that is parent of the given
1626 * object? These are all covered in widget tree navigation.
1628 * @ref general_functions_example_page "This" example contemplates
1629 * some of these functions.
1633 * Check if the given Evas Object is an Elementary widget.
1635 * @param obj the object to query.
1636 * @return @c EINA_TRUE if it is an elementary widget variant,
1637 * @c EINA_FALSE otherwise
1638 * @ingroup WidgetNavigation
1640 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1643 * Get the first parent of the given object that is an Elementary
1646 * @param obj the Elementary object to query parent from.
1647 * @return the parent object that is an Elementary widget, or @c
1648 * NULL, if it was not found.
1650 * Use this to query for an object's parent widget.
1652 * @note Most of Elementary users wouldn't be mixing non-Elementary
1653 * smart objects in the objects tree of an application, as this is
1654 * an advanced usage of Elementary with Evas. So, except for the
1655 * application's window, which is the root of that tree, all other
1656 * objects would have valid Elementary widget parents.
1658 * @ingroup WidgetNavigation
1660 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1663 * Get the top level parent of an Elementary widget.
1665 * @param obj The object to query.
1666 * @return The top level Elementary widget, or @c NULL if parent cannot be
1668 * @ingroup WidgetNavigation
1670 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1673 * Get the string that represents this Elementary widget.
1675 * @note Elementary is weird and exposes itself as a single
1676 * Evas_Object_Smart_Class of type "elm_widget", so
1677 * evas_object_type_get() always return that, making debug and
1678 * language bindings hard. This function tries to mitigate this
1679 * problem, but the solution is to change Elementary to use
1680 * proper inheritance.
1682 * @param obj the object to query.
1683 * @return Elementary widget name, or @c NULL if not a valid widget.
1684 * @ingroup WidgetNavigation
1686 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1689 * @defgroup Config Elementary Config
1691 * Elementary configuration is formed by a set options bounded to a
1692 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1693 * "finger size", etc. These are functions with which one syncronizes
1694 * changes made to those values to the configuration storing files, de
1695 * facto. You most probably don't want to use the functions in this
1696 * group unlees you're writing an elementary configuration manager.
1700 EAPI double elm_scale_get(void);
1701 EAPI void elm_scale_set(double scale);
1702 EAPI void elm_scale_all_set(double scale);
1705 * Save back Elementary's configuration, so that it will persist on
1708 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1711 * This function will take effect -- thus, do I/O -- immediately. Use
1712 * it when you want to apply all configuration changes at once. The
1713 * current configuration set will get saved onto the current profile
1714 * configuration file.
1717 EAPI Eina_Bool elm_mirrored_get(void);
1718 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1721 * Reload Elementary's configuration, bounded to current selected
1724 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1727 * Useful when you want to force reloading of configuration values for
1728 * a profile. If one removes user custom configuration directories,
1729 * for example, it will force a reload with system values insted.
1732 EAPI Eina_Bool elm_config_save(void);
1733 EAPI void elm_config_reload(void);
1740 * @defgroup Profile Elementary Profile
1742 * Profiles are pre-set options that affect the whole look-and-feel of
1743 * Elementary-based applications. There are, for example, profiles
1744 * aimed at desktop computer applications and others aimed at mobile,
1745 * touchscreen-based ones. You most probably don't want to use the
1746 * functions in this group unlees you're writing an elementary
1747 * configuration manager.
1753 * Get Elementary's profile in use.
1755 * This gets the global profile that is applied to all Elementary
1758 * @return The profile's name
1761 EAPI const char *elm_profile_current_get(void);
1764 * Get an Elementary's profile directory path in the filesystem. One
1765 * may want to fetch a system profile's dir or an user one (fetched
1768 * @param profile The profile's name
1769 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1770 * or a system one (@c EINA_FALSE)
1771 * @return The profile's directory path.
1774 * @note You must free it with elm_profile_dir_free().
1776 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1779 * Free an Elementary's profile directory path, as returned by
1780 * elm_profile_dir_get().
1782 * @param p_dir The profile's path
1786 EAPI void elm_profile_dir_free(const char *p_dir);
1789 * Get Elementary's list of available profiles.
1791 * @return The profiles list. List node data are the profile name
1795 * @note One must free this list, after usage, with the function
1796 * elm_profile_list_free().
1798 EAPI Eina_List *elm_profile_list_get(void);
1801 * Free Elementary's list of available profiles.
1803 * @param l The profiles list, as returned by elm_profile_list_get().
1807 EAPI void elm_profile_list_free(Eina_List *l);
1810 * Set Elementary's profile.
1812 * This sets the global profile that is applied to Elementary
1813 * applications. Just the process the call comes from will be
1816 * @param profile The profile's name
1820 EAPI void elm_profile_set(const char *profile);
1823 * Set Elementary's profile.
1825 * This sets the global profile that is applied to all Elementary
1826 * applications. All running Elementary windows will be affected.
1828 * @param profile The profile's name
1832 EAPI void elm_profile_all_set(const char *profile);
1839 * @defgroup Engine Elementary Engine
1841 * These are functions setting and querying which rendering engine
1842 * Elementary will use for drawing its windows' pixels.
1844 * The following are the available engines:
1845 * @li "software_x11"
1848 * @li "software_16_x11"
1849 * @li "software_8_x11"
1852 * @li "software_gdi"
1853 * @li "software_16_wince_gdi"
1855 * @li "software_16_sdl"
1864 * @brief Get Elementary's rendering engine in use.
1866 * @return The rendering engine's name
1867 * @note there's no need to free the returned string, here.
1869 * This gets the global rendering engine that is applied to all Elementary
1872 * @see elm_engine_set()
1874 EAPI const char *elm_engine_current_get(void);
1877 * @brief Set Elementary's rendering engine for use.
1879 * @param engine The rendering engine's name
1881 * This sets global rendering engine that is applied to all Elementary
1882 * applications. Note that it will take effect only to Elementary windows
1883 * created after this is called.
1885 * @see elm_win_add()
1887 EAPI void elm_engine_set(const char *engine);
1894 * @defgroup Fonts Elementary Fonts
1896 * These are functions dealing with font rendering, selection and the
1897 * like for Elementary applications. One might fetch which system
1898 * fonts are there to use and set custom fonts for individual classes
1899 * of UI items containing text (text classes).
1904 typedef struct _Elm_Text_Class
1910 typedef struct _Elm_Font_Overlay
1912 const char *text_class;
1914 Evas_Font_Size size;
1917 typedef struct _Elm_Font_Properties
1921 } Elm_Font_Properties;
1924 * Get Elementary's list of supported text classes.
1926 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1929 * Release the list with elm_text_classes_list_free().
1931 EAPI const Eina_List *elm_text_classes_list_get(void);
1934 * Free Elementary's list of supported text classes.
1938 * @see elm_text_classes_list_get().
1940 EAPI void elm_text_classes_list_free(const Eina_List *list);
1943 * Get Elementary's list of font overlays, set with
1944 * elm_font_overlay_set().
1946 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1951 * For each text class, one can set a <b>font overlay</b> for it,
1952 * overriding the default font properties for that class coming from
1953 * the theme in use. There is no need to free this list.
1955 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1957 EAPI const Eina_List *elm_font_overlay_list_get(void);
1960 * Set a font overlay for a given Elementary text class.
1962 * @param text_class Text class name
1963 * @param font Font name and style string
1964 * @param size Font size
1968 * @p font has to be in the format returned by
1969 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1970 * and elm_font_overlay_unset().
1972 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1975 * Unset a font overlay for a given Elementary text class.
1977 * @param text_class Text class name
1981 * This will bring back text elements belonging to text class
1982 * @p text_class back to their default font settings.
1984 EAPI void elm_font_overlay_unset(const char *text_class);
1987 * Apply the changes made with elm_font_overlay_set() and
1988 * elm_font_overlay_unset() on the current Elementary window.
1992 * This applies all font overlays set to all objects in the UI.
1994 EAPI void elm_font_overlay_apply(void);
1997 * Apply the changes made with elm_font_overlay_set() and
1998 * elm_font_overlay_unset() on all Elementary application windows.
2002 * This applies all font overlays set to all objects in the UI.
2004 EAPI void elm_font_overlay_all_apply(void);
2007 * Translate a font (family) name string in fontconfig's font names
2008 * syntax into an @c Elm_Font_Properties struct.
2010 * @param font The font name and styles string
2011 * @return the font properties struct
2015 * @note The reverse translation can be achived with
2016 * elm_font_fontconfig_name_get(), for one style only (single font
2017 * instance, not family).
2019 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2022 * Free font properties return by elm_font_properties_get().
2024 * @param efp the font properties struct
2028 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2031 * Translate a font name, bound to a style, into fontconfig's font names
2034 * @param name The font (family) name
2035 * @param style The given style (may be @c NULL)
2037 * @return the font name and style string
2041 * @note The reverse translation can be achived with
2042 * elm_font_properties_get(), for one style only (single font
2043 * instance, not family).
2045 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2048 * Free the font string return by elm_font_fontconfig_name_get().
2050 * @param efp the font properties struct
2054 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2057 * Create a font hash table of available system fonts.
2059 * One must call it with @p list being the return value of
2060 * evas_font_available_list(). The hash will be indexed by font
2061 * (family) names, being its values @c Elm_Font_Properties blobs.
2063 * @param list The list of available system fonts, as returned by
2064 * evas_font_available_list().
2065 * @return the font hash.
2069 * @note The user is supposed to get it populated at least with 3
2070 * default font families (Sans, Serif, Monospace), which should be
2071 * present on most systems.
2073 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2076 * Free the hash return by elm_font_available_hash_add().
2078 * @param hash the hash to be freed.
2082 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2089 * @defgroup Fingers Fingers
2091 * Elementary is designed to be finger-friendly for touchscreens,
2092 * and so in addition to scaling for display resolution, it can
2093 * also scale based on finger "resolution" (or size). You can then
2094 * customize the granularity of the areas meant to receive clicks
2097 * Different profiles may have pre-set values for finger sizes.
2099 * @ref general_functions_example_page "This" example contemplates
2100 * some of these functions.
2106 * Get the configured "finger size"
2108 * @return The finger size
2110 * This gets the globally configured finger size, <b>in pixels</b>
2114 EAPI Evas_Coord elm_finger_size_get(void);
2117 * Set the configured finger size
2119 * This sets the globally configured finger size in pixels
2121 * @param size The finger size
2124 EAPI void elm_finger_size_set(Evas_Coord size);
2127 * Set the configured finger size for all applications on the display
2129 * This sets the globally configured finger size in pixels for all
2130 * applications on the display
2132 * @param size The finger size
2135 EAPI void elm_finger_size_all_set(Evas_Coord size);
2142 * @defgroup Focus Focus
2144 * An Elementary application has, at all times, one (and only one)
2145 * @b focused object. This is what determines where the input
2146 * events go to within the application's window. Also, focused
2147 * objects can be decorated differently, in order to signal to the
2148 * user where the input is, at a given moment.
2150 * Elementary applications also have the concept of <b>focus
2151 * chain</b>: one can cycle through all the windows' focusable
2152 * objects by input (tab key) or programmatically. The default
2153 * focus chain for an application is the one define by the order in
2154 * which the widgets where added in code. One will cycle through
2155 * top level widgets, and, for each one containg sub-objects, cycle
2156 * through them all, before returning to the level
2157 * above. Elementary also allows one to set @b custom focus chains
2158 * for their applications.
2160 * Besides the focused decoration a widget may exhibit, when it
2161 * gets focus, Elementary has a @b global focus highlight object
2162 * that can be enabled for a window. If one chooses to do so, this
2163 * extra highlight effect will surround the current focused object,
2166 * @note Some Elementary widgets are @b unfocusable, after
2167 * creation, by their very nature: they are not meant to be
2168 * interacted with input events, but are there just for visual
2171 * @ref general_functions_example_page "This" example contemplates
2172 * some of these functions.
2176 * Get the enable status of the focus highlight
2178 * This gets whether the highlight on focused objects is enabled or not
2181 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2184 * Set the enable status of the focus highlight
2186 * Set whether to show or not the highlight on focused objects
2187 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2190 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2193 * Get the enable status of the highlight animation
2195 * Get whether the focus highlight, if enabled, will animate its switch from
2196 * one object to the next
2199 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2202 * Set the enable status of the highlight animation
2204 * Set whether the focus highlight, if enabled, will animate its switch from
2205 * one object to the next
2206 * @param animate Enable animation if EINA_TRUE, disable otherwise
2209 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2212 * Get the whether an Elementary object has the focus or not.
2214 * @param obj The Elementary object to get the information from
2215 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2216 * not (and on errors).
2218 * @see elm_object_focus_set()
2222 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2225 * Make a given Elementary object the focused one.
2227 * @param obj The Elementary object to make focused.
2229 * @note This object, if it can handle focus, will take the focus
2230 * away from the one who had it previously and will, for now on, be
2231 * the one receiving input events.
2233 * @see elm_object_focus_get()
2237 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2240 * Remove the focus from an Elementary object
2242 * @param obj The Elementary to take focus from
2244 * This removes the focus from @p obj, passing it back to the
2245 * previous element in the focus chain list.
2247 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2251 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2254 * Set the ability for an Element object to be focused
2256 * @param obj The Elementary object to operate on
2257 * @param enable @c EINA_TRUE if the object can be focused, @c
2258 * EINA_FALSE if not (and on errors)
2260 * This sets whether the object @p obj is able to take focus or
2261 * not. Unfocusable objects do nothing when programmatically
2262 * focused, being the nearest focusable parent object the one
2263 * really getting focus. Also, when they receive mouse input, they
2264 * will get the event, but not take away the focus from where it
2269 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2272 * Get whether an Elementary object is focusable or not
2274 * @param obj The Elementary object to operate on
2275 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2276 * EINA_FALSE if not (and on errors)
2278 * @note Objects which are meant to be interacted with by input
2279 * events are created able to be focused, by default. All the
2284 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2287 * Set custom focus chain.
2289 * This function overwrites any previous custom focus chain within
2290 * the list of objects. The previous list will be deleted and this list
2291 * will be managed by elementary. After it is set, don't modify it.
2293 * @note On focus cycle, only will be evaluated children of this container.
2295 * @param obj The container object
2296 * @param objs Chain of objects to pass focus
2299 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2302 * Unset a custom focus chain on a given Elementary widget
2304 * @param obj The container object to remove focus chain from
2306 * Any focus chain previously set on @p obj (for its child objects)
2307 * is removed entirely after this call.
2311 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2314 * Get custom focus chain
2316 * @param obj The container object
2319 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2322 * Append object to custom focus chain.
2324 * @note If relative_child equal to NULL or not in custom chain, the object
2325 * will be added in end.
2327 * @note On focus cycle, only will be evaluated children of this container.
2329 * @param obj The container object
2330 * @param child The child to be added in custom chain
2331 * @param relative_child The relative object to position the child
2334 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2337 * Prepend object to custom focus chain.
2339 * @note If relative_child equal to NULL or not in custom chain, the object
2340 * will be added in begin.
2342 * @note On focus cycle, only will be evaluated children of this container.
2344 * @param obj The container object
2345 * @param child The child to be added in custom chain
2346 * @param relative_child The relative object to position the child
2349 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2352 * Give focus to next object in object tree.
2354 * Give focus to next object in focus chain of one object sub-tree.
2355 * If the last object of chain already have focus, the focus will go to the
2356 * first object of chain.
2358 * @param obj The object root of sub-tree
2359 * @param dir Direction to cycle the focus
2363 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2366 * Give focus to near object in one direction.
2368 * Give focus to near object in direction of one object.
2369 * If none focusable object in given direction, the focus will not change.
2371 * @param obj The reference object
2372 * @param x Horizontal component of direction to focus
2373 * @param y Vertical component of direction to focus
2377 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2380 * Make the elementary object and its children to be unfocusable
2383 * @param obj The Elementary object to operate on
2384 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2385 * @c EINA_FALSE for focusable.
2387 * This sets whether the object @p obj and its children objects
2388 * are able to take focus or not. If the tree is set as unfocusable,
2389 * newest focused object which is not in this tree will get focus.
2390 * This API can be helpful for an object to be deleted.
2391 * When an object will be deleted soon, it and its children may not
2392 * want to get focus (by focus reverting or by other focus controls).
2393 * Then, just use this API before deleting.
2395 * @see elm_object_tree_unfocusable_get()
2399 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2402 * Get whether an Elementary object and its children are unfocusable or not.
2404 * @param obj The Elementary object to get the information from
2405 * @return @c EINA_TRUE, if the tree is unfocussable,
2406 * @c EINA_FALSE if not (and on errors).
2408 * @see elm_object_tree_unfocusable_set()
2412 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2415 * @defgroup Scrolling Scrolling
2417 * These are functions setting how scrollable views in Elementary
2418 * widgets should behave on user interaction.
2424 * Get whether scrollers should bounce when they reach their
2425 * viewport's edge during a scroll.
2427 * @return the thumb scroll bouncing state
2429 * This is the default behavior for touch screens, in general.
2430 * @ingroup Scrolling
2432 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2435 * Set whether scrollers should bounce when they reach their
2436 * viewport's edge during a scroll.
2438 * @param enabled the thumb scroll bouncing state
2440 * @see elm_thumbscroll_bounce_enabled_get()
2441 * @ingroup Scrolling
2443 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2446 * Set whether scrollers should bounce when they reach their
2447 * viewport's edge during a scroll, for all Elementary application
2450 * @param enabled the thumb scroll bouncing state
2452 * @see elm_thumbscroll_bounce_enabled_get()
2453 * @ingroup Scrolling
2455 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2458 * Get the amount of inertia a scroller will impose at bounce
2461 * @return the thumb scroll bounce friction
2463 * @ingroup Scrolling
2465 EAPI double elm_scroll_bounce_friction_get(void);
2468 * Set the amount of inertia a scroller will impose at bounce
2471 * @param friction the thumb scroll bounce friction
2473 * @see elm_thumbscroll_bounce_friction_get()
2474 * @ingroup Scrolling
2476 EAPI void elm_scroll_bounce_friction_set(double friction);
2479 * Set the amount of inertia a scroller will impose at bounce
2480 * animations, for all Elementary application windows.
2482 * @param friction the thumb scroll bounce friction
2484 * @see elm_thumbscroll_bounce_friction_get()
2485 * @ingroup Scrolling
2487 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2490 * Get the amount of inertia a <b>paged</b> scroller will impose at
2491 * page fitting animations.
2493 * @return the page scroll friction
2495 * @ingroup Scrolling
2497 EAPI double elm_scroll_page_scroll_friction_get(void);
2500 * Set the amount of inertia a <b>paged</b> scroller will impose at
2501 * page fitting animations.
2503 * @param friction the page scroll friction
2505 * @see elm_thumbscroll_page_scroll_friction_get()
2506 * @ingroup Scrolling
2508 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2511 * Set the amount of inertia a <b>paged</b> scroller will impose at
2512 * page fitting animations, for all Elementary application windows.
2514 * @param friction the page scroll friction
2516 * @see elm_thumbscroll_page_scroll_friction_get()
2517 * @ingroup Scrolling
2519 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2522 * Get the amount of inertia a scroller will impose at region bring
2525 * @return the bring in scroll friction
2527 * @ingroup Scrolling
2529 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2532 * Set the amount of inertia a scroller will impose at region bring
2535 * @param friction the bring in scroll friction
2537 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2538 * @ingroup Scrolling
2540 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2543 * Set the amount of inertia a scroller will impose at region bring
2544 * animations, for all Elementary application windows.
2546 * @param friction the bring in scroll friction
2548 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2549 * @ingroup Scrolling
2551 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2554 * Get the amount of inertia scrollers will impose at animations
2555 * triggered by Elementary widgets' zooming API.
2557 * @return the zoom friction
2559 * @ingroup Scrolling
2561 EAPI double elm_scroll_zoom_friction_get(void);
2564 * Set the amount of inertia scrollers will impose at animations
2565 * triggered by Elementary widgets' zooming API.
2567 * @param friction the zoom friction
2569 * @see elm_thumbscroll_zoom_friction_get()
2570 * @ingroup Scrolling
2572 EAPI void elm_scroll_zoom_friction_set(double friction);
2575 * Set the amount of inertia scrollers will impose at animations
2576 * triggered by Elementary widgets' zooming API, for all Elementary
2577 * application windows.
2579 * @param friction the zoom friction
2581 * @see elm_thumbscroll_zoom_friction_get()
2582 * @ingroup Scrolling
2584 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2587 * Get whether scrollers should be draggable from any point in their
2590 * @return the thumb scroll state
2592 * @note This is the default behavior for touch screens, in general.
2593 * @note All other functions namespaced with "thumbscroll" will only
2594 * have effect if this mode is enabled.
2596 * @ingroup Scrolling
2598 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2601 * Set whether scrollers should be draggable from any point in their
2604 * @param enabled the thumb scroll state
2606 * @see elm_thumbscroll_enabled_get()
2607 * @ingroup Scrolling
2609 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2612 * Set whether scrollers should be draggable from any point in their
2613 * views, for all Elementary application windows.
2615 * @param enabled the thumb scroll state
2617 * @see elm_thumbscroll_enabled_get()
2618 * @ingroup Scrolling
2620 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2623 * Get the number of pixels one should travel while dragging a
2624 * scroller's view to actually trigger scrolling.
2626 * @return the thumb scroll threshould
2628 * One would use higher values for touch screens, in general, because
2629 * of their inherent imprecision.
2630 * @ingroup Scrolling
2632 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2635 * Set the number of pixels one should travel while dragging a
2636 * scroller's view to actually trigger scrolling.
2638 * @param threshold the thumb scroll threshould
2640 * @see elm_thumbscroll_threshould_get()
2641 * @ingroup Scrolling
2643 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2646 * Set the number of pixels one should travel while dragging a
2647 * scroller's view to actually trigger scrolling, for all Elementary
2648 * application windows.
2650 * @param threshold the thumb scroll threshould
2652 * @see elm_thumbscroll_threshould_get()
2653 * @ingroup Scrolling
2655 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2658 * Get the minimum speed of mouse cursor movement which will trigger
2659 * list self scrolling animation after a mouse up event
2662 * @return the thumb scroll momentum threshould
2664 * @ingroup Scrolling
2666 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2669 * Set the minimum speed of mouse cursor movement which will trigger
2670 * list self scrolling animation after a mouse up event
2673 * @param threshold the thumb scroll momentum threshould
2675 * @see elm_thumbscroll_momentum_threshould_get()
2676 * @ingroup Scrolling
2678 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2681 * Set the minimum speed of mouse cursor movement which will trigger
2682 * list self scrolling animation after a mouse up event
2683 * (pixels/second), for all Elementary application windows.
2685 * @param threshold the thumb scroll momentum threshould
2687 * @see elm_thumbscroll_momentum_threshould_get()
2688 * @ingroup Scrolling
2690 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2693 * Get the amount of inertia a scroller will impose at self scrolling
2696 * @return the thumb scroll friction
2698 * @ingroup Scrolling
2700 EAPI double elm_scroll_thumbscroll_friction_get(void);
2703 * Set the amount of inertia a scroller will impose at self scrolling
2706 * @param friction the thumb scroll friction
2708 * @see elm_thumbscroll_friction_get()
2709 * @ingroup Scrolling
2711 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2714 * Set the amount of inertia a scroller will impose at self scrolling
2715 * animations, for all Elementary application windows.
2717 * @param friction the thumb scroll friction
2719 * @see elm_thumbscroll_friction_get()
2720 * @ingroup Scrolling
2722 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2725 * Get the amount of lag between your actual mouse cursor dragging
2726 * movement and a scroller's view movement itself, while pushing it
2727 * into bounce state manually.
2729 * @return the thumb scroll border friction
2731 * @ingroup Scrolling
2733 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2736 * Set the amount of lag between your actual mouse cursor dragging
2737 * movement and a scroller's view movement itself, while pushing it
2738 * into bounce state manually.
2740 * @param friction the thumb scroll border friction. @c 0.0 for
2741 * perfect synchrony between two movements, @c 1.0 for maximum
2744 * @see elm_thumbscroll_border_friction_get()
2745 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2747 * @ingroup Scrolling
2749 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2752 * Set the amount of lag between your actual mouse cursor dragging
2753 * movement and a scroller's view movement itself, while pushing it
2754 * into bounce state manually, for all Elementary application windows.
2756 * @param friction the thumb scroll border friction. @c 0.0 for
2757 * perfect synchrony between two movements, @c 1.0 for maximum
2760 * @see elm_thumbscroll_border_friction_get()
2761 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2763 * @ingroup Scrolling
2765 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2768 * Get the sensitivity amount which is be multiplied by the length of
2771 * @return the thumb scroll sensitivity friction
2773 * @ingroup Scrolling
2775 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2778 * Set the sensitivity amount which is be multiplied by the length of
2781 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2782 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2785 * @see elm_thumbscroll_sensitivity_friction_get()
2786 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2788 * @ingroup Scrolling
2790 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2793 * Set the sensitivity amount which is be multiplied by the length of
2794 * mouse dragging, for all Elementary application windows.
2796 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2797 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2800 * @see elm_thumbscroll_sensitivity_friction_get()
2801 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2803 * @ingroup Scrolling
2805 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2812 * @defgroup Scrollhints Scrollhints
2814 * Objects when inside a scroller can scroll, but this may not always be
2815 * desirable in certain situations. This allows an object to hint to itself
2816 * and parents to "not scroll" in one of 2 ways. If any child object of a
2817 * scroller has pushed a scroll freeze or hold then it affects all parent
2818 * scrollers until all children have released them.
2820 * 1. To hold on scrolling. This means just flicking and dragging may no
2821 * longer scroll, but pressing/dragging near an edge of the scroller will
2822 * still scroll. This is automatically used by the entry object when
2825 * 2. To totally freeze scrolling. This means it stops. until
2832 * Push the scroll hold by 1
2834 * This increments the scroll hold count by one. If it is more than 0 it will
2835 * take effect on the parents of the indicated object.
2837 * @param obj The object
2838 * @ingroup Scrollhints
2840 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2843 * Pop the scroll hold by 1
2845 * This decrements the scroll hold count by one. If it is more than 0 it will
2846 * take effect on the parents of the indicated object.
2848 * @param obj The object
2849 * @ingroup Scrollhints
2851 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2854 * Push the scroll freeze by 1
2856 * This increments the scroll freeze count by one. If it is more
2857 * than 0 it will take effect on the parents of the indicated
2860 * @param obj The object
2861 * @ingroup Scrollhints
2863 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2866 * Pop the scroll freeze by 1
2868 * This decrements the scroll freeze count by one. If it is more
2869 * than 0 it will take effect on the parents of the indicated
2872 * @param obj The object
2873 * @ingroup Scrollhints
2875 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2878 * Lock the scrolling of the given widget (and thus all parents)
2880 * This locks the given object from scrolling in the X axis (and implicitly
2881 * also locks all parent scrollers too from doing the same).
2883 * @param obj The object
2884 * @param lock The lock state (1 == locked, 0 == unlocked)
2885 * @ingroup Scrollhints
2887 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2890 * Lock the scrolling of the given widget (and thus all parents)
2892 * This locks the given object from scrolling in the Y axis (and implicitly
2893 * also locks all parent scrollers too from doing the same).
2895 * @param obj The object
2896 * @param lock The lock state (1 == locked, 0 == unlocked)
2897 * @ingroup Scrollhints
2899 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2902 * Get the scrolling lock of the given widget
2904 * This gets the lock for X axis scrolling.
2906 * @param obj The object
2907 * @ingroup Scrollhints
2909 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2912 * Get the scrolling lock of the given widget
2914 * This gets the lock for X axis scrolling.
2916 * @param obj The object
2917 * @ingroup Scrollhints
2919 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2926 * Send a signal to the widget edje object.
2928 * This function sends a signal to the edje object of the obj. An
2929 * edje program can respond to a signal by specifying matching
2930 * 'signal' and 'source' fields.
2932 * @param obj The object
2933 * @param emission The signal's name.
2934 * @param source The signal's source.
2937 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2938 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
2939 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
2942 * Add a callback for a signal emitted by widget edje object.
2944 * This function connects a callback function to a signal emitted by the
2945 * edje object of the obj.
2946 * Globs can occur in either the emission or source name.
2948 * @param obj The object
2949 * @param emission The signal's name.
2950 * @param source The signal's source.
2951 * @param func The callback function to be executed when the signal is
2953 * @param data A pointer to data to pass in to the callback function.
2956 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);
2959 * Remove a signal-triggered callback from a widget edje object.
2961 * This function removes a callback, previoulsy attached to a
2962 * signal emitted by the edje object of the obj. The parameters
2963 * emission, source and func must match exactly those passed to a
2964 * previous call to elm_object_signal_callback_add(). The data
2965 * pointer that was passed to this call will be returned.
2967 * @param obj The object
2968 * @param emission The signal's name.
2969 * @param source The signal's source.
2970 * @param func The callback function to be executed when the signal is
2972 * @return The data pointer
2975 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);
2978 * Add a callback for input events (key up, key down, mouse wheel)
2979 * on a given Elementary widget
2981 * @param obj The widget to add an event callback on
2982 * @param func The callback function to be executed when the event
2984 * @param data Data to pass in to @p func
2986 * Every widget in an Elementary interface set to receive focus,
2987 * with elm_object_focus_allow_set(), will propagate @b all of its
2988 * key up, key down and mouse wheel input events up to its parent
2989 * object, and so on. All of the focusable ones in this chain which
2990 * had an event callback set, with this call, will be able to treat
2991 * those events. There are two ways of making the propagation of
2992 * these event upwards in the tree of widgets to @b cease:
2993 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2994 * the event was @b not processed, so the propagation will go on.
2995 * - The @c event_info pointer passed to @p func will contain the
2996 * event's structure and, if you OR its @c event_flags inner
2997 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2998 * one has already handled it, thus killing the event's
3001 * @note Your event callback will be issued on those events taking
3002 * place only if no other child widget of @obj has consumed the
3005 * @note Not to be confused with @c
3006 * evas_object_event_callback_add(), which will add event callbacks
3007 * per type on general Evas objects (no event propagation
3008 * infrastructure taken in account).
3010 * @note Not to be confused with @c
3011 * elm_object_signal_callback_add(), which will add callbacks to @b
3012 * signals coming from a widget's theme, not input events.
3014 * @note Not to be confused with @c
3015 * edje_object_signal_callback_add(), which does the same as
3016 * elm_object_signal_callback_add(), but directly on an Edje
3019 * @note Not to be confused with @c
3020 * evas_object_smart_callback_add(), which adds callbacks to smart
3021 * objects' <b>smart events</b>, and not input events.
3023 * @see elm_object_event_callback_del()
3027 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3030 * Remove an event callback from a widget.
3032 * This function removes a callback, previoulsy attached to event emission
3034 * The parameters func and data must match exactly those passed to
3035 * a previous call to elm_object_event_callback_add(). The data pointer that
3036 * was passed to this call will be returned.
3038 * @param obj The object
3039 * @param func The callback function to be executed when the event is
3041 * @param data Data to pass in to the callback function.
3042 * @return The data pointer
3045 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3048 * Adjust size of an element for finger usage.
3050 * @param times_w How many fingers should fit horizontally
3051 * @param w Pointer to the width size to adjust
3052 * @param times_h How many fingers should fit vertically
3053 * @param h Pointer to the height size to adjust
3055 * This takes width and height sizes (in pixels) as input and a
3056 * size multiple (which is how many fingers you want to place
3057 * within the area, being "finger" the size set by
3058 * elm_finger_size_set()), and adjusts the size to be large enough
3059 * to accommodate the resulting size -- if it doesn't already
3060 * accommodate it. On return the @p w and @p h sizes pointed to by
3061 * these parameters will be modified, on those conditions.
3063 * @note This is kind of a low level Elementary call, most useful
3064 * on size evaluation times for widgets. An external user wouldn't
3065 * be calling, most of the time.
3069 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3072 * Get the duration for occuring long press event.
3074 * @return Timeout for long press event
3075 * @ingroup Longpress
3077 EAPI double elm_longpress_timeout_get(void);
3080 * Set the duration for occuring long press event.
3082 * @param lonpress_timeout Timeout for long press event
3083 * @ingroup Longpress
3085 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3088 * @defgroup Debug Debug
3089 * don't use it unless you are sure
3095 * Print Tree object hierarchy in stdout
3097 * @param obj The root object
3100 EAPI void elm_object_tree_dump(const Evas_Object *top);
3101 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3103 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3104 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3106 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3108 * @param obj The root object
3109 * @param file The path of output file
3112 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3119 * @defgroup Theme Theme
3121 * Elementary uses Edje to theme its widgets, naturally. But for the most
3122 * part this is hidden behind a simpler interface that lets the user set
3123 * extensions and choose the style of widgets in a much easier way.
3125 * Instead of thinking in terms of paths to Edje files and their groups
3126 * each time you want to change the appearance of a widget, Elementary
3127 * works so you can add any theme file with extensions or replace the
3128 * main theme at one point in the application, and then just set the style
3129 * of widgets with elm_object_style_set() and related functions. Elementary
3130 * will then look in its list of themes for a matching group and apply it,
3131 * and when the theme changes midway through the application, all widgets
3132 * will be updated accordingly.
3134 * There are three concepts you need to know to understand how Elementary
3135 * theming works: default theme, extensions and overlays.
3137 * Default theme, obviously enough, is the one that provides the default
3138 * look of all widgets. End users can change the theme used by Elementary
3139 * by setting the @c ELM_THEME environment variable before running an
3140 * application, or globally for all programs using the @c elementary_config
3141 * utility. Applications can change the default theme using elm_theme_set(),
3142 * but this can go against the user wishes, so it's not an adviced practice.
3144 * Ideally, applications should find everything they need in the already
3145 * provided theme, but there may be occasions when that's not enough and
3146 * custom styles are required to correctly express the idea. For this
3147 * cases, Elementary has extensions.
3149 * Extensions allow the application developer to write styles of its own
3150 * to apply to some widgets. This requires knowledge of how each widget
3151 * is themed, as extensions will always replace the entire group used by
3152 * the widget, so important signals and parts need to be there for the
3153 * object to behave properly (see documentation of Edje for details).
3154 * Once the theme for the extension is done, the application needs to add
3155 * it to the list of themes Elementary will look into, using
3156 * elm_theme_extension_add(), and set the style of the desired widgets as
3157 * he would normally with elm_object_style_set().
3159 * Overlays, on the other hand, can replace the look of all widgets by
3160 * overriding the default style. Like extensions, it's up to the application
3161 * developer to write the theme for the widgets it wants, the difference
3162 * being that when looking for the theme, Elementary will check first the
3163 * list of overlays, then the set theme and lastly the list of extensions,
3164 * so with overlays it's possible to replace the default view and every
3165 * widget will be affected. This is very much alike to setting the whole
3166 * theme for the application and will probably clash with the end user
3167 * options, not to mention the risk of ending up with not matching styles
3168 * across the program. Unless there's a very special reason to use them,
3169 * overlays should be avoided for the resons exposed before.
3171 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3172 * keeps one default internally and every function that receives one of
3173 * these can be called with NULL to refer to this default (except for
3174 * elm_theme_free()). It's possible to create a new instance of a
3175 * ::Elm_Theme to set other theme for a specific widget (and all of its
3176 * children), but this is as discouraged, if not even more so, than using
3177 * overlays. Don't use this unless you really know what you are doing.
3179 * But to be less negative about things, you can look at the following
3181 * @li @ref theme_example_01 "Using extensions"
3182 * @li @ref theme_example_02 "Using overlays"
3187 * @typedef Elm_Theme
3189 * Opaque handler for the list of themes Elementary looks for when
3190 * rendering widgets.
3192 * Stay out of this unless you really know what you are doing. For most
3193 * cases, sticking to the default is all a developer needs.
3195 typedef struct _Elm_Theme Elm_Theme;
3198 * Create a new specific theme
3200 * This creates an empty specific theme that only uses the default theme. A
3201 * specific theme has its own private set of extensions and overlays too
3202 * (which are empty by default). Specific themes do not fall back to themes
3203 * of parent objects. They are not intended for this use. Use styles, overlays
3204 * and extensions when needed, but avoid specific themes unless there is no
3205 * other way (example: you want to have a preview of a new theme you are
3206 * selecting in a "theme selector" window. The preview is inside a scroller
3207 * and should display what the theme you selected will look like, but not
3208 * actually apply it yet. The child of the scroller will have a specific
3209 * theme set to show this preview before the user decides to apply it to all
3212 EAPI Elm_Theme *elm_theme_new(void);
3214 * Free a specific theme
3216 * @param th The theme to free
3218 * This frees a theme created with elm_theme_new().
3220 EAPI void elm_theme_free(Elm_Theme *th);
3222 * Copy the theme fom the source to the destination theme
3224 * @param th The source theme to copy from
3225 * @param thdst The destination theme to copy data to
3227 * This makes a one-time static copy of all the theme config, extensions
3228 * and overlays from @p th to @p thdst. If @p th references a theme, then
3229 * @p thdst is also set to reference it, with all the theme settings,
3230 * overlays and extensions that @p th had.
3232 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3234 * Tell the source theme to reference the ref theme
3236 * @param th The theme that will do the referencing
3237 * @param thref The theme that is the reference source
3239 * This clears @p th to be empty and then sets it to refer to @p thref
3240 * so @p th acts as an override to @p thref, but where its overrides
3241 * don't apply, it will fall through to @p thref for configuration.
3243 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3245 * Return the theme referred to
3247 * @param th The theme to get the reference from
3248 * @return The referenced theme handle
3250 * This gets the theme set as the reference theme by elm_theme_ref_set().
3251 * If no theme is set as a reference, NULL is returned.
3253 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3255 * Return the default theme
3257 * @return The default theme handle
3259 * This returns the internal default theme setup handle that all widgets
3260 * use implicitly unless a specific theme is set. This is also often use
3261 * as a shorthand of NULL.
3263 EAPI Elm_Theme *elm_theme_default_get(void);
3265 * Prepends a theme overlay to the list of overlays
3267 * @param th The theme to add to, or if NULL, the default theme
3268 * @param item The Edje file path to be used
3270 * Use this if your application needs to provide some custom overlay theme
3271 * (An Edje file that replaces some default styles of widgets) where adding
3272 * new styles, or changing system theme configuration is not possible. Do
3273 * NOT use this instead of a proper system theme configuration. Use proper
3274 * configuration files, profiles, environment variables etc. to set a theme
3275 * so that the theme can be altered by simple confiugration by a user. Using
3276 * this call to achieve that effect is abusing the API and will create lots
3279 * @see elm_theme_extension_add()
3281 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3283 * Delete a theme overlay from the list of overlays
3285 * @param th The theme to delete from, or if NULL, the default theme
3286 * @param item The name of the theme overlay
3288 * @see elm_theme_overlay_add()
3290 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3292 * Appends a theme extension to the list of extensions.
3294 * @param th The theme to add to, or if NULL, the default theme
3295 * @param item The Edje file path to be used
3297 * This is intended when an application needs more styles of widgets or new
3298 * widget themes that the default does not provide (or may not provide). The
3299 * application has "extended" usage by coming up with new custom style names
3300 * for widgets for specific uses, but as these are not "standard", they are
3301 * not guaranteed to be provided by a default theme. This means the
3302 * application is required to provide these extra elements itself in specific
3303 * Edje files. This call adds one of those Edje files to the theme search
3304 * path to be search after the default theme. The use of this call is
3305 * encouraged when default styles do not meet the needs of the application.
3306 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3308 * @see elm_object_style_set()
3310 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3312 * Deletes a theme extension from the list of extensions.
3314 * @param th The theme to delete from, or if NULL, the default theme
3315 * @param item The name of the theme extension
3317 * @see elm_theme_extension_add()
3319 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3321 * Set the theme search order for the given theme
3323 * @param th The theme to set the search order, or if NULL, the default theme
3324 * @param theme Theme search string
3326 * This sets the search string for the theme in path-notation from first
3327 * theme to search, to last, delimited by the : character. Example:
3329 * "shiny:/path/to/file.edj:default"
3331 * See the ELM_THEME environment variable for more information.
3333 * @see elm_theme_get()
3334 * @see elm_theme_list_get()
3336 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3338 * Return the theme search order
3340 * @param th The theme to get the search order, or if NULL, the default theme
3341 * @return The internal search order path
3343 * This function returns a colon separated string of theme elements as
3344 * returned by elm_theme_list_get().
3346 * @see elm_theme_set()
3347 * @see elm_theme_list_get()
3349 EAPI const char *elm_theme_get(Elm_Theme *th);
3351 * Return a list of theme elements to be used in a theme.
3353 * @param th Theme to get the list of theme elements from.
3354 * @return The internal list of theme elements
3356 * This returns the internal list of theme elements (will only be valid as
3357 * long as the theme is not modified by elm_theme_set() or theme is not
3358 * freed by elm_theme_free(). This is a list of strings which must not be
3359 * altered as they are also internal. If @p th is NULL, then the default
3360 * theme element list is returned.
3362 * A theme element can consist of a full or relative path to a .edj file,
3363 * or a name, without extension, for a theme to be searched in the known
3364 * theme paths for Elemementary.
3366 * @see elm_theme_set()
3367 * @see elm_theme_get()
3369 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3371 * Return the full patrh for a theme element
3373 * @param f The theme element name
3374 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3375 * @return The full path to the file found.
3377 * This returns a string you should free with free() on success, NULL on
3378 * failure. This will search for the given theme element, and if it is a
3379 * full or relative path element or a simple searchable name. The returned
3380 * path is the full path to the file, if searched, and the file exists, or it
3381 * is simply the full path given in the element or a resolved path if
3382 * relative to home. The @p in_search_path boolean pointed to is set to
3383 * EINA_TRUE if the file was a searchable file andis in the search path,
3384 * and EINA_FALSE otherwise.
3386 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3388 * Flush the current theme.
3390 * @param th Theme to flush
3392 * This flushes caches that let elementary know where to find theme elements
3393 * in the given theme. If @p th is NULL, then the default theme is flushed.
3394 * Call this function if source theme data has changed in such a way as to
3395 * make any caches Elementary kept invalid.
3397 EAPI void elm_theme_flush(Elm_Theme *th);
3399 * This flushes all themes (default and specific ones).
3401 * This will flush all themes in the current application context, by calling
3402 * elm_theme_flush() on each of them.
3404 EAPI void elm_theme_full_flush(void);
3406 * Set the theme for all elementary using applications on the current display
3408 * @param theme The name of the theme to use. Format same as the ELM_THEME
3409 * environment variable.
3411 EAPI void elm_theme_all_set(const char *theme);
3413 * Return a list of theme elements in the theme search path
3415 * @return A list of strings that are the theme element names.
3417 * This lists all available theme files in the standard Elementary search path
3418 * for theme elements, and returns them in alphabetical order as theme
3419 * element names in a list of strings. Free this with
3420 * elm_theme_name_available_list_free() when you are done with the list.
3422 EAPI Eina_List *elm_theme_name_available_list_new(void);
3424 * Free the list returned by elm_theme_name_available_list_new()
3426 * This frees the list of themes returned by
3427 * elm_theme_name_available_list_new(). Once freed the list should no longer
3428 * be used. a new list mys be created.
3430 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3432 * Set a specific theme to be used for this object and its children
3434 * @param obj The object to set the theme on
3435 * @param th The theme to set
3437 * This sets a specific theme that will be used for the given object and any
3438 * child objects it has. If @p th is NULL then the theme to be used is
3439 * cleared and the object will inherit its theme from its parent (which
3440 * ultimately will use the default theme if no specific themes are set).
3442 * Use special themes with great care as this will annoy users and make
3443 * configuration difficult. Avoid any custom themes at all if it can be
3446 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3448 * Get the specific theme to be used
3450 * @param obj The object to get the specific theme from
3451 * @return The specifc theme set.
3453 * This will return a specific theme set, or NULL if no specific theme is
3454 * set on that object. It will not return inherited themes from parents, only
3455 * the specific theme set for that specific object. See elm_object_theme_set()
3456 * for more information.
3458 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3461 * Get a data item from a theme
3463 * @param th The theme, or NULL for default theme
3464 * @param key The data key to search with
3465 * @return The data value, or NULL on failure
3467 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3468 * It works the same way as edje_file_data_get() except that the return is stringshared.
3470 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3476 /** @defgroup Win Win
3478 * @image html img/widget/win/preview-00.png
3479 * @image latex img/widget/win/preview-00.eps
3481 * The window class of Elementary. Contains functions to manipulate
3482 * windows. The Evas engine used to render the window contents is specified
3483 * in the system or user elementary config files (whichever is found last),
3484 * and can be overridden with the ELM_ENGINE environment variable for
3485 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3486 * compilation setup and modules actually installed at runtime) are (listed
3487 * in order of best supported and most likely to be complete and work to
3490 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3491 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3493 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3495 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3497 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3499 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3500 * rendering using SDL as the buffer)
3501 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3502 * GDI with software)
3503 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3504 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3505 * grayscale using dedicated 8bit software engine in X11)
3506 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3507 * X11 using 16bit software engine)
3508 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3509 * (Windows CE rendering via GDI with 16bit software renderer)
3510 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3511 * buffer with 16bit software renderer)
3512 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3514 * All engines use a simple string to select the engine to render, EXCEPT
3515 * the "shot" engine. This actually encodes the output of the virtual
3516 * screenshot and how long to delay in the engine string. The engine string
3517 * is encoded in the following way:
3519 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3521 * Where options are separated by a ":" char if more than one option is
3522 * given, with delay, if provided being the first option and file the last
3523 * (order is important). The delay specifies how long to wait after the
3524 * window is shown before doing the virtual "in memory" rendering and then
3525 * save the output to the file specified by the file option (and then exit).
3526 * If no delay is given, the default is 0.5 seconds. If no file is given the
3527 * default output file is "out.png". Repeat option is for continous
3528 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3529 * fixed to "out001.png" Some examples of using the shot engine:
3531 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3532 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3533 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3534 * ELM_ENGINE="shot:delay=2.0" elementary_test
3535 * ELM_ENGINE="shot:" elementary_test
3537 * Signals that you can add callbacks for are:
3539 * @li "delete,request": the user requested to close the window. See
3540 * elm_win_autodel_set().
3541 * @li "focus,in": window got focus
3542 * @li "focus,out": window lost focus
3543 * @li "moved": window that holds the canvas was moved
3546 * @li @ref win_example_01
3551 * Defines the types of window that can be created
3553 * These are hints set on the window so that a running Window Manager knows
3554 * how the window should be handled and/or what kind of decorations it
3557 * Currently, only the X11 backed engines use them.
3559 typedef enum _Elm_Win_Type
3561 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3562 window. Almost every window will be created with this
3564 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3565 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3566 window holding desktop icons. */
3567 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3568 be kept on top of any other window by the Window
3570 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3572 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3573 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3575 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3576 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3577 entry in a menubar is clicked. Typically used
3578 with elm_win_override_set(). This hint exists
3579 for completion only, as the EFL way of
3580 implementing a menu would not normally use a
3581 separate window for its contents. */
3582 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3583 triggered by right-clicking an object. */
3584 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3585 explanatory text that typically appear after the
3586 mouse cursor hovers over an object for a while.
3587 Typically used with elm_win_override_set() and also
3588 not very commonly used in the EFL. */
3589 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3590 battery life or a new E-Mail received. */
3591 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3592 usually used in the EFL. */
3593 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3594 object being dragged across different windows, or even
3595 applications. Typically used with
3596 elm_win_override_set(). */
3597 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3598 buffer. No actual window is created for this
3599 type, instead the window and all of its
3600 contents will be rendered to an image buffer.
3601 This allows to have children window inside a
3602 parent one just like any other object would
3603 be, and do other things like applying @c
3604 Evas_Map effects to it. This is the only type
3605 of window that requires the @c parent
3606 parameter of elm_win_add() to be a valid @c
3611 * The differents layouts that can be requested for the virtual keyboard.
3613 * When the application window is being managed by Illume, it may request
3614 * any of the following layouts for the virtual keyboard.
3616 typedef enum _Elm_Win_Keyboard_Mode
3618 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3619 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3620 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3621 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3622 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3623 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3624 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3625 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3626 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3627 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3628 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3629 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3630 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3631 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3632 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3633 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3634 } Elm_Win_Keyboard_Mode;
3637 * Available commands that can be sent to the Illume manager.
3639 * When running under an Illume session, a window may send commands to the
3640 * Illume manager to perform different actions.
3642 typedef enum _Elm_Illume_Command
3644 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3646 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3648 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3650 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3651 } Elm_Illume_Command;
3654 * Adds a window object. If this is the first window created, pass NULL as
3657 * @param parent Parent object to add the window to, or NULL
3658 * @param name The name of the window
3659 * @param type The window type, one of #Elm_Win_Type.
3661 * The @p parent paramter can be @c NULL for every window @p type except
3662 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3663 * which the image object will be created.
3665 * @return The created object, or NULL on failure
3667 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3669 * Add @p subobj as a resize object of window @p obj.
3672 * Setting an object as a resize object of the window means that the
3673 * @p subobj child's size and position will be controlled by the window
3674 * directly. That is, the object will be resized to match the window size
3675 * and should never be moved or resized manually by the developer.
3677 * In addition, resize objects of the window control what the minimum size
3678 * of it will be, as well as whether it can or not be resized by the user.
3680 * For the end user to be able to resize a window by dragging the handles
3681 * or borders provided by the Window Manager, or using any other similar
3682 * mechanism, all of the resize objects in the window should have their
3683 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3685 * @param obj The window object
3686 * @param subobj The resize object to add
3688 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3690 * Delete @p subobj as a resize object of window @p obj.
3692 * This function removes the object @p subobj from the resize objects of
3693 * the window @p obj. It will not delete the object itself, which will be
3694 * left unmanaged and should be deleted by the developer, manually handled
3695 * or set as child of some other container.
3697 * @param obj The window object
3698 * @param subobj The resize object to add
3700 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3702 * Set the title of the window
3704 * @param obj The window object
3705 * @param title The title to set
3707 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3709 * Get the title of the window
3711 * The returned string is an internal one and should not be freed or
3712 * modified. It will also be rendered invalid if a new title is set or if
3713 * the window is destroyed.
3715 * @param obj The window object
3718 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3720 * Set the window's autodel state.
3722 * When closing the window in any way outside of the program control, like
3723 * pressing the X button in the titlebar or using a command from the
3724 * Window Manager, a "delete,request" signal is emitted to indicate that
3725 * this event occurred and the developer can take any action, which may
3726 * include, or not, destroying the window object.
3728 * When the @p autodel parameter is set, the window will be automatically
3729 * destroyed when this event occurs, after the signal is emitted.
3730 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3731 * and is up to the program to do so when it's required.
3733 * @param obj The window object
3734 * @param autodel If true, the window will automatically delete itself when
3737 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3739 * Get the window's autodel state.
3741 * @param obj The window object
3742 * @return If the window will automatically delete itself when closed
3744 * @see elm_win_autodel_set()
3746 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3748 * Activate a window object.
3750 * This function sends a request to the Window Manager to activate the
3751 * window pointed by @p obj. If honored by the WM, the window will receive
3752 * the keyboard focus.
3754 * @note This is just a request that a Window Manager may ignore, so calling
3755 * this function does not ensure in any way that the window will be the
3756 * active one after it.
3758 * @param obj The window object
3760 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3762 * Lower a window object.
3764 * Places the window pointed by @p obj at the bottom of the stack, so that
3765 * no other window is covered by it.
3767 * If elm_win_override_set() is not set, the Window Manager may ignore this
3770 * @param obj The window object
3772 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3774 * Raise a window object.
3776 * Places the window pointed by @p obj at the top of the stack, so that it's
3777 * not covered by any other window.
3779 * If elm_win_override_set() is not set, the Window Manager may ignore this
3782 * @param obj The window object
3784 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 * Set the borderless state of a window.
3788 * This function requests the Window Manager to not draw any decoration
3789 * around the window.
3791 * @param obj The window object
3792 * @param borderless If true, the window is borderless
3794 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3796 * Get the borderless state of a window.
3798 * @param obj The window object
3799 * @return If true, the window is borderless
3801 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3803 * Set the shaped state of a window.
3805 * Shaped windows, when supported, will render the parts of the window that
3806 * has no content, transparent.
3808 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3809 * background object or cover the entire window in any other way, or the
3810 * parts of the canvas that have no data will show framebuffer artifacts.
3812 * @param obj The window object
3813 * @param shaped If true, the window is shaped
3815 * @see elm_win_alpha_set()
3817 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3819 * Get the shaped state of a window.
3821 * @param obj The window object
3822 * @return If true, the window is shaped
3824 * @see elm_win_shaped_set()
3826 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3828 * Set the alpha channel state of a window.
3830 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3831 * possibly making parts of the window completely or partially transparent.
3832 * This is also subject to the underlying system supporting it, like for
3833 * example, running under a compositing manager. If no compositing is
3834 * available, enabling this option will instead fallback to using shaped
3835 * windows, with elm_win_shaped_set().
3837 * @param obj The window object
3838 * @param alpha If true, the window has an alpha channel
3840 * @see elm_win_alpha_set()
3842 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3844 * Get the transparency state of a window.
3846 * @param obj The window object
3847 * @return If true, the window is transparent
3849 * @see elm_win_transparent_set()
3851 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3853 * Set the transparency state of a window.
3855 * Use elm_win_alpha_set() instead.
3857 * @param obj The window object
3858 * @param transparent If true, the window is transparent
3860 * @see elm_win_alpha_set()
3862 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3864 * Get the alpha channel state of a window.
3866 * @param obj The window object
3867 * @return If true, the window has an alpha channel
3869 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3871 * Set the override state of a window.
3873 * A window with @p override set to EINA_TRUE will not be managed by the
3874 * Window Manager. This means that no decorations of any kind will be shown
3875 * for it, moving and resizing must be handled by the application, as well
3876 * as the window visibility.
3878 * This should not be used for normal windows, and even for not so normal
3879 * ones, it should only be used when there's a good reason and with a lot
3880 * of care. Mishandling override windows may result situations that
3881 * disrupt the normal workflow of the end user.
3883 * @param obj The window object
3884 * @param override If true, the window is overridden
3886 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3888 * Get the override state of a window.
3890 * @param obj The window object
3891 * @return If true, the window is overridden
3893 * @see elm_win_override_set()
3895 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3897 * Set the fullscreen state of a window.
3899 * @param obj The window object
3900 * @param fullscreen If true, the window is fullscreen
3902 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3904 * Get the fullscreen state of a window.
3906 * @param obj The window object
3907 * @return If true, the window is fullscreen
3909 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3911 * Set the maximized state of a window.
3913 * @param obj The window object
3914 * @param maximized If true, the window is maximized
3916 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3918 * Get the maximized state of a window.
3920 * @param obj The window object
3921 * @return If true, the window is maximized
3923 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3925 * Set the iconified state of a window.
3927 * @param obj The window object
3928 * @param iconified If true, the window is iconified
3930 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3932 * Get the iconified state of a window.
3934 * @param obj The window object
3935 * @return If true, the window is iconified
3937 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3939 * Set the layer of the window.
3941 * What this means exactly will depend on the underlying engine used.
3943 * In the case of X11 backed engines, the value in @p layer has the
3944 * following meanings:
3945 * @li < 3: The window will be placed below all others.
3946 * @li > 5: The window will be placed above all others.
3947 * @li other: The window will be placed in the default layer.
3949 * @param obj The window object
3950 * @param layer The layer of the window
3952 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3954 * Get the layer of the window.
3956 * @param obj The window object
3957 * @return The layer of the window
3959 * @see elm_win_layer_set()
3961 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3963 * Set the rotation of the window.
3965 * Most engines only work with multiples of 90.
3967 * This function is used to set the orientation of the window @p obj to
3968 * match that of the screen. The window itself will be resized to adjust
3969 * to the new geometry of its contents. If you want to keep the window size,
3970 * see elm_win_rotation_with_resize_set().
3972 * @param obj The window object
3973 * @param rotation The rotation of the window, in degrees (0-360),
3974 * counter-clockwise.
3976 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3978 * Rotates the window and resizes it.
3980 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3981 * that they fit inside the current window geometry.
3983 * @param obj The window object
3984 * @param layer The rotation of the window in degrees (0-360),
3985 * counter-clockwise.
3987 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3989 * Get the rotation of the window.
3991 * @param obj The window object
3992 * @return The rotation of the window in degrees (0-360)
3994 * @see elm_win_rotation_set()
3995 * @see elm_win_rotation_with_resize_set()
3997 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3999 * Set the sticky state of the window.
4001 * Hints the Window Manager that the window in @p obj should be left fixed
4002 * at its position even when the virtual desktop it's on moves or changes.
4004 * @param obj The window object
4005 * @param sticky If true, the window's sticky state is enabled
4007 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4009 * Get the sticky state of the window.
4011 * @param obj The window object
4012 * @return If true, the window's sticky state is enabled
4014 * @see elm_win_sticky_set()
4016 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Set if this window is an illume conformant window
4020 * @param obj The window object
4021 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4023 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4025 * Get if this window is an illume conformant window
4027 * @param obj The window object
4028 * @return A boolean if this window is illume conformant or not
4030 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4032 * Set a window to be an illume quickpanel window
4034 * By default window objects are not quickpanel windows.
4036 * @param obj The window object
4037 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4039 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4041 * Get if this window is a quickpanel or not
4043 * @param obj The window object
4044 * @return A boolean if this window is a quickpanel or not
4046 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4048 * Set the major priority of a quickpanel window
4050 * @param obj The window object
4051 * @param priority The major priority for this quickpanel
4053 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4055 * Get the major priority of a quickpanel window
4057 * @param obj The window object
4058 * @return The major priority of this quickpanel
4060 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4062 * Set the minor priority of a quickpanel window
4064 * @param obj The window object
4065 * @param priority The minor priority for this quickpanel
4067 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4069 * Get the minor priority of a quickpanel window
4071 * @param obj The window object
4072 * @return The minor priority of this quickpanel
4074 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4076 * Set which zone this quickpanel should appear in
4078 * @param obj The window object
4079 * @param zone The requested zone for this quickpanel
4081 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4083 * Get which zone this quickpanel should appear in
4085 * @param obj The window object
4086 * @return The requested zone for this quickpanel
4088 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4090 * Set the window to be skipped by keyboard focus
4092 * This sets the window to be skipped by normal keyboard input. This means
4093 * a window manager will be asked to not focus this window as well as omit
4094 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4096 * Call this and enable it on a window BEFORE you show it for the first time,
4097 * otherwise it may have no effect.
4099 * Use this for windows that have only output information or might only be
4100 * interacted with by the mouse or fingers, and never for typing input.
4101 * Be careful that this may have side-effects like making the window
4102 * non-accessible in some cases unless the window is specially handled. Use
4105 * @param obj The window object
4106 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4108 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4110 * Send a command to the windowing environment
4112 * This is intended to work in touchscreen or small screen device
4113 * environments where there is a more simplistic window management policy in
4114 * place. This uses the window object indicated to select which part of the
4115 * environment to control (the part that this window lives in), and provides
4116 * a command and an optional parameter structure (use NULL for this if not
4119 * @param obj The window object that lives in the environment to control
4120 * @param command The command to send
4121 * @param params Optional parameters for the command
4123 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4125 * Get the inlined image object handle
4127 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4128 * then the window is in fact an evas image object inlined in the parent
4129 * canvas. You can get this object (be careful to not manipulate it as it
4130 * is under control of elementary), and use it to do things like get pixel
4131 * data, save the image to a file, etc.
4133 * @param obj The window object to get the inlined image from
4134 * @return The inlined image object, or NULL if none exists
4136 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4138 * Set the enabled status for the focus highlight in a window
4140 * This function will enable or disable the focus highlight only for the
4141 * given window, regardless of the global setting for it
4143 * @param obj The window where to enable the highlight
4144 * @param enabled The enabled value for the highlight
4146 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4148 * Get the enabled value of the focus highlight for this window
4150 * @param obj The window in which to check if the focus highlight is enabled
4152 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4154 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4156 * Set the style for the focus highlight on this window
4158 * Sets the style to use for theming the highlight of focused objects on
4159 * the given window. If @p style is NULL, the default will be used.
4161 * @param obj The window where to set the style
4162 * @param style The style to set
4164 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4166 * Get the style set for the focus highlight object
4168 * Gets the style set for this windows highilght object, or NULL if none
4171 * @param obj The window to retrieve the highlights style from
4173 * @return The style set or NULL if none was. Default is used in that case.
4175 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4176 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4177 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4179 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4180 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4181 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4182 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4183 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4184 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4185 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4187 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4188 * (blank mouse, private mouse obj, defaultmouse)
4192 * Sets the keyboard mode of the window.
4194 * @param obj The window object
4195 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4197 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4199 * Gets the keyboard mode of the window.
4201 * @param obj The window object
4202 * @return The mode, one of #Elm_Win_Keyboard_Mode
4204 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4206 * Sets whether the window is a keyboard.
4208 * @param obj The window object
4209 * @param is_keyboard If true, the window is a virtual keyboard
4211 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4213 * Gets whether the window is a keyboard.
4215 * @param obj The window object
4216 * @return If the window is a virtual keyboard
4218 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4221 * Get the screen position of a window.
4223 * @param obj The window object
4224 * @param x The int to store the x coordinate to
4225 * @param y The int to store the y coordinate to
4227 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4233 * @defgroup Inwin Inwin
4235 * @image html img/widget/inwin/preview-00.png
4236 * @image latex img/widget/inwin/preview-00.eps
4237 * @image html img/widget/inwin/preview-01.png
4238 * @image latex img/widget/inwin/preview-01.eps
4239 * @image html img/widget/inwin/preview-02.png
4240 * @image latex img/widget/inwin/preview-02.eps
4242 * An inwin is a window inside a window that is useful for a quick popup.
4243 * It does not hover.
4245 * It works by creating an object that will occupy the entire window, so it
4246 * must be created using an @ref Win "elm_win" as parent only. The inwin
4247 * object can be hidden or restacked below every other object if it's
4248 * needed to show what's behind it without destroying it. If this is done,
4249 * the elm_win_inwin_activate() function can be used to bring it back to
4250 * full visibility again.
4252 * There are three styles available in the default theme. These are:
4253 * @li default: The inwin is sized to take over most of the window it's
4255 * @li minimal: The size of the inwin will be the minimum necessary to show
4257 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4258 * possible, but it's sized vertically the most it needs to fit its\
4261 * Some examples of Inwin can be found in the following:
4262 * @li @ref inwin_example_01
4267 * Adds an inwin to the current window
4269 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4270 * Never call this function with anything other than the top-most window
4271 * as its parameter, unless you are fond of undefined behavior.
4273 * After creating the object, the widget will set itself as resize object
4274 * for the window with elm_win_resize_object_add(), so when shown it will
4275 * appear to cover almost the entire window (how much of it depends on its
4276 * content and the style used). It must not be added into other container
4277 * objects and it needs not be moved or resized manually.
4279 * @param parent The parent object
4280 * @return The new object or NULL if it cannot be created
4282 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4284 * Activates an inwin object, ensuring its visibility
4286 * This function will make sure that the inwin @p obj is completely visible
4287 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4288 * to the front. It also sets the keyboard focus to it, which will be passed
4291 * The object's theme will also receive the signal "elm,action,show" with
4294 * @param obj The inwin to activate
4296 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4298 * Set the content of an inwin object.
4300 * Once the content object is set, a previously set one will be deleted.
4301 * If you want to keep that old content object, use the
4302 * elm_win_inwin_content_unset() function.
4304 * @param obj The inwin object
4305 * @param content The object to set as content
4307 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4309 * Get the content of an inwin object.
4311 * Return the content object which is set for this widget.
4313 * The returned object is valid as long as the inwin is still alive and no
4314 * other content is set on it. Deleting the object will notify the inwin
4315 * about it and this one will be left empty.
4317 * If you need to remove an inwin's content to be reused somewhere else,
4318 * see elm_win_inwin_content_unset().
4320 * @param obj The inwin object
4321 * @return The content that is being used
4323 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 * Unset the content of an inwin object.
4327 * Unparent and return the content object which was set for this widget.
4329 * @param obj The inwin object
4330 * @return The content that was being used
4332 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4336 /* X specific calls - won't work on non-x engines (return 0) */
4339 * Get the Ecore_X_Window of an Evas_Object
4341 * @param obj The object
4343 * @return The Ecore_X_Window of @p obj
4347 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4349 /* smart callbacks called:
4350 * "delete,request" - the user requested to delete the window
4351 * "focus,in" - window got focus
4352 * "focus,out" - window lost focus
4353 * "moved" - window that holds the canvas was moved
4359 * @image html img/widget/bg/preview-00.png
4360 * @image latex img/widget/bg/preview-00.eps
4362 * @brief Background object, used for setting a solid color, image or Edje
4363 * group as background to a window or any container object.
4365 * The bg object is used for setting a solid background to a window or
4366 * packing into any container object. It works just like an image, but has
4367 * some properties useful to a background, like setting it to tiled,
4368 * centered, scaled or stretched.
4370 * Default contents parts of the bg widget that you can use for are:
4371 * @li "elm.swallow.content" - overlay of the bg
4373 * Here is some sample code using it:
4374 * @li @ref bg_01_example_page
4375 * @li @ref bg_02_example_page
4376 * @li @ref bg_03_example_page
4380 typedef enum _Elm_Bg_Option
4382 ELM_BG_OPTION_CENTER, /**< center the background */
4383 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4384 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4385 ELM_BG_OPTION_TILE /**< tile background at its original size */
4389 * Add a new background to the parent
4391 * @param parent The parent object
4392 * @return The new object or NULL if it cannot be created
4396 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4399 * Set the file (image or edje) used for the background
4401 * @param obj The bg object
4402 * @param file The file path
4403 * @param group Optional key (group in Edje) within the file
4405 * This sets the image file used in the background object. The image (or edje)
4406 * will be stretched (retaining aspect if its an image file) to completely fill
4407 * the bg object. This may mean some parts are not visible.
4409 * @note Once the image of @p obj is set, a previously set one will be deleted,
4410 * even if @p file is NULL.
4414 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4417 * Get the file (image or edje) used for the background
4419 * @param obj The bg object
4420 * @param file The file path
4421 * @param group Optional key (group in Edje) within the file
4425 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4428 * Set the option used for the background image
4430 * @param obj The bg object
4431 * @param option The desired background option (TILE, SCALE)
4433 * This sets the option used for manipulating the display of the background
4434 * image. The image can be tiled or scaled.
4438 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4441 * Get the option used for the background image
4443 * @param obj The bg object
4444 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4448 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4450 * Set the option used for the background color
4452 * @param obj The bg object
4457 * This sets the color used for the background rectangle. Its range goes
4462 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4464 * Get the option used for the background color
4466 * @param obj The bg object
4473 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4476 * Set the overlay object used for the background object.
4478 * @param obj The bg object
4479 * @param overlay The overlay object
4481 * This provides a way for elm_bg to have an 'overlay' that will be on top
4482 * of the bg. Once the over object is set, a previously set one will be
4483 * deleted, even if you set the new one to NULL. If you want to keep that
4484 * old content object, use the elm_bg_overlay_unset() function.
4489 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4492 * Get the overlay object used for the background object.
4494 * @param obj The bg object
4495 * @return The content that is being used
4497 * Return the content object which is set for this widget
4501 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4504 * Get the overlay object used for the background object.
4506 * @param obj The bg object
4507 * @return The content that was being used
4509 * Unparent and return the overlay object which was set for this widget
4513 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4516 * Set the size of the pixmap representation of the image.
4518 * This option just makes sense if an image is going to be set in the bg.
4520 * @param obj The bg object
4521 * @param w The new width of the image pixmap representation.
4522 * @param h The new height of the image pixmap representation.
4524 * This function sets a new size for pixmap representation of the given bg
4525 * image. It allows the image to be loaded already in the specified size,
4526 * reducing the memory usage and load time when loading a big image with load
4527 * size set to a smaller size.
4529 * NOTE: this is just a hint, the real size of the pixmap may differ
4530 * depending on the type of image being loaded, being bigger than requested.
4534 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4535 /* smart callbacks called:
4539 * @defgroup Icon Icon
4541 * @image html img/widget/icon/preview-00.png
4542 * @image latex img/widget/icon/preview-00.eps
4544 * An object that provides standard icon images (delete, edit, arrows, etc.)
4545 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4547 * The icon image requested can be in the elementary theme, or in the
4548 * freedesktop.org paths. It's possible to set the order of preference from
4549 * where the image will be used.
4551 * This API is very similar to @ref Image, but with ready to use images.
4553 * Default images provided by the theme are described below.
4555 * The first list contains icons that were first intended to be used in
4556 * toolbars, but can be used in many other places too:
4572 * Now some icons that were designed to be used in menus (but again, you can
4573 * use them anywhere else):
4578 * @li menu/arrow_down
4579 * @li menu/arrow_left
4580 * @li menu/arrow_right
4589 * And here we have some media player specific icons:
4590 * @li media_player/forward
4591 * @li media_player/info
4592 * @li media_player/next
4593 * @li media_player/pause
4594 * @li media_player/play
4595 * @li media_player/prev
4596 * @li media_player/rewind
4597 * @li media_player/stop
4599 * Signals that you can add callbacks for are:
4601 * "clicked" - This is called when a user has clicked the icon
4603 * An example of usage for this API follows:
4604 * @li @ref tutorial_icon
4612 typedef enum _Elm_Icon_Type
4619 * @enum _Elm_Icon_Lookup_Order
4620 * @typedef Elm_Icon_Lookup_Order
4622 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4623 * theme, FDO paths, or both?
4627 typedef enum _Elm_Icon_Lookup_Order
4629 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4630 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4631 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4632 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4633 } Elm_Icon_Lookup_Order;
4636 * Add a new icon object to the parent.
4638 * @param parent The parent object
4639 * @return The new object or NULL if it cannot be created
4641 * @see elm_icon_file_set()
4645 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4647 * Set the file that will be used as icon.
4649 * @param obj The icon object
4650 * @param file The path to file that will be used as icon image
4651 * @param group The group that the icon belongs to an edje file
4653 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4655 * @note The icon image set by this function can be changed by
4656 * elm_icon_standard_set().
4658 * @see elm_icon_file_get()
4662 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4664 * Set a location in memory to be used as an icon
4666 * @param obj The icon object
4667 * @param img The binary data that will be used as an image
4668 * @param size The size of binary data @p img
4669 * @param format Optional format of @p img to pass to the image loader
4670 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4672 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4674 * @note The icon image set by this function can be changed by
4675 * elm_icon_standard_set().
4679 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);
4681 * Get the file that will be used as icon.
4683 * @param obj The icon object
4684 * @param file The path to file that will be used as the icon image
4685 * @param group The group that the icon belongs to, in edje file
4687 * @see elm_icon_file_set()
4691 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4692 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4694 * Set the icon by icon standards names.
4696 * @param obj The icon object
4697 * @param name The icon name
4699 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4701 * For example, freedesktop.org defines standard icon names such as "home",
4702 * "network", etc. There can be different icon sets to match those icon
4703 * keys. The @p name given as parameter is one of these "keys", and will be
4704 * used to look in the freedesktop.org paths and elementary theme. One can
4705 * change the lookup order with elm_icon_order_lookup_set().
4707 * If name is not found in any of the expected locations and it is the
4708 * absolute path of an image file, this image will be used.
4710 * @note The icon image set by this function can be changed by
4711 * elm_icon_file_set().
4713 * @see elm_icon_standard_get()
4714 * @see elm_icon_file_set()
4718 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4720 * Get the icon name set by icon standard names.
4722 * @param obj The icon object
4723 * @return The icon name
4725 * If the icon image was set using elm_icon_file_set() instead of
4726 * elm_icon_standard_set(), then this function will return @c NULL.
4728 * @see elm_icon_standard_set()
4732 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4734 * Set the smooth scaling for an icon object.
4736 * @param obj The icon object
4737 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4738 * otherwise. Default is @c EINA_TRUE.
4740 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4741 * scaling provides a better resulting image, but is slower.
4743 * The smooth scaling should be disabled when making animations that change
4744 * the icon size, since they will be faster. Animations that don't require
4745 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4746 * is already scaled, since the scaled icon image will be cached).
4748 * @see elm_icon_smooth_get()
4752 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4754 * Get whether smooth scaling is enabled for an icon object.
4756 * @param obj The icon object
4757 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4759 * @see elm_icon_smooth_set()
4763 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4765 * Disable scaling of this object.
4767 * @param obj The icon object.
4768 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4769 * otherwise. Default is @c EINA_FALSE.
4771 * This function disables scaling of the icon object through the function
4772 * elm_object_scale_set(). However, this does not affect the object
4773 * size/resize in any way. For that effect, take a look at
4774 * elm_icon_scale_set().
4776 * @see elm_icon_no_scale_get()
4777 * @see elm_icon_scale_set()
4778 * @see elm_object_scale_set()
4782 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4784 * Get whether scaling is disabled on the object.
4786 * @param obj The icon object
4787 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4789 * @see elm_icon_no_scale_set()
4793 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4795 * Set if the object is (up/down) resizable.
4797 * @param obj The icon object
4798 * @param scale_up A bool to set if the object is resizable up. Default is
4800 * @param scale_down A bool to set if the object is resizable down. Default
4803 * This function limits the icon object resize ability. If @p scale_up is set to
4804 * @c EINA_FALSE, the object can't have its height or width resized to a value
4805 * higher than the original icon size. Same is valid for @p scale_down.
4807 * @see elm_icon_scale_get()
4811 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4813 * Get if the object is (up/down) resizable.
4815 * @param obj The icon object
4816 * @param scale_up A bool to set if the object is resizable up
4817 * @param scale_down A bool to set if the object is resizable down
4819 * @see elm_icon_scale_set()
4823 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4825 * Get the object's image size
4827 * @param obj The icon object
4828 * @param w A pointer to store the width in
4829 * @param h A pointer to store the height in
4833 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4835 * Set if the icon fill the entire object area.
4837 * @param obj The icon object
4838 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4839 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4841 * When the icon object is resized to a different aspect ratio from the
4842 * original icon image, the icon image will still keep its aspect. This flag
4843 * tells how the image should fill the object's area. They are: keep the
4844 * entire icon inside the limits of height and width of the object (@p
4845 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4846 * of the object, and the icon will fill the entire object (@p fill_outside
4849 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4850 * retain property to false. Thus, the icon image will always keep its
4851 * original aspect ratio.
4853 * @see elm_icon_fill_outside_get()
4854 * @see elm_image_fill_outside_set()
4858 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4860 * Get if the object is filled outside.
4862 * @param obj The icon object
4863 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4865 * @see elm_icon_fill_outside_set()
4869 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4871 * Set the prescale size for the icon.
4873 * @param obj The icon object
4874 * @param size The prescale size. This value is used for both width and
4877 * This function sets a new size for pixmap representation of the given
4878 * icon. It allows the icon to be loaded already in the specified size,
4879 * reducing the memory usage and load time when loading a big icon with load
4880 * size set to a smaller size.
4882 * It's equivalent to the elm_bg_load_size_set() function for bg.
4884 * @note this is just a hint, the real size of the pixmap may differ
4885 * depending on the type of icon being loaded, being bigger than requested.
4887 * @see elm_icon_prescale_get()
4888 * @see elm_bg_load_size_set()
4892 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4894 * Get the prescale size for the icon.
4896 * @param obj The icon object
4897 * @return The prescale size
4899 * @see elm_icon_prescale_set()
4903 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4905 * Sets the icon lookup order used by elm_icon_standard_set().
4907 * @param obj The icon object
4908 * @param order The icon lookup order (can be one of
4909 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4910 * or ELM_ICON_LOOKUP_THEME)
4912 * @see elm_icon_order_lookup_get()
4913 * @see Elm_Icon_Lookup_Order
4917 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4919 * Gets the icon lookup order.
4921 * @param obj The icon object
4922 * @return The icon lookup order
4924 * @see elm_icon_order_lookup_set()
4925 * @see Elm_Icon_Lookup_Order
4929 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4931 * Get if the icon supports animation or not.
4933 * @param obj The icon object
4934 * @return @c EINA_TRUE if the icon supports animation,
4935 * @c EINA_FALSE otherwise.
4937 * Return if this elm icon's image can be animated. Currently Evas only
4938 * supports gif animation. If the return value is EINA_FALSE, other
4939 * elm_icon_animated_XXX APIs won't work.
4942 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4944 * Set animation mode of the icon.
4946 * @param obj The icon object
4947 * @param anim @c EINA_TRUE if the object do animation job,
4948 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4950 * Since the default animation mode is set to EINA_FALSE,
4951 * the icon is shown without animation.
4952 * This might be desirable when the application developer wants to show
4953 * a snapshot of the animated icon.
4954 * Set it to EINA_TRUE when the icon needs to be animated.
4957 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4959 * Get animation mode of the icon.
4961 * @param obj The icon object
4962 * @return The animation mode of the icon object
4963 * @see elm_icon_animated_set
4966 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4968 * Set animation play mode of the icon.
4970 * @param obj The icon object
4971 * @param play @c EINA_TRUE the object play animation images,
4972 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4974 * To play elm icon's animation, set play to EINA_TURE.
4975 * For example, you make gif player using this set/get API and click event.
4977 * 1. Click event occurs
4978 * 2. Check play flag using elm_icon_animaged_play_get
4979 * 3. If elm icon was playing, set play to EINA_FALSE.
4980 * Then animation will be stopped and vice versa
4983 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4985 * Get animation play mode of the icon.
4987 * @param obj The icon object
4988 * @return The play mode of the icon object
4990 * @see elm_icon_animated_play_get
4993 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4995 /* compatibility code to avoid API and ABI breaks */
4996 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
4998 elm_icon_animated_set(obj, animated);
5001 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5003 return elm_icon_animated_get(obj);
5006 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5008 elm_icon_animated_play_set(obj, play);
5011 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5013 return elm_icon_animated_play_get(obj);
5021 * @defgroup Image Image
5023 * @image html img/widget/image/preview-00.png
5024 * @image latex img/widget/image/preview-00.eps
5027 * An object that allows one to load an image file to it. It can be used
5028 * anywhere like any other elementary widget.
5030 * This widget provides most of the functionality provided from @ref Bg or @ref
5031 * Icon, but with a slightly different API (use the one that fits better your
5034 * The features not provided by those two other image widgets are:
5035 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5036 * @li change the object orientation with elm_image_orient_set();
5037 * @li and turning the image editable with elm_image_editable_set().
5039 * Signals that you can add callbacks for are:
5041 * @li @c "clicked" - This is called when a user has clicked the image
5043 * An example of usage for this API follows:
5044 * @li @ref tutorial_image
5053 * @enum _Elm_Image_Orient
5054 * @typedef Elm_Image_Orient
5056 * Possible orientation options for elm_image_orient_set().
5058 * @image html elm_image_orient_set.png
5059 * @image latex elm_image_orient_set.eps width=\textwidth
5063 typedef enum _Elm_Image_Orient
5065 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5066 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5067 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5068 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5069 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5070 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5071 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5072 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5076 * Add a new image to the parent.
5078 * @param parent The parent object
5079 * @return The new object or NULL if it cannot be created
5081 * @see elm_image_file_set()
5085 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5087 * Set the file that will be used as image.
5089 * @param obj The image object
5090 * @param file The path to file that will be used as image
5091 * @param group The group that the image belongs in edje file (if it's an
5094 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5096 * @see elm_image_file_get()
5100 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5102 * Get the file that will be used as image.
5104 * @param obj The image object
5105 * @param file The path to file
5106 * @param group The group that the image belongs in edje file
5108 * @see elm_image_file_set()
5112 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5114 * Set the smooth effect for an image.
5116 * @param obj The image object
5117 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5118 * otherwise. Default is @c EINA_TRUE.
5120 * Set the scaling algorithm to be used when scaling the image. Smooth
5121 * scaling provides a better resulting image, but is slower.
5123 * The smooth scaling should be disabled when making animations that change
5124 * the image size, since it will be faster. Animations that don't require
5125 * resizing of the image can keep the smooth scaling enabled (even if the
5126 * image is already scaled, since the scaled image will be cached).
5128 * @see elm_image_smooth_get()
5132 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5134 * Get the smooth effect for an image.
5136 * @param obj The image object
5137 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5139 * @see elm_image_smooth_get()
5143 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5146 * Gets the current size of the image.
5148 * @param obj The image object.
5149 * @param w Pointer to store width, or NULL.
5150 * @param h Pointer to store height, or NULL.
5152 * This is the real size of the image, not the size of the object.
5154 * On error, neither w or h will be written.
5158 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5160 * Disable scaling of this object.
5162 * @param obj The image object.
5163 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5164 * otherwise. Default is @c EINA_FALSE.
5166 * This function disables scaling of the elm_image widget through the
5167 * function elm_object_scale_set(). However, this does not affect the widget
5168 * size/resize in any way. For that effect, take a look at
5169 * elm_image_scale_set().
5171 * @see elm_image_no_scale_get()
5172 * @see elm_image_scale_set()
5173 * @see elm_object_scale_set()
5177 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5179 * Get whether scaling is disabled on the object.
5181 * @param obj The image object
5182 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5184 * @see elm_image_no_scale_set()
5188 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5190 * Set if the object is (up/down) resizable.
5192 * @param obj The image object
5193 * @param scale_up A bool to set if the object is resizable up. Default is
5195 * @param scale_down A bool to set if the object is resizable down. Default
5198 * This function limits the image resize ability. If @p scale_up is set to
5199 * @c EINA_FALSE, the object can't have its height or width resized to a value
5200 * higher than the original image size. Same is valid for @p scale_down.
5202 * @see elm_image_scale_get()
5206 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5208 * Get if the object is (up/down) resizable.
5210 * @param obj The image object
5211 * @param scale_up A bool to set if the object is resizable up
5212 * @param scale_down A bool to set if the object is resizable down
5214 * @see elm_image_scale_set()
5218 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5220 * Set if the image fills the entire object area, when keeping the aspect ratio.
5222 * @param obj The image object
5223 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5224 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5226 * When the image should keep its aspect ratio even if resized to another
5227 * aspect ratio, there are two possibilities to resize it: keep the entire
5228 * image inside the limits of height and width of the object (@p fill_outside
5229 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5230 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5232 * @note This option will have no effect if
5233 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5235 * @see elm_image_fill_outside_get()
5236 * @see elm_image_aspect_ratio_retained_set()
5240 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5242 * Get if the object is filled outside
5244 * @param obj The image object
5245 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5247 * @see elm_image_fill_outside_set()
5251 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5253 * Set the prescale size for the image
5255 * @param obj The image object
5256 * @param size The prescale size. This value is used for both width and
5259 * This function sets a new size for pixmap representation of the given
5260 * image. It allows the image to be loaded already in the specified size,
5261 * reducing the memory usage and load time when loading a big image with load
5262 * size set to a smaller size.
5264 * It's equivalent to the elm_bg_load_size_set() function for bg.
5266 * @note this is just a hint, the real size of the pixmap may differ
5267 * depending on the type of image being loaded, being bigger than requested.
5269 * @see elm_image_prescale_get()
5270 * @see elm_bg_load_size_set()
5274 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5276 * Get the prescale size for the image
5278 * @param obj The image object
5279 * @return The prescale size
5281 * @see elm_image_prescale_set()
5285 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5287 * Set the image orientation.
5289 * @param obj The image object
5290 * @param orient The image orientation @ref Elm_Image_Orient
5291 * Default is #ELM_IMAGE_ORIENT_NONE.
5293 * This function allows to rotate or flip the given image.
5295 * @see elm_image_orient_get()
5296 * @see @ref Elm_Image_Orient
5300 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5302 * Get the image orientation.
5304 * @param obj The image object
5305 * @return The image orientation @ref Elm_Image_Orient
5307 * @see elm_image_orient_set()
5308 * @see @ref Elm_Image_Orient
5312 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314 * Make the image 'editable'.
5316 * @param obj Image object.
5317 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5319 * This means the image is a valid drag target for drag and drop, and can be
5320 * cut or pasted too.
5324 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5326 * Check if the image 'editable'.
5328 * @param obj Image object.
5329 * @return Editability.
5331 * A return value of EINA_TRUE means the image is a valid drag target
5332 * for drag and drop, and can be cut or pasted too.
5336 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5338 * Get the basic Evas_Image object from this object (widget).
5340 * @param obj The image object to get the inlined image from
5341 * @return The inlined image object, or NULL if none exists
5343 * This function allows one to get the underlying @c Evas_Object of type
5344 * Image from this elementary widget. It can be useful to do things like get
5345 * the pixel data, save the image to a file, etc.
5347 * @note Be careful to not manipulate it, as it is under control of
5352 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5354 * Set whether the original aspect ratio of the image should be kept on resize.
5356 * @param obj The image object.
5357 * @param retained @c EINA_TRUE if the image should retain the aspect,
5358 * @c EINA_FALSE otherwise.
5360 * The original aspect ratio (width / height) of the image is usually
5361 * distorted to match the object's size. Enabling this option will retain
5362 * this original aspect, and the way that the image is fit into the object's
5363 * area depends on the option set by elm_image_fill_outside_set().
5365 * @see elm_image_aspect_ratio_retained_get()
5366 * @see elm_image_fill_outside_set()
5370 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5372 * Get if the object retains the original aspect ratio.
5374 * @param obj The image object.
5375 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5380 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5387 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5389 /* old API compatibility */
5390 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5392 typedef enum _Elm_GLView_Mode
5394 ELM_GLVIEW_ALPHA = 1,
5395 ELM_GLVIEW_DEPTH = 2,
5396 ELM_GLVIEW_STENCIL = 4
5400 * Defines a policy for the glview resizing.
5402 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5404 typedef enum _Elm_GLView_Resize_Policy
5406 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5407 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5408 } Elm_GLView_Resize_Policy;
5410 typedef enum _Elm_GLView_Render_Policy
5412 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5413 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5414 } Elm_GLView_Render_Policy;
5419 * A simple GLView widget that allows GL rendering.
5421 * Signals that you can add callbacks for are:
5427 * Add a new glview to the parent
5429 * @param parent The parent object
5430 * @return The new object or NULL if it cannot be created
5434 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5437 * Sets the size of the glview
5439 * @param obj The glview object
5440 * @param width width of the glview object
5441 * @param height height of the glview object
5445 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5448 * Gets the size of the glview.
5450 * @param obj The glview object
5451 * @param width width of the glview object
5452 * @param height height of the glview object
5454 * Note that this function returns the actual image size of the
5455 * glview. This means that when the scale policy is set to
5456 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5461 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5464 * Gets the gl api struct for gl rendering
5466 * @param obj The glview object
5467 * @return The api object or NULL if it cannot be created
5471 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5474 * Set the mode of the GLView. Supports Three simple modes.
5476 * @param obj The glview object
5477 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5478 * @return True if set properly.
5482 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5485 * Set the resize policy for the glview object.
5487 * @param obj The glview object.
5488 * @param policy The scaling policy.
5490 * By default, the resize policy is set to
5491 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5492 * destroys the previous surface and recreates the newly specified
5493 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5494 * however, glview only scales the image object and not the underlying
5499 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5502 * Set the render policy for the glview object.
5504 * @param obj The glview object.
5505 * @param policy The render policy.
5507 * By default, the render policy is set to
5508 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5509 * that during the render loop, glview is only redrawn if it needs
5510 * to be redrawn. (i.e. When it is visible) If the policy is set to
5511 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5512 * whether it is visible/need redrawing or not.
5516 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5519 * Set the init function that runs once in the main loop.
5521 * @param obj The glview object.
5522 * @param func The init function to be registered.
5524 * The registered init function gets called once during the render loop.
5528 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5531 * Set the render function that runs in the main loop.
5533 * @param obj The glview object.
5534 * @param func The delete function to be registered.
5536 * The registered del function gets called when GLView object is deleted.
5540 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5543 * Set the resize function that gets called when resize happens.
5545 * @param obj The glview object.
5546 * @param func The resize function to be registered.
5550 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5553 * Set the render function that runs in the main loop.
5555 * @param obj The glview object.
5556 * @param func The render function to be registered.
5560 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5563 * Notifies that there has been changes in the GLView.
5565 * @param obj The glview object.
5569 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5579 * @image html img/widget/box/preview-00.png
5580 * @image latex img/widget/box/preview-00.eps width=\textwidth
5582 * @image html img/box.png
5583 * @image latex img/box.eps width=\textwidth
5585 * A box arranges objects in a linear fashion, governed by a layout function
5586 * that defines the details of this arrangement.
5588 * By default, the box will use an internal function to set the layout to
5589 * a single row, either vertical or horizontal. This layout is affected
5590 * by a number of parameters, such as the homogeneous flag set by
5591 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5592 * elm_box_align_set() and the hints set to each object in the box.
5594 * For this default layout, it's possible to change the orientation with
5595 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5596 * placing its elements ordered from top to bottom. When horizontal is set,
5597 * the order will go from left to right. If the box is set to be
5598 * homogeneous, every object in it will be assigned the same space, that
5599 * of the largest object. Padding can be used to set some spacing between
5600 * the cell given to each object. The alignment of the box, set with
5601 * elm_box_align_set(), determines how the bounding box of all the elements
5602 * will be placed within the space given to the box widget itself.
5604 * The size hints of each object also affect how they are placed and sized
5605 * within the box. evas_object_size_hint_min_set() will give the minimum
5606 * size the object can have, and the box will use it as the basis for all
5607 * latter calculations. Elementary widgets set their own minimum size as
5608 * needed, so there's rarely any need to use it manually.
5610 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5611 * used to tell whether the object will be allocated the minimum size it
5612 * needs or if the space given to it should be expanded. It's important
5613 * to realize that expanding the size given to the object is not the same
5614 * thing as resizing the object. It could very well end being a small
5615 * widget floating in a much larger empty space. If not set, the weight
5616 * for objects will normally be 0.0 for both axis, meaning the widget will
5617 * not be expanded. To take as much space possible, set the weight to
5618 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5620 * Besides how much space each object is allocated, it's possible to control
5621 * how the widget will be placed within that space using
5622 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5623 * for both axis, meaning the object will be centered, but any value from
5624 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5625 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5626 * is -1.0, means the object will be resized to fill the entire space it
5629 * In addition, customized functions to define the layout can be set, which
5630 * allow the application developer to organize the objects within the box
5631 * in any number of ways.
5633 * The special elm_box_layout_transition() function can be used
5634 * to switch from one layout to another, animating the motion of the
5635 * children of the box.
5637 * @note Objects should not be added to box objects using _add() calls.
5639 * Some examples on how to use boxes follow:
5640 * @li @ref box_example_01
5641 * @li @ref box_example_02
5646 * @typedef Elm_Box_Transition
5648 * Opaque handler containing the parameters to perform an animated
5649 * transition of the layout the box uses.
5651 * @see elm_box_transition_new()
5652 * @see elm_box_layout_set()
5653 * @see elm_box_layout_transition()
5655 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5658 * Add a new box to the parent
5660 * By default, the box will be in vertical mode and non-homogeneous.
5662 * @param parent The parent object
5663 * @return The new object or NULL if it cannot be created
5665 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5667 * Set the horizontal orientation
5669 * By default, box object arranges their contents vertically from top to
5671 * By calling this function with @p horizontal as EINA_TRUE, the box will
5672 * become horizontal, arranging contents from left to right.
5674 * @note This flag is ignored if a custom layout function is set.
5676 * @param obj The box object
5677 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5678 * EINA_FALSE = vertical)
5680 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5682 * Get the horizontal orientation
5684 * @param obj The box object
5685 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
5687 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689 * Set the box to arrange its children homogeneously
5691 * If enabled, homogeneous layout makes all items the same size, according
5692 * to the size of the largest of its children.
5694 * @note This flag is ignored if a custom layout function is set.
5696 * @param obj The box object
5697 * @param homogeneous The homogeneous flag
5699 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5701 * Get whether the box is using homogeneous mode or not
5703 * @param obj The box object
5704 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5706 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5707 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5708 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5710 * Add an object to the beginning of the pack list
5712 * Pack @p subobj into the box @p obj, placing it first in the list of
5713 * children objects. The actual position the object will get on screen
5714 * depends on the layout used. If no custom layout is set, it will be at
5715 * the top or left, depending if the box is vertical or horizontal,
5718 * @param obj The box object
5719 * @param subobj The object to add to the box
5721 * @see elm_box_pack_end()
5722 * @see elm_box_pack_before()
5723 * @see elm_box_pack_after()
5724 * @see elm_box_unpack()
5725 * @see elm_box_unpack_all()
5726 * @see elm_box_clear()
5728 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5730 * Add an object at the end of the pack list
5732 * Pack @p subobj into the box @p obj, placing it last in the list of
5733 * children objects. The actual position the object will get on screen
5734 * depends on the layout used. If no custom layout is set, it will be at
5735 * the bottom or right, depending if the box is vertical or horizontal,
5738 * @param obj The box object
5739 * @param subobj The object to add to the box
5741 * @see elm_box_pack_start()
5742 * @see elm_box_pack_before()
5743 * @see elm_box_pack_after()
5744 * @see elm_box_unpack()
5745 * @see elm_box_unpack_all()
5746 * @see elm_box_clear()
5748 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5750 * Adds an object to the box before the indicated object
5752 * This will add the @p subobj to the box indicated before the object
5753 * indicated with @p before. If @p before is not already in the box, results
5754 * are undefined. Before means either to the left of the indicated object or
5755 * above it depending on orientation.
5757 * @param obj The box object
5758 * @param subobj The object to add to the box
5759 * @param before The object before which to add it
5761 * @see elm_box_pack_start()
5762 * @see elm_box_pack_end()
5763 * @see elm_box_pack_after()
5764 * @see elm_box_unpack()
5765 * @see elm_box_unpack_all()
5766 * @see elm_box_clear()
5768 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5770 * Adds an object to the box after the indicated object
5772 * This will add the @p subobj to the box indicated after the object
5773 * indicated with @p after. If @p after is not already in the box, results
5774 * are undefined. After means either to the right of the indicated object or
5775 * below it depending on orientation.
5777 * @param obj The box object
5778 * @param subobj The object to add to the box
5779 * @param after The object after which to add it
5781 * @see elm_box_pack_start()
5782 * @see elm_box_pack_end()
5783 * @see elm_box_pack_before()
5784 * @see elm_box_unpack()
5785 * @see elm_box_unpack_all()
5786 * @see elm_box_clear()
5788 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5790 * Clear the box of all children
5792 * Remove all the elements contained by the box, deleting the respective
5795 * @param obj The box object
5797 * @see elm_box_unpack()
5798 * @see elm_box_unpack_all()
5800 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5804 * Remove the object given by @p subobj from the box @p obj without
5807 * @param obj The box object
5809 * @see elm_box_unpack_all()
5810 * @see elm_box_clear()
5812 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5814 * Remove all items from the box, without deleting them
5816 * Clear the box from all children, but don't delete the respective objects.
5817 * If no other references of the box children exist, the objects will never
5818 * be deleted, and thus the application will leak the memory. Make sure
5819 * when using this function that you hold a reference to all the objects
5820 * in the box @p obj.
5822 * @param obj The box object
5824 * @see elm_box_clear()
5825 * @see elm_box_unpack()
5827 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5829 * Retrieve a list of the objects packed into the box
5831 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5832 * The order of the list corresponds to the packing order the box uses.
5834 * You must free this list with eina_list_free() once you are done with it.
5836 * @param obj The box object
5838 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5840 * Set the space (padding) between the box's elements.
5842 * Extra space in pixels that will be added between a box child and its
5843 * neighbors after its containing cell has been calculated. This padding
5844 * is set for all elements in the box, besides any possible padding that
5845 * individual elements may have through their size hints.
5847 * @param obj The box object
5848 * @param horizontal The horizontal space between elements
5849 * @param vertical The vertical space between elements
5851 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5853 * Get the space (padding) between the box's elements.
5855 * @param obj The box object
5856 * @param horizontal The horizontal space between elements
5857 * @param vertical The vertical space between elements
5859 * @see elm_box_padding_set()
5861 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5863 * Set the alignment of the whole bouding box of contents.
5865 * Sets how the bounding box containing all the elements of the box, after
5866 * their sizes and position has been calculated, will be aligned within
5867 * the space given for the whole box widget.
5869 * @param obj The box object
5870 * @param horizontal The horizontal alignment of elements
5871 * @param vertical The vertical alignment of elements
5873 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5875 * Get the alignment of the whole bouding box of contents.
5877 * @param obj The box object
5878 * @param horizontal The horizontal alignment of elements
5879 * @param vertical The vertical alignment of elements
5881 * @see elm_box_align_set()
5883 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5886 * Set the layout defining function to be used by the box
5888 * Whenever anything changes that requires the box in @p obj to recalculate
5889 * the size and position of its elements, the function @p cb will be called
5890 * to determine what the layout of the children will be.
5892 * Once a custom function is set, everything about the children layout
5893 * is defined by it. The flags set by elm_box_horizontal_set() and
5894 * elm_box_homogeneous_set() no longer have any meaning, and the values
5895 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5896 * layout function to decide if they are used and how. These last two
5897 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5898 * passed to @p cb. The @c Evas_Object the function receives is not the
5899 * Elementary widget, but the internal Evas Box it uses, so none of the
5900 * functions described here can be used on it.
5902 * Any of the layout functions in @c Evas can be used here, as well as the
5903 * special elm_box_layout_transition().
5905 * The final @p data argument received by @p cb is the same @p data passed
5906 * here, and the @p free_data function will be called to free it
5907 * whenever the box is destroyed or another layout function is set.
5909 * Setting @p cb to NULL will revert back to the default layout function.
5911 * @param obj The box object
5912 * @param cb The callback function used for layout
5913 * @param data Data that will be passed to layout function
5914 * @param free_data Function called to free @p data
5916 * @see elm_box_layout_transition()
5918 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);
5920 * Special layout function that animates the transition from one layout to another
5922 * Normally, when switching the layout function for a box, this will be
5923 * reflected immediately on screen on the next render, but it's also
5924 * possible to do this through an animated transition.
5926 * This is done by creating an ::Elm_Box_Transition and setting the box
5927 * layout to this function.
5931 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5932 * evas_object_box_layout_vertical, // start
5933 * NULL, // data for initial layout
5934 * NULL, // free function for initial data
5935 * evas_object_box_layout_horizontal, // end
5936 * NULL, // data for final layout
5937 * NULL, // free function for final data
5938 * anim_end, // will be called when animation ends
5939 * NULL); // data for anim_end function\
5940 * elm_box_layout_set(box, elm_box_layout_transition, t,
5941 * elm_box_transition_free);
5944 * @note This function can only be used with elm_box_layout_set(). Calling
5945 * it directly will not have the expected results.
5947 * @see elm_box_transition_new
5948 * @see elm_box_transition_free
5949 * @see elm_box_layout_set
5951 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5953 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5955 * If you want to animate the change from one layout to another, you need
5956 * to set the layout function of the box to elm_box_layout_transition(),
5957 * passing as user data to it an instance of ::Elm_Box_Transition with the
5958 * necessary information to perform this animation. The free function to
5959 * set for the layout is elm_box_transition_free().
5961 * The parameters to create an ::Elm_Box_Transition sum up to how long
5962 * will it be, in seconds, a layout function to describe the initial point,
5963 * another for the final position of the children and one function to be
5964 * called when the whole animation ends. This last function is useful to
5965 * set the definitive layout for the box, usually the same as the end
5966 * layout for the animation, but could be used to start another transition.
5968 * @param start_layout The layout function that will be used to start the animation
5969 * @param start_layout_data The data to be passed the @p start_layout function
5970 * @param start_layout_free_data Function to free @p start_layout_data
5971 * @param end_layout The layout function that will be used to end the animation
5972 * @param end_layout_free_data The data to be passed the @p end_layout function
5973 * @param end_layout_free_data Function to free @p end_layout_data
5974 * @param transition_end_cb Callback function called when animation ends
5975 * @param transition_end_data Data to be passed to @p transition_end_cb
5976 * @return An instance of ::Elm_Box_Transition
5978 * @see elm_box_transition_new
5979 * @see elm_box_layout_transition
5981 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);
5983 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5985 * This function is mostly useful as the @c free_data parameter in
5986 * elm_box_layout_set() when elm_box_layout_transition().
5988 * @param data The Elm_Box_Transition instance to be freed.
5990 * @see elm_box_transition_new
5991 * @see elm_box_layout_transition
5993 EAPI void elm_box_transition_free(void *data);
6000 * @defgroup Button Button
6002 * @image html img/widget/button/preview-00.png
6003 * @image latex img/widget/button/preview-00.eps
6004 * @image html img/widget/button/preview-01.png
6005 * @image latex img/widget/button/preview-01.eps
6006 * @image html img/widget/button/preview-02.png
6007 * @image latex img/widget/button/preview-02.eps
6009 * This is a push-button. Press it and run some function. It can contain
6010 * a simple label and icon object and it also has an autorepeat feature.
6012 * This widgets emits the following signals:
6013 * @li "clicked": the user clicked the button (press/release).
6014 * @li "repeated": the user pressed the button without releasing it.
6015 * @li "pressed": button was pressed.
6016 * @li "unpressed": button was released after being pressed.
6017 * In all three cases, the @c event parameter of the callback will be
6020 * Also, defined in the default theme, the button has the following styles
6022 * @li default: a normal button.
6023 * @li anchor: Like default, but the button fades away when the mouse is not
6024 * over it, leaving only the text or icon.
6025 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6026 * continuous look across its options.
6027 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6029 * Follow through a complete example @ref button_example_01 "here".
6035 UIControlStateDefault,
6036 UIControlStateHighlighted,
6037 UIControlStateDisabled,
6038 UIControlStateFocused,
6039 UIControlStateReserved
6043 * Add a new button to the parent's canvas
6045 * @param parent The parent object
6046 * @return The new object or NULL if it cannot be created
6048 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6050 * Set the label used in the button
6052 * The passed @p label can be NULL to clean any existing text in it and
6053 * leave the button as an icon only object.
6055 * @param obj The button object
6056 * @param label The text will be written on the button
6057 * @deprecated use elm_object_text_set() instead.
6059 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6061 * Get the label set for the button
6063 * The string returned is an internal pointer and should not be freed or
6064 * altered. It will also become invalid when the button is destroyed.
6065 * The string returned, if not NULL, is a stringshare, so if you need to
6066 * keep it around even after the button is destroyed, you can use
6067 * eina_stringshare_ref().
6069 * @param obj The button object
6070 * @return The text set to the label, or NULL if nothing is set
6071 * @deprecated use elm_object_text_set() instead.
6073 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6075 * Set the label for each state of button
6077 * The passed @p label can be NULL to clean any existing text in it and
6078 * leave the button as an icon only object for the state.
6080 * @param obj The button object
6081 * @param label The text will be written on the button
6082 * @param state The state of button
6086 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6088 * Get the label of button for each state
6090 * The string returned is an internal pointer and should not be freed or
6091 * altered. It will also become invalid when the button is destroyed.
6092 * The string returned, if not NULL, is a stringshare, so if you need to
6093 * keep it around even after the button is destroyed, you can use
6094 * eina_stringshare_ref().
6096 * @param obj The button object
6097 * @param state The state of button
6098 * @return The title of button for state
6102 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6104 * Set the icon used for the button
6106 * Setting a new icon will delete any other that was previously set, making
6107 * any reference to them invalid. If you need to maintain the previous
6108 * object alive, unset it first with elm_button_icon_unset().
6110 * @param obj The button object
6111 * @param icon The icon object for the button
6113 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6115 * Get the icon used for the button
6117 * Return the icon object which is set for this widget. If the button is
6118 * destroyed or another icon is set, the returned object will be deleted
6119 * and any reference to it will be invalid.
6121 * @param obj The button object
6122 * @return The icon object that is being used
6124 * @see elm_button_icon_unset()
6126 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6128 * Remove the icon set without deleting it and return the object
6130 * This function drops the reference the button holds of the icon object
6131 * and returns this last object. It is used in case you want to remove any
6132 * icon, or set another one, without deleting the actual object. The button
6133 * will be left without an icon set.
6135 * @param obj The button object
6136 * @return The icon object that was being used
6138 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6140 * Turn on/off the autorepeat event generated when the button is kept pressed
6142 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6143 * signal when they are clicked.
6145 * When on, keeping a button pressed will continuously emit a @c repeated
6146 * signal until the button is released. The time it takes until it starts
6147 * emitting the signal is given by
6148 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6149 * new emission by elm_button_autorepeat_gap_timeout_set().
6151 * @param obj The button object
6152 * @param on A bool to turn on/off the event
6154 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6156 * Get whether the autorepeat feature is enabled
6158 * @param obj The button object
6159 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6161 * @see elm_button_autorepeat_set()
6163 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6165 * Set the initial timeout before the autorepeat event is generated
6167 * Sets the timeout, in seconds, since the button is pressed until the
6168 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6169 * won't be any delay and the even will be fired the moment the button is
6172 * @param obj The button object
6173 * @param t Timeout in seconds
6175 * @see elm_button_autorepeat_set()
6176 * @see elm_button_autorepeat_gap_timeout_set()
6178 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6180 * Get the initial timeout before the autorepeat event is generated
6182 * @param obj The button object
6183 * @return Timeout in seconds
6185 * @see elm_button_autorepeat_initial_timeout_set()
6187 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6189 * Set the interval between each generated autorepeat event
6191 * After the first @c repeated event is fired, all subsequent ones will
6192 * follow after a delay of @p t seconds for each.
6194 * @param obj The button object
6195 * @param t Interval in seconds
6197 * @see elm_button_autorepeat_initial_timeout_set()
6199 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6201 * Get the interval between each generated autorepeat event
6203 * @param obj The button object
6204 * @return Interval in seconds
6206 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6212 * @defgroup File_Selector_Button File Selector Button
6214 * @image html img/widget/fileselector_button/preview-00.png
6215 * @image latex img/widget/fileselector_button/preview-00.eps
6216 * @image html img/widget/fileselector_button/preview-01.png
6217 * @image latex img/widget/fileselector_button/preview-01.eps
6218 * @image html img/widget/fileselector_button/preview-02.png
6219 * @image latex img/widget/fileselector_button/preview-02.eps
6221 * This is a button that, when clicked, creates an Elementary
6222 * window (or inner window) <b> with a @ref Fileselector "file
6223 * selector widget" within</b>. When a file is chosen, the (inner)
6224 * window is closed and the button emits a signal having the
6225 * selected file as it's @c event_info.
6227 * This widget encapsulates operations on its internal file
6228 * selector on its own API. There is less control over its file
6229 * selector than that one would have instatiating one directly.
6231 * The following styles are available for this button:
6234 * @li @c "hoversel_vertical"
6235 * @li @c "hoversel_vertical_entry"
6237 * Smart callbacks one can register to:
6238 * - @c "file,chosen" - the user has selected a path, whose string
6239 * pointer comes as the @c event_info data (a stringshared
6242 * Here is an example on its usage:
6243 * @li @ref fileselector_button_example
6245 * @see @ref File_Selector_Entry for a similar widget.
6250 * Add a new file selector button widget to the given parent
6251 * Elementary (container) object
6253 * @param parent The parent object
6254 * @return a new file selector button widget handle or @c NULL, on
6257 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6260 * Set the label for a given file selector button widget
6262 * @param obj The file selector button widget
6263 * @param label The text label to be displayed on @p obj
6265 * @deprecated use elm_object_text_set() instead.
6267 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6270 * Get the label set for a given file selector button widget
6272 * @param obj The file selector button widget
6273 * @return The button label
6275 * @deprecated use elm_object_text_set() instead.
6277 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6280 * Set the icon on a given file selector button widget
6282 * @param obj The file selector button widget
6283 * @param icon The icon object for the button
6285 * Once the icon object is set, a previously set one will be
6286 * deleted. If you want to keep the latter, use the
6287 * elm_fileselector_button_icon_unset() function.
6289 * @see elm_fileselector_button_icon_get()
6291 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6294 * Get the icon set for a given file selector button widget
6296 * @param obj The file selector button widget
6297 * @return The icon object currently set on @p obj or @c NULL, if
6300 * @see elm_fileselector_button_icon_set()
6302 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6305 * Unset the icon used in a given file selector button widget
6307 * @param obj The file selector button widget
6308 * @return The icon object that was being used on @p obj or @c
6311 * Unparent and return the icon object which was set for this
6314 * @see elm_fileselector_button_icon_set()
6316 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6319 * Set the title for a given file selector button widget's window
6321 * @param obj The file selector button widget
6322 * @param title The title string
6324 * This will change the window's title, when the file selector pops
6325 * out after a click on the button. Those windows have the default
6326 * (unlocalized) value of @c "Select a file" as titles.
6328 * @note It will only take any effect if the file selector
6329 * button widget is @b not under "inwin mode".
6331 * @see elm_fileselector_button_window_title_get()
6333 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6336 * Get the title set for a given file selector button widget's
6339 * @param obj The file selector button widget
6340 * @return Title of the file selector button's window
6342 * @see elm_fileselector_button_window_title_get() for more details
6344 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6347 * Set the size of a given file selector button widget's window,
6348 * holding the file selector itself.
6350 * @param obj The file selector button widget
6351 * @param width The window's width
6352 * @param height The window's height
6354 * @note it will only take any effect if the file selector button
6355 * widget is @b not under "inwin mode". The default size for the
6356 * window (when applicable) is 400x400 pixels.
6358 * @see elm_fileselector_button_window_size_get()
6360 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6363 * Get the size of a given file selector button widget's window,
6364 * holding the file selector itself.
6366 * @param obj The file selector button widget
6367 * @param width Pointer into which to store the width value
6368 * @param height Pointer into which to store the height value
6370 * @note Use @c NULL pointers on the size values you're not
6371 * interested in: they'll be ignored by the function.
6373 * @see elm_fileselector_button_window_size_set(), for more details
6375 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6378 * Set the initial file system path for a given file selector
6381 * @param obj The file selector button widget
6382 * @param path The path string
6384 * It must be a <b>directory</b> path, which will have the contents
6385 * displayed initially in the file selector's view, when invoked
6386 * from @p obj. The default initial path is the @c "HOME"
6387 * environment variable's value.
6389 * @see elm_fileselector_button_path_get()
6391 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6394 * Get the initial file system path set for a given file selector
6397 * @param obj The file selector button widget
6398 * @return path The path string
6400 * @see elm_fileselector_button_path_set() for more details
6402 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6405 * Enable/disable a tree view in the given file selector button
6406 * widget's internal file selector
6408 * @param obj The file selector button widget
6409 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6412 * This has the same effect as elm_fileselector_expandable_set(),
6413 * but now applied to a file selector button's internal file
6416 * @note There's no way to put a file selector button's internal
6417 * file selector in "grid mode", as one may do with "pure" file
6420 * @see elm_fileselector_expandable_get()
6422 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6425 * Get whether tree view is enabled for the given file selector
6426 * button widget's internal file selector
6428 * @param obj The file selector button widget
6429 * @return @c EINA_TRUE if @p obj widget's internal file selector
6430 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6432 * @see elm_fileselector_expandable_set() for more details
6434 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6437 * Set whether a given file selector button widget's internal file
6438 * selector is to display folders only or the directory contents,
6441 * @param obj The file selector button widget
6442 * @param only @c EINA_TRUE to make @p obj widget's internal file
6443 * selector only display directories, @c EINA_FALSE to make files
6444 * to be displayed in it too
6446 * This has the same effect as elm_fileselector_folder_only_set(),
6447 * but now applied to a file selector button's internal file
6450 * @see elm_fileselector_folder_only_get()
6452 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6455 * Get whether a given file selector button widget's internal file
6456 * selector is displaying folders only or the directory contents,
6459 * @param obj The file selector button widget
6460 * @return @c EINA_TRUE if @p obj widget's internal file
6461 * selector is only displaying directories, @c EINA_FALSE if files
6462 * are being displayed in it too (and on errors)
6464 * @see elm_fileselector_button_folder_only_set() for more details
6466 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6469 * Enable/disable the file name entry box where the user can type
6470 * in a name for a file, in a given file selector button widget's
6471 * internal file selector.
6473 * @param obj The file selector button widget
6474 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6475 * file selector a "saving dialog", @c EINA_FALSE otherwise
6477 * This has the same effect as elm_fileselector_is_save_set(),
6478 * but now applied to a file selector button's internal file
6481 * @see elm_fileselector_is_save_get()
6483 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6486 * Get whether the given file selector button widget's internal
6487 * file selector is in "saving dialog" mode
6489 * @param obj The file selector button widget
6490 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6491 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6494 * @see elm_fileselector_button_is_save_set() for more details
6496 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6499 * Set whether a given file selector button widget's internal file
6500 * selector will raise an Elementary "inner window", instead of a
6501 * dedicated Elementary window. By default, it won't.
6503 * @param obj The file selector button widget
6504 * @param value @c EINA_TRUE to make it use an inner window, @c
6505 * EINA_TRUE to make it use a dedicated window
6507 * @see elm_win_inwin_add() for more information on inner windows
6508 * @see elm_fileselector_button_inwin_mode_get()
6510 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6513 * Get whether a given file selector button widget's internal file
6514 * selector will raise an Elementary "inner window", instead of a
6515 * dedicated Elementary window.
6517 * @param obj The file selector button widget
6518 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6519 * if it will use a dedicated window
6521 * @see elm_fileselector_button_inwin_mode_set() for more details
6523 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6530 * @defgroup File_Selector_Entry File Selector Entry
6532 * @image html img/widget/fileselector_entry/preview-00.png
6533 * @image latex img/widget/fileselector_entry/preview-00.eps
6535 * This is an entry made to be filled with or display a <b>file
6536 * system path string</b>. Besides the entry itself, the widget has
6537 * a @ref File_Selector_Button "file selector button" on its side,
6538 * which will raise an internal @ref Fileselector "file selector widget",
6539 * when clicked, for path selection aided by file system
6542 * This file selector may appear in an Elementary window or in an
6543 * inner window. When a file is chosen from it, the (inner) window
6544 * is closed and the selected file's path string is exposed both as
6545 * an smart event and as the new text on the entry.
6547 * This widget encapsulates operations on its internal file
6548 * selector on its own API. There is less control over its file
6549 * selector than that one would have instatiating one directly.
6551 * Smart callbacks one can register to:
6552 * - @c "changed" - The text within the entry was changed
6553 * - @c "activated" - The entry has had editing finished and
6554 * changes are to be "committed"
6555 * - @c "press" - The entry has been clicked
6556 * - @c "longpressed" - The entry has been clicked (and held) for a
6558 * - @c "clicked" - The entry has been clicked
6559 * - @c "clicked,double" - The entry has been double clicked
6560 * - @c "focused" - The entry has received focus
6561 * - @c "unfocused" - The entry has lost focus
6562 * - @c "selection,paste" - A paste action has occurred on the
6564 * - @c "selection,copy" - A copy action has occurred on the entry
6565 * - @c "selection,cut" - A cut action has occurred on the entry
6566 * - @c "unpressed" - The file selector entry's button was released
6567 * after being pressed.
6568 * - @c "file,chosen" - The user has selected a path via the file
6569 * selector entry's internal file selector, whose string pointer
6570 * comes as the @c event_info data (a stringshared string)
6572 * Here is an example on its usage:
6573 * @li @ref fileselector_entry_example
6575 * @see @ref File_Selector_Button for a similar widget.
6580 * Add a new file selector entry widget to the given parent
6581 * Elementary (container) object
6583 * @param parent The parent object
6584 * @return a new file selector entry widget handle or @c NULL, on
6587 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6590 * Set the label for a given file selector entry widget's button
6592 * @param obj The file selector entry widget
6593 * @param label The text label to be displayed on @p obj widget's
6596 * @deprecated use elm_object_text_set() instead.
6598 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6601 * Get the label set for a given file selector entry widget's button
6603 * @param obj The file selector entry widget
6604 * @return The widget button's label
6606 * @deprecated use elm_object_text_set() instead.
6608 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6611 * Set the icon on a given file selector entry widget's button
6613 * @param obj The file selector entry widget
6614 * @param icon The icon object for the entry's button
6616 * Once the icon object is set, a previously set one will be
6617 * deleted. If you want to keep the latter, use the
6618 * elm_fileselector_entry_button_icon_unset() function.
6620 * @see elm_fileselector_entry_button_icon_get()
6622 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6625 * Get the icon set for a given file selector entry widget's button
6627 * @param obj The file selector entry widget
6628 * @return The icon object currently set on @p obj widget's button
6629 * or @c NULL, if none is
6631 * @see elm_fileselector_entry_button_icon_set()
6633 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6636 * Unset the icon used in a given file selector entry widget's
6639 * @param obj The file selector entry widget
6640 * @return The icon object that was being used on @p obj widget's
6641 * button or @c NULL, on errors
6643 * Unparent and return the icon object which was set for this
6646 * @see elm_fileselector_entry_button_icon_set()
6648 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6651 * Set the title for a given file selector entry widget's window
6653 * @param obj The file selector entry widget
6654 * @param title The title string
6656 * This will change the window's title, when the file selector pops
6657 * out after a click on the entry's button. Those windows have the
6658 * default (unlocalized) value of @c "Select a file" as titles.
6660 * @note It will only take any effect if the file selector
6661 * entry widget is @b not under "inwin mode".
6663 * @see elm_fileselector_entry_window_title_get()
6665 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6668 * Get the title set for a given file selector entry widget's
6671 * @param obj The file selector entry widget
6672 * @return Title of the file selector entry's window
6674 * @see elm_fileselector_entry_window_title_get() for more details
6676 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6679 * Set the size of a given file selector entry widget's window,
6680 * holding the file selector itself.
6682 * @param obj The file selector entry widget
6683 * @param width The window's width
6684 * @param height The window's height
6686 * @note it will only take any effect if the file selector entry
6687 * widget is @b not under "inwin mode". The default size for the
6688 * window (when applicable) is 400x400 pixels.
6690 * @see elm_fileselector_entry_window_size_get()
6692 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6695 * Get the size of a given file selector entry widget's window,
6696 * holding the file selector itself.
6698 * @param obj The file selector entry widget
6699 * @param width Pointer into which to store the width value
6700 * @param height Pointer into which to store the height value
6702 * @note Use @c NULL pointers on the size values you're not
6703 * interested in: they'll be ignored by the function.
6705 * @see elm_fileselector_entry_window_size_set(), for more details
6707 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6710 * Set the initial file system path and the entry's path string for
6711 * a given file selector entry widget
6713 * @param obj The file selector entry widget
6714 * @param path The path string
6716 * It must be a <b>directory</b> path, which will have the contents
6717 * displayed initially in the file selector's view, when invoked
6718 * from @p obj. The default initial path is the @c "HOME"
6719 * environment variable's value.
6721 * @see elm_fileselector_entry_path_get()
6723 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6726 * Get the entry's path string for a given file selector entry
6729 * @param obj The file selector entry widget
6730 * @return path The path string
6732 * @see elm_fileselector_entry_path_set() for more details
6734 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Enable/disable a tree view in the given file selector entry
6738 * widget's internal file selector
6740 * @param obj The file selector entry widget
6741 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6744 * This has the same effect as elm_fileselector_expandable_set(),
6745 * but now applied to a file selector entry's internal file
6748 * @note There's no way to put a file selector entry's internal
6749 * file selector in "grid mode", as one may do with "pure" file
6752 * @see elm_fileselector_expandable_get()
6754 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6757 * Get whether tree view is enabled for the given file selector
6758 * entry widget's internal file selector
6760 * @param obj The file selector entry widget
6761 * @return @c EINA_TRUE if @p obj widget's internal file selector
6762 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6764 * @see elm_fileselector_expandable_set() for more details
6766 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6769 * Set whether a given file selector entry widget's internal file
6770 * selector is to display folders only or the directory contents,
6773 * @param obj The file selector entry widget
6774 * @param only @c EINA_TRUE to make @p obj widget's internal file
6775 * selector only display directories, @c EINA_FALSE to make files
6776 * to be displayed in it too
6778 * This has the same effect as elm_fileselector_folder_only_set(),
6779 * but now applied to a file selector entry's internal file
6782 * @see elm_fileselector_folder_only_get()
6784 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6787 * Get whether a given file selector entry widget's internal file
6788 * selector is displaying folders only or the directory contents,
6791 * @param obj The file selector entry widget
6792 * @return @c EINA_TRUE if @p obj widget's internal file
6793 * selector is only displaying directories, @c EINA_FALSE if files
6794 * are being displayed in it too (and on errors)
6796 * @see elm_fileselector_entry_folder_only_set() for more details
6798 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6801 * Enable/disable the file name entry box where the user can type
6802 * in a name for a file, in a given file selector entry widget's
6803 * internal file selector.
6805 * @param obj The file selector entry widget
6806 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6807 * file selector a "saving dialog", @c EINA_FALSE otherwise
6809 * This has the same effect as elm_fileselector_is_save_set(),
6810 * but now applied to a file selector entry's internal file
6813 * @see elm_fileselector_is_save_get()
6815 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6818 * Get whether the given file selector entry widget's internal
6819 * file selector is in "saving dialog" mode
6821 * @param obj The file selector entry widget
6822 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6823 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6826 * @see elm_fileselector_entry_is_save_set() for more details
6828 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6831 * Set whether a given file selector entry widget's internal file
6832 * selector will raise an Elementary "inner window", instead of a
6833 * dedicated Elementary window. By default, it won't.
6835 * @param obj The file selector entry widget
6836 * @param value @c EINA_TRUE to make it use an inner window, @c
6837 * EINA_TRUE to make it use a dedicated window
6839 * @see elm_win_inwin_add() for more information on inner windows
6840 * @see elm_fileselector_entry_inwin_mode_get()
6842 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6845 * Get whether a given file selector entry widget's internal file
6846 * selector will raise an Elementary "inner window", instead of a
6847 * dedicated Elementary window.
6849 * @param obj The file selector entry widget
6850 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6851 * if it will use a dedicated window
6853 * @see elm_fileselector_entry_inwin_mode_set() for more details
6855 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6858 * Set the initial file system path for a given file selector entry
6861 * @param obj The file selector entry widget
6862 * @param path The path string
6864 * It must be a <b>directory</b> path, which will have the contents
6865 * displayed initially in the file selector's view, when invoked
6866 * from @p obj. The default initial path is the @c "HOME"
6867 * environment variable's value.
6869 * @see elm_fileselector_entry_path_get()
6871 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6874 * Get the parent directory's path to the latest file selection on
6875 * a given filer selector entry widget
6877 * @param obj The file selector object
6878 * @return The (full) path of the directory of the last selection
6879 * on @p obj widget, a @b stringshared string
6881 * @see elm_fileselector_entry_path_set()
6883 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6890 * @defgroup Scroller Scroller
6892 * A scroller holds a single object and "scrolls it around". This means that
6893 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6894 * region around, allowing to move through a much larger object that is
6895 * contained in the scroller. The scroller will always have a small minimum
6896 * size by default as it won't be limited by the contents of the scroller.
6898 * Signals that you can add callbacks for are:
6899 * @li "edge,left" - the left edge of the content has been reached
6900 * @li "edge,right" - the right edge of the content has been reached
6901 * @li "edge,top" - the top edge of the content has been reached
6902 * @li "edge,bottom" - the bottom edge of the content has been reached
6903 * @li "scroll" - the content has been scrolled (moved)
6904 * @li "scroll,anim,start" - scrolling animation has started
6905 * @li "scroll,anim,stop" - scrolling animation has stopped
6906 * @li "scroll,drag,start" - dragging the contents around has started
6907 * @li "scroll,drag,stop" - dragging the contents around has stopped
6908 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6911 * @note When Elemementary is in embedded mode the scrollbars will not be
6912 * dragable, they appear merely as indicators of how much has been scrolled.
6913 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6914 * fingerscroll) won't work.
6916 * To set/get/unset the content of the panel, you can use
6917 * elm_object_content_set/get/unset APIs.
6918 * Once the content object is set, a previously set one will be deleted.
6919 * If you want to keep that old content object, use the
6920 * elm_object_content_unset() function
6922 * In @ref tutorial_scroller you'll find an example of how to use most of
6927 * @brief Type that controls when scrollbars should appear.
6929 * @see elm_scroller_policy_set()
6931 typedef enum _Elm_Scroller_Policy
6933 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6934 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6935 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6936 ELM_SCROLLER_POLICY_LAST
6937 } Elm_Scroller_Policy;
6939 * @brief Add a new scroller to the parent
6941 * @param parent The parent object
6942 * @return The new object or NULL if it cannot be created
6944 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6946 * @brief Set the content of the scroller widget (the object to be scrolled around).
6948 * @param obj The scroller object
6949 * @param content The new content object
6951 * Once the content object is set, a previously set one will be deleted.
6952 * If you want to keep that old content object, use the
6953 * elm_scroller_content_unset() function.
6954 * @deprecated See elm_object_content_set()
6956 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6958 * @brief Get the content of the scroller widget
6960 * @param obj The slider object
6961 * @return The content that is being used
6963 * Return the content object which is set for this widget
6965 * @see elm_scroller_content_set()
6966 * @deprecated use elm_object_content_get() instead.
6968 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6970 * @brief Unset the content of the scroller widget
6972 * @param obj The slider object
6973 * @return The content that was being used
6975 * Unparent and return the content object which was set for this widget
6977 * @see elm_scroller_content_set()
6978 * @deprecated use elm_object_content_unset() instead.
6980 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6982 * @brief Set custom theme elements for the scroller
6984 * @param obj The scroller object
6985 * @param widget The widget name to use (default is "scroller")
6986 * @param base The base name to use (default is "base")
6988 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6990 * @brief Make the scroller minimum size limited to the minimum size of the content
6992 * @param obj The scroller object
6993 * @param w Enable limiting minimum size horizontally
6994 * @param h Enable limiting minimum size vertically
6996 * By default the scroller will be as small as its design allows,
6997 * irrespective of its content. This will make the scroller minimum size the
6998 * right size horizontally and/or vertically to perfectly fit its content in
7001 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7003 * @brief Show a specific virtual region within the scroller content object
7005 * @param obj The scroller object
7006 * @param x X coordinate of the region
7007 * @param y Y coordinate of the region
7008 * @param w Width of the region
7009 * @param h Height of the region
7011 * This will ensure all (or part if it does not fit) of the designated
7012 * region in the virtual content object (0, 0 starting at the top-left of the
7013 * virtual content object) is shown within the scroller.
7015 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);
7017 * @brief Set the scrollbar visibility policy
7019 * @param obj The scroller object
7020 * @param policy_h Horizontal scrollbar policy
7021 * @param policy_v Vertical scrollbar policy
7023 * This sets the scrollbar visibility policy for the given scroller.
7024 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7025 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7026 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7027 * respectively for the horizontal and vertical scrollbars.
7029 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7031 * @brief Gets scrollbar visibility policy
7033 * @param obj The scroller object
7034 * @param policy_h Horizontal scrollbar policy
7035 * @param policy_v Vertical scrollbar policy
7037 * @see elm_scroller_policy_set()
7039 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7041 * @brief Get the currently visible content region
7043 * @param obj The scroller object
7044 * @param x X coordinate of the region
7045 * @param y Y coordinate of the region
7046 * @param w Width of the region
7047 * @param h Height of the region
7049 * This gets the current region in the content object that is visible through
7050 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7051 * w, @p h values pointed to.
7053 * @note All coordinates are relative to the content.
7055 * @see elm_scroller_region_show()
7057 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);
7059 * @brief Get the size of the content object
7061 * @param obj The scroller object
7062 * @param w Width of the content object.
7063 * @param h Height of the content object.
7065 * This gets the size of the content object of the scroller.
7067 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7069 * @brief Set bouncing behavior
7071 * @param obj The scroller object
7072 * @param h_bounce Allow bounce horizontally
7073 * @param v_bounce Allow bounce vertically
7075 * When scrolling, the scroller may "bounce" when reaching an edge of the
7076 * content object. This is a visual way to indicate the end has been reached.
7077 * This is enabled by default for both axis. This API will set if it is enabled
7078 * for the given axis with the boolean parameters for each axis.
7080 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7082 * @brief Get the bounce behaviour
7084 * @param obj The Scroller object
7085 * @param h_bounce Will the scroller bounce horizontally or not
7086 * @param v_bounce Will the scroller bounce vertically or not
7088 * @see elm_scroller_bounce_set()
7090 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7092 * @brief Set scroll page size relative to viewport size.
7094 * @param obj The scroller object
7095 * @param h_pagerel The horizontal page relative size
7096 * @param v_pagerel The vertical page relative size
7098 * The scroller is capable of limiting scrolling by the user to "pages". That
7099 * is to jump by and only show a "whole page" at a time as if the continuous
7100 * area of the scroller content is split into page sized pieces. This sets
7101 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7102 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7103 * axis. This is mutually exclusive with page size
7104 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7105 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7106 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7109 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7111 * @brief Set scroll page size.
7113 * @param obj The scroller object
7114 * @param h_pagesize The horizontal page size
7115 * @param v_pagesize The vertical page size
7117 * This sets the page size to an absolute fixed value, with 0 turning it off
7120 * @see elm_scroller_page_relative_set()
7122 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7124 * @brief Show a specific virtual region within the scroller content object.
7126 * @param obj The scroller object
7127 * @param x X coordinate of the region
7128 * @param y Y coordinate of the region
7129 * @param w Width of the region
7130 * @param h Height of the region
7132 * This will ensure all (or part if it does not fit) of the designated
7133 * region in the virtual content object (0, 0 starting at the top-left of the
7134 * virtual content object) is shown within the scroller. Unlike
7135 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7136 * to this location (if configuration in general calls for transitions). It
7137 * may not jump immediately to the new location and make take a while and
7138 * show other content along the way.
7140 * @see elm_scroller_region_show()
7142 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);
7144 * @brief Set event propagation on a scroller
7146 * @param obj The scroller object
7147 * @param propagation If propagation is enabled or not
7149 * This enables or disabled event propagation from the scroller content to
7150 * the scroller and its parent. By default event propagation is disabled.
7152 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7154 * @brief Get event propagation for a scroller
7156 * @param obj The scroller object
7157 * @return The propagation state
7159 * This gets the event propagation for a scroller.
7161 * @see elm_scroller_propagate_events_set()
7163 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7165 * @brief Set scrolling gravity on a scroller
7167 * @param obj The scroller object
7168 * @param x The scrolling horizontal gravity
7169 * @param y The scrolling vertical gravity
7171 * The gravity, defines how the scroller will adjust its view
7172 * when the size of the scroller contents increase.
7174 * The scroller will adjust the view to glue itself as follows.
7176 * x=0.0, for showing the left most region of the content.
7177 * x=1.0, for showing the right most region of the content.
7178 * y=0.0, for showing the bottom most region of the content.
7179 * y=1.0, for showing the top most region of the content.
7181 * Default values for x and y are 0.0
7183 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7185 * @brief Get scrolling gravity values for a scroller
7187 * @param obj The scroller object
7188 * @param x The scrolling horizontal gravity
7189 * @param y The scrolling vertical gravity
7191 * This gets gravity values for a scroller.
7193 * @see elm_scroller_gravity_set()
7196 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7202 * @defgroup Label Label
7204 * @image html img/widget/label/preview-00.png
7205 * @image latex img/widget/label/preview-00.eps
7207 * @brief Widget to display text, with simple html-like markup.
7209 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7210 * text doesn't fit the geometry of the label it will be ellipsized or be
7211 * cut. Elementary provides several themes for this widget:
7212 * @li default - No animation
7213 * @li marker - Centers the text in the label and make it bold by default
7214 * @li slide_long - The entire text appears from the right of the screen and
7215 * slides until it disappears in the left of the screen(reappering on the
7217 * @li slide_short - The text appears in the left of the label and slides to
7218 * the right to show the overflow. When all of the text has been shown the
7219 * position is reset.
7220 * @li slide_bounce - The text appears in the left of the label and slides to
7221 * the right to show the overflow. When all of the text has been shown the
7222 * animation reverses, moving the text to the left.
7224 * Custom themes can of course invent new markup tags and style them any way
7227 * The following signals may be emitted by the label widget:
7228 * @li "language,changed": The program's language changed.
7230 * See @ref tutorial_label for a demonstration of how to use a label widget.
7234 * @brief Add a new label to the parent
7236 * @param parent The parent object
7237 * @return The new object or NULL if it cannot be created
7239 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7241 * @brief Set the label on the label object
7243 * @param obj The label object
7244 * @param label The label will be used on the label object
7245 * @deprecated See elm_object_text_set()
7247 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 */
7249 * @brief Get the label used on the label object
7251 * @param obj The label object
7252 * @return The string inside the label
7253 * @deprecated See elm_object_text_get()
7255 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7257 * @brief Set the wrapping behavior of the label
7259 * @param obj The label object
7260 * @param wrap To wrap text or not
7262 * By default no wrapping is done. Possible values for @p wrap are:
7263 * @li ELM_WRAP_NONE - No wrapping
7264 * @li ELM_WRAP_CHAR - wrap between characters
7265 * @li ELM_WRAP_WORD - wrap between words
7266 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7268 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7270 * @brief Get the wrapping behavior of the label
7272 * @param obj The label object
7275 * @see elm_label_line_wrap_set()
7277 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7279 * @brief Set wrap width of the label
7281 * @param obj The label object
7282 * @param w The wrap width in pixels at a minimum where words need to wrap
7284 * This function sets the maximum width size hint of the label.
7286 * @warning This is only relevant if the label is inside a container.
7288 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7290 * @brief Get wrap width of the label
7292 * @param obj The label object
7293 * @return The wrap width in pixels at a minimum where words need to wrap
7295 * @see elm_label_wrap_width_set()
7297 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7299 * @brief Set wrap height of the label
7301 * @param obj The label object
7302 * @param h The wrap height in pixels at a minimum where words need to wrap
7304 * This function sets the maximum height size hint of the label.
7306 * @warning This is only relevant if the label is inside a container.
7308 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7310 * @brief get wrap width of the label
7312 * @param obj The label object
7313 * @return The wrap height in pixels at a minimum where words need to wrap
7315 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7317 * @brief Set the font size on the label object.
7319 * @param obj The label object
7320 * @param size font size
7322 * @warning NEVER use this. It is for hyper-special cases only. use styles
7323 * instead. e.g. "big", "medium", "small" - or better name them by use:
7324 * "title", "footnote", "quote" etc.
7326 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7328 * @brief Set the text color on the label object
7330 * @param obj The label object
7331 * @param r Red property background color of The label object
7332 * @param g Green property background color of The label object
7333 * @param b Blue property background color of The label object
7334 * @param a Alpha property background color of The label object
7336 * @warning NEVER use this. It is for hyper-special cases only. use styles
7337 * instead. e.g. "big", "medium", "small" - or better name them by use:
7338 * "title", "footnote", "quote" etc.
7340 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);
7342 * @brief Set the text align on the label object
7344 * @param obj The label object
7345 * @param align align mode ("left", "center", "right")
7347 * @warning NEVER use this. It is for hyper-special cases only. use styles
7348 * instead. e.g. "big", "medium", "small" - or better name them by use:
7349 * "title", "footnote", "quote" etc.
7351 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7353 * @brief Set background color of the label
7355 * @param obj The label object
7356 * @param r Red property background color of The label object
7357 * @param g Green property background color of The label object
7358 * @param b Blue property background color of The label object
7359 * @param a Alpha property background alpha of The label object
7361 * @warning NEVER use this. It is for hyper-special cases only. use styles
7362 * instead. e.g. "big", "medium", "small" - or better name them by use:
7363 * "title", "footnote", "quote" etc.
7365 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);
7367 * @brief Set the ellipsis behavior of the label
7369 * @param obj The label object
7370 * @param ellipsis To ellipsis text or not
7372 * If set to true and the text doesn't fit in the label an ellipsis("...")
7373 * will be shown at the end of the widget.
7375 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7376 * choosen wrap method was ELM_WRAP_WORD.
7378 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7379 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7381 * @brief Set the text slide of the label
7383 * @param obj The label object
7384 * @param slide To start slide or stop
7386 * If set to true, the text of the label will slide/scroll through the length of
7389 * @warning This only works with the themes "slide_short", "slide_long" and
7392 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7394 * @brief Get the text slide mode of the label
7396 * @param obj The label object
7397 * @return slide slide mode value
7399 * @see elm_label_slide_set()
7401 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7403 * @brief Set the slide duration(speed) of the label
7405 * @param obj The label object
7406 * @return The duration in seconds in moving text from slide begin position
7407 * to slide end position
7409 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7411 * @brief Get the slide duration(speed) of the label
7413 * @param obj The label object
7414 * @return The duration time in moving text from slide begin position to slide end position
7416 * @see elm_label_slide_duration_set()
7418 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7424 * @defgroup Toggle Toggle
7426 * @image html img/widget/toggle/preview-00.png
7427 * @image latex img/widget/toggle/preview-00.eps
7429 * @brief A toggle is a slider which can be used to toggle between
7430 * two values. It has two states: on and off.
7432 * This widget is deprecated. Please use elm_check_add() instead using the
7433 * toggle style like:
7436 * obj = elm_check_add(parent);
7437 * elm_object_style_set(obj, "toggle");
7438 * elm_object_text_part_set(obj, "on", "ON");
7439 * elm_object_text_part_set(obj, "off", "OFF");
7442 * Signals that you can add callbacks for are:
7443 * @li "changed" - Whenever the toggle value has been changed. Is not called
7444 * until the toggle is released by the cursor (assuming it
7445 * has been triggered by the cursor in the first place).
7447 * @ref tutorial_toggle show how to use a toggle.
7451 * @brief Add a toggle to @p parent.
7453 * @param parent The parent object
7455 * @return The toggle object
7457 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7459 * @brief Sets the label to be displayed with the toggle.
7461 * @param obj The toggle object
7462 * @param label The label to be displayed
7464 * @deprecated use elm_object_text_set() instead.
7466 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7468 * @brief Gets the label of the toggle
7470 * @param obj toggle object
7471 * @return The label of the toggle
7473 * @deprecated use elm_object_text_get() instead.
7475 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7477 * @brief Set the icon used for the toggle
7479 * @param obj The toggle object
7480 * @param icon The icon object for the button
7482 * Once the icon object is set, a previously set one will be deleted
7483 * If you want to keep that old content object, use the
7484 * elm_toggle_icon_unset() function.
7486 * @deprecated use elm_object_content_set() instead.
7488 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7490 * @brief Get the icon used for the toggle
7492 * @param obj The toggle object
7493 * @return The icon object that is being used
7495 * Return the icon object which is set for this widget.
7497 * @see elm_toggle_icon_set()
7499 * @deprecated use elm_object_content_get() instead.
7501 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7503 * @brief Unset the icon used for the toggle
7505 * @param obj The toggle object
7506 * @return The icon object that was being used
7508 * Unparent and return the icon object which was set for this widget.
7510 * @see elm_toggle_icon_set()
7512 * @deprecated use elm_object_content_unset() instead.
7514 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7516 * @brief Sets the labels to be associated with the on and off states of the toggle.
7518 * @param obj The toggle object
7519 * @param onlabel The label displayed when the toggle is in the "on" state
7520 * @param offlabel The label displayed when the toggle is in the "off" state
7522 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7525 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7527 * @brief Gets the labels associated with the on and off states of the
7530 * @param obj The toggle object
7531 * @param onlabel A char** to place the onlabel of @p obj into
7532 * @param offlabel A char** to place the offlabel of @p obj into
7534 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7537 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7539 * @brief Sets the state of the toggle to @p state.
7541 * @param obj The toggle object
7542 * @param state The state of @p obj
7544 * @deprecated use elm_check_state_set() instead.
7546 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7548 * @brief Gets the state of the toggle to @p state.
7550 * @param obj The toggle object
7551 * @return The state of @p obj
7553 * @deprecated use elm_check_state_get() instead.
7555 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7557 * @brief Sets the state pointer of the toggle to @p statep.
7559 * @param obj The toggle object
7560 * @param statep The state pointer of @p obj
7562 * @deprecated use elm_check_state_pointer_set() instead.
7564 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7570 * @page tutorial_frame Frame example
7571 * @dontinclude frame_example_01.c
7573 * In this example we are going to create 4 Frames with different styles and
7574 * add a rectangle of different color in each.
7576 * We start we the usual setup code:
7579 * And then create one rectangle:
7582 * To add it in our first frame, which since it doesn't have it's style
7583 * specifically set uses the default style:
7586 * And then create another rectangle:
7589 * To add it in our second frame, which uses the "pad_small" style, note that
7590 * even tough we are setting a text for this frame it won't be show, only the
7591 * default style shows the Frame's title:
7593 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
7594 * very similar, their only difference is the size of the empty area around
7595 * the content of the frame.
7597 * And then create yet another rectangle:
7600 * To add it in our third frame, which uses the "outdent_top" style, note
7601 * that even tough we are setting a text for this frame it won't be show,
7602 * only the default style shows the Frame's title:
7605 * And then create one last rectangle:
7608 * To add it in our fourth and final frame, which uses the "outdent_bottom"
7609 * style, note that even tough we are setting a text for this frame it won't
7610 * be show, only the default style shows the Frame's title:
7613 * And now we are left with just some more setup code:
7616 * Our example will look like this:
7617 * @image html screenshots/frame_example_01.png
7618 * @image latex screenshots/frame_example_01.eps
7620 * @example frame_example_01.c
7623 * @defgroup Frame Frame
7625 * @brief Frame is a widget that holds some content and has a title.
7627 * The default look is a frame with a title, but Frame supports multple
7635 * @li outdent_bottom
7637 * Of all this styles only default shows the title. Frame emits no signals.
7639 * For a detailed example see the @ref tutorial_frame.
7644 * @brief Add a new frame to the parent
7646 * @param parent The parent object
7647 * @return The new object or NULL if it cannot be created
7649 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7651 * @brief Set the frame label
7653 * @param obj The frame object
7654 * @param label The label of this frame object
7656 * @deprecated use elm_object_text_set() instead.
7658 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7660 * @brief Get the frame label
7662 * @param obj The frame object
7664 * @return The label of this frame objet or NULL if unable to get frame
7666 * @deprecated use elm_object_text_get() instead.
7668 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7670 * @brief Set the content of the frame widget
7672 * Once the content object is set, a previously set one will be deleted.
7673 * If you want to keep that old content object, use the
7674 * elm_frame_content_unset() function.
7676 * @param obj The frame object
7677 * @param content The content will be filled in this frame object
7679 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7681 * @brief Get the content of the frame widget
7683 * Return the content object which is set for this widget
7685 * @param obj The frame object
7686 * @return The content that is being used
7688 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7690 * @brief Unset the content of the frame widget
7692 * Unparent and return the content object which was set for this widget
7694 * @param obj The frame object
7695 * @return The content that was being used
7697 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7703 * @defgroup Table Table
7705 * A container widget to arrange other widgets in a table where items can
7706 * also span multiple columns or rows - even overlap (and then be raised or
7707 * lowered accordingly to adjust stacking if they do overlap).
7709 * For a Table widget the row/column count is not fixed.
7710 * The table widget adjusts itself when subobjects are added to it dynamically.
7712 * The followin are examples of how to use a table:
7713 * @li @ref tutorial_table_01
7714 * @li @ref tutorial_table_02
7719 * @brief Add a new table to the parent
7721 * @param parent The parent object
7722 * @return The new object or NULL if it cannot be created
7724 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7726 * @brief Set the homogeneous layout in the table
7728 * @param obj The layout object
7729 * @param homogeneous A boolean to set if the layout is homogeneous in the
7730 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7732 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7734 * @brief Get the current table homogeneous mode.
7736 * @param obj The table object
7737 * @return A boolean to indicating if the layout is homogeneous in the table
7738 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7740 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7742 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7744 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7746 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7748 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7750 * @brief Set padding between cells.
7752 * @param obj The layout object.
7753 * @param horizontal set the horizontal padding.
7754 * @param vertical set the vertical padding.
7756 * Default value is 0.
7758 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7760 * @brief Get padding between cells.
7762 * @param obj The layout object.
7763 * @param horizontal set the horizontal padding.
7764 * @param vertical set the vertical padding.
7766 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7768 * @brief Add a subobject on the table with the coordinates passed
7770 * @param obj The table object
7771 * @param subobj The subobject to be added to the table
7772 * @param x Row number
7773 * @param y Column number
7777 * @note All positioning inside the table is relative to rows and columns, so
7778 * a value of 0 for x and y, means the top left cell of the table, and a
7779 * value of 1 for w and h means @p subobj only takes that 1 cell.
7781 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7783 * @brief Remove child from table.
7785 * @param obj The table object
7786 * @param subobj The subobject
7788 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7790 * @brief Faster way to remove all child objects from a table object.
7792 * @param obj The table object
7793 * @param clear If true, will delete children, else just remove from table.
7795 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7797 * @brief Set the packing location of an existing child of the table
7799 * @param subobj The subobject to be modified in the table
7800 * @param x Row number
7801 * @param y Column number
7805 * Modifies the position of an object already in the table.
7807 * @note All positioning inside the table is relative to rows and columns, so
7808 * a value of 0 for x and y, means the top left cell of the table, and a
7809 * value of 1 for w and h means @p subobj only takes that 1 cell.
7811 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7813 * @brief Get the packing location of an existing child of the table
7815 * @param subobj The subobject to be modified in the table
7816 * @param x Row number
7817 * @param y Column number
7821 * @see elm_table_pack_set()
7823 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7829 * @defgroup Gengrid Gengrid (Generic grid)
7831 * This widget aims to position objects in a grid layout while
7832 * actually creating and rendering only the visible ones, using the
7833 * same idea as the @ref Genlist "genlist": the user defines a @b
7834 * class for each item, specifying functions that will be called at
7835 * object creation, deletion, etc. When those items are selected by
7836 * the user, a callback function is issued. Users may interact with
7837 * a gengrid via the mouse (by clicking on items to select them and
7838 * clicking on the grid's viewport and swiping to pan the whole
7839 * view) or via the keyboard, navigating through item with the
7842 * @section Gengrid_Layouts Gengrid layouts
7844 * Gengrid may layout its items in one of two possible layouts:
7848 * When in "horizontal mode", items will be placed in @b columns,
7849 * from top to bottom and, when the space for a column is filled,
7850 * another one is started on the right, thus expanding the grid
7851 * horizontally, making for horizontal scrolling. When in "vertical
7852 * mode" , though, items will be placed in @b rows, from left to
7853 * right and, when the space for a row is filled, another one is
7854 * started below, thus expanding the grid vertically (and making
7855 * for vertical scrolling).
7857 * @section Gengrid_Items Gengrid items
7859 * An item in a gengrid can have 0 or more text labels (they can be
7860 * regular text or textblock Evas objects - that's up to the style
7861 * to determine), 0 or more icons (which are simply objects
7862 * swallowed into the gengrid item's theming Edje object) and 0 or
7863 * more <b>boolean states</b>, which have the behavior left to the
7864 * user to define. The Edje part names for each of these properties
7865 * will be looked up, in the theme file for the gengrid, under the
7866 * Edje (string) data items named @c "labels", @c "icons" and @c
7867 * "states", respectively. For each of those properties, if more
7868 * than one part is provided, they must have names listed separated
7869 * by spaces in the data fields. For the default gengrid item
7870 * theme, we have @b one label part (@c "elm.text"), @b two icon
7871 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7874 * A gengrid item may be at one of several styles. Elementary
7875 * provides one by default - "default", but this can be extended by
7876 * system or application custom themes/overlays/extensions (see
7877 * @ref Theme "themes" for more details).
7879 * @section Gengrid_Item_Class Gengrid item classes
7881 * In order to have the ability to add and delete items on the fly,
7882 * gengrid implements a class (callback) system where the
7883 * application provides a structure with information about that
7884 * type of item (gengrid may contain multiple different items with
7885 * different classes, states and styles). Gengrid will call the
7886 * functions in this struct (methods) when an item is "realized"
7887 * (i.e., created dynamically, while the user is scrolling the
7888 * grid). All objects will simply be deleted when no longer needed
7889 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7890 * contains the following members:
7891 * - @c item_style - This is a constant string and simply defines
7892 * the name of the item style. It @b must be specified and the
7893 * default should be @c "default".
7894 * - @c func.label_get - This function is called when an item
7895 * object is actually created. The @c data parameter will point to
7896 * the same data passed to elm_gengrid_item_append() and related
7897 * item creation functions. The @c obj parameter is the gengrid
7898 * object itself, while the @c part one is the name string of one
7899 * of the existing text parts in the Edje group implementing the
7900 * item's theme. This function @b must return a strdup'()ed string,
7901 * as the caller will free() it when done. See
7902 * #Elm_Gengrid_Item_Label_Get_Cb.
7903 * - @c func.content_get - This function is called when an item object
7904 * is actually created. The @c data parameter will point to the
7905 * same data passed to elm_gengrid_item_append() and related item
7906 * creation functions. The @c obj parameter is the gengrid object
7907 * itself, while the @c part one is the name string of one of the
7908 * existing (content) swallow parts in the Edje group implementing the
7909 * item's theme. It must return @c NULL, when no content is desired,
7910 * or a valid object handle, otherwise. The object will be deleted
7911 * by the gengrid on its deletion or when the item is "unrealized".
7912 * See #Elm_Gengrid_Item_Content_Get_Cb.
7913 * - @c func.state_get - This function is called when an item
7914 * object is actually created. The @c data parameter will point to
7915 * the same data passed to elm_gengrid_item_append() and related
7916 * item creation functions. The @c obj parameter is the gengrid
7917 * object itself, while the @c part one is the name string of one
7918 * of the state parts in the Edje group implementing the item's
7919 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7920 * true/on. Gengrids will emit a signal to its theming Edje object
7921 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7922 * "source" arguments, respectively, when the state is true (the
7923 * default is false), where @c XXX is the name of the (state) part.
7924 * See #Elm_Gengrid_Item_State_Get_Cb.
7925 * - @c func.del - This is called when elm_gengrid_item_del() is
7926 * called on an item or elm_gengrid_clear() is called on the
7927 * gengrid. This is intended for use when gengrid items are
7928 * deleted, so any data attached to the item (e.g. its data
7929 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7931 * @section Gengrid_Usage_Hints Usage hints
7933 * If the user wants to have multiple items selected at the same
7934 * time, elm_gengrid_multi_select_set() will permit it. If the
7935 * gengrid is single-selection only (the default), then
7936 * elm_gengrid_select_item_get() will return the selected item or
7937 * @c NULL, if none is selected. If the gengrid is under
7938 * multi-selection, then elm_gengrid_selected_items_get() will
7939 * return a list (that is only valid as long as no items are
7940 * modified (added, deleted, selected or unselected) of child items
7943 * If an item changes (internal (boolean) state, label or content
7944 * changes), then use elm_gengrid_item_update() to have gengrid
7945 * update the item with the new state. A gengrid will re-"realize"
7946 * the item, thus calling the functions in the
7947 * #Elm_Gengrid_Item_Class set for that item.
7949 * To programmatically (un)select an item, use
7950 * elm_gengrid_item_selected_set(). To get its selected state use
7951 * elm_gengrid_item_selected_get(). To make an item disabled
7952 * (unable to be selected and appear differently) use
7953 * elm_gengrid_item_disabled_set() to set this and
7954 * elm_gengrid_item_disabled_get() to get the disabled state.
7956 * Grid cells will only have their selection smart callbacks called
7957 * when firstly getting selected. Any further clicks will do
7958 * nothing, unless you enable the "always select mode", with
7959 * elm_gengrid_always_select_mode_set(), thus making every click to
7960 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7961 * turn off the ability to select items entirely in the widget and
7962 * they will neither appear selected nor call the selection smart
7965 * Remember that you can create new styles and add your own theme
7966 * augmentation per application with elm_theme_extension_add(). If
7967 * you absolutely must have a specific style that overrides any
7968 * theme the user or system sets up you can use
7969 * elm_theme_overlay_add() to add such a file.
7971 * @section Gengrid_Smart_Events Gengrid smart events
7973 * Smart events that you can add callbacks for are:
7974 * - @c "activated" - The user has double-clicked or pressed
7975 * (enter|return|spacebar) on an item. The @c event_info parameter
7976 * is the gengrid item that was activated.
7977 * - @c "clicked,double" - The user has double-clicked an item.
7978 * The @c event_info parameter is the gengrid item that was double-clicked.
7979 * - @c "longpressed" - This is called when the item is pressed for a certain
7980 * amount of time. By default it's 1 second.
7981 * - @c "selected" - The user has made an item selected. The
7982 * @c event_info parameter is the gengrid item that was selected.
7983 * - @c "unselected" - The user has made an item unselected. The
7984 * @c event_info parameter is the gengrid item that was unselected.
7985 * - @c "realized" - This is called when the item in the gengrid
7986 * has its implementing Evas object instantiated, de facto. @c
7987 * event_info is the gengrid item that was created. The object
7988 * may be deleted at any time, so it is highly advised to the
7989 * caller @b not to use the object pointer returned from
7990 * elm_gengrid_item_object_get(), because it may point to freed
7992 * - @c "unrealized" - This is called when the implementing Evas
7993 * object for this item is deleted. @c event_info is the gengrid
7994 * item that was deleted.
7995 * - @c "changed" - Called when an item is added, removed, resized
7996 * or moved and when the gengrid is resized or gets "horizontal"
7998 * - @c "scroll,anim,start" - This is called when scrolling animation has
8000 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8002 * - @c "drag,start,up" - Called when the item in the gengrid has
8003 * been dragged (not scrolled) up.
8004 * - @c "drag,start,down" - Called when the item in the gengrid has
8005 * been dragged (not scrolled) down.
8006 * - @c "drag,start,left" - Called when the item in the gengrid has
8007 * been dragged (not scrolled) left.
8008 * - @c "drag,start,right" - Called when the item in the gengrid has
8009 * been dragged (not scrolled) right.
8010 * - @c "drag,stop" - Called when the item in the gengrid has
8011 * stopped being dragged.
8012 * - @c "drag" - Called when the item in the gengrid is being
8014 * - @c "scroll" - called when the content has been scrolled
8016 * - @c "scroll,drag,start" - called when dragging the content has
8018 * - @c "scroll,drag,stop" - called when dragging the content has
8020 * - @c "edge,top" - This is called when the gengrid is scrolled until
8022 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8023 * until the bottom edge.
8024 * - @c "edge,left" - This is called when the gengrid is scrolled
8025 * until the left edge.
8026 * - @c "edge,right" - This is called when the gengrid is scrolled
8027 * until the right edge.
8029 * List of gengrid examples:
8030 * @li @ref gengrid_example
8034 * @addtogroup Gengrid
8038 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8039 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8040 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8041 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8042 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8043 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. */
8044 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8046 /* temporary compatibility code */
8047 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8048 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8049 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8050 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8053 * @struct _Elm_Gengrid_Item_Class
8055 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8058 struct _Elm_Gengrid_Item_Class
8060 const char *item_style;
8061 struct _Elm_Gengrid_Item_Class_Func
8063 Elm_Gengrid_Item_Label_Get_Cb label_get;
8064 Elm_Gengrid_Item_Content_Get_Cb icon_get;
8065 Elm_Gengrid_Item_State_Get_Cb state_get;
8066 Elm_Gengrid_Item_Del_Cb del;
8068 }; /**< #Elm_Gengrid_Item_Class member definitions */
8070 * Add a new gengrid widget to the given parent Elementary
8071 * (container) object
8073 * @param parent The parent object
8074 * @return a new gengrid widget handle or @c NULL, on errors
8076 * This function inserts a new gengrid widget on the canvas.
8078 * @see elm_gengrid_item_size_set()
8079 * @see elm_gengrid_group_item_size_set()
8080 * @see elm_gengrid_horizontal_set()
8081 * @see elm_gengrid_item_append()
8082 * @see elm_gengrid_item_del()
8083 * @see elm_gengrid_clear()
8087 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8090 * Set the size for the items of a given gengrid widget
8092 * @param obj The gengrid object.
8093 * @param w The items' width.
8094 * @param h The items' height;
8096 * A gengrid, after creation, has still no information on the size
8097 * to give to each of its cells. So, you most probably will end up
8098 * with squares one @ref Fingers "finger" wide, the default
8099 * size. Use this function to force a custom size for you items,
8100 * making them as big as you wish.
8102 * @see elm_gengrid_item_size_get()
8106 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8109 * Get the size set for the items of a given gengrid widget
8111 * @param obj The gengrid object.
8112 * @param w Pointer to a variable where to store the items' width.
8113 * @param h Pointer to a variable where to store the items' height.
8115 * @note Use @c NULL pointers on the size values you're not
8116 * interested in: they'll be ignored by the function.
8118 * @see elm_gengrid_item_size_get() for more details
8122 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8125 * Set the items grid's alignment within a given gengrid widget
8127 * @param obj The gengrid object.
8128 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8129 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8131 * This sets the alignment of the whole grid of items of a gengrid
8132 * within its given viewport. By default, those values are both
8133 * 0.5, meaning that the gengrid will have its items grid placed
8134 * exactly in the middle of its viewport.
8136 * @note If given alignment values are out of the cited ranges,
8137 * they'll be changed to the nearest boundary values on the valid
8140 * @see elm_gengrid_align_get()
8144 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8147 * Get the items grid's alignment values within a given gengrid
8150 * @param obj The gengrid object.
8151 * @param align_x Pointer to a variable where to store the
8152 * horizontal alignment.
8153 * @param align_y Pointer to a variable where to store the vertical
8156 * @note Use @c NULL pointers on the alignment values you're not
8157 * interested in: they'll be ignored by the function.
8159 * @see elm_gengrid_align_set() for more details
8163 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8166 * Set whether a given gengrid widget is or not able have items
8169 * @param obj The gengrid object
8170 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8171 * @c EINA_FALSE to turn it off
8173 * If a gengrid is set to allow reordering, a click held for more
8174 * than 0.5 over a given item will highlight it specially,
8175 * signalling the gengrid has entered the reordering state. From
8176 * that time on, the user will be able to, while still holding the
8177 * mouse button down, move the item freely in the gengrid's
8178 * viewport, replacing to said item to the locations it goes to.
8179 * The replacements will be animated and, whenever the user
8180 * releases the mouse button, the item being replaced gets a new
8181 * definitive place in the grid.
8183 * @see elm_gengrid_reorder_mode_get()
8187 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8190 * Get whether a given gengrid widget is or not able have items
8193 * @param obj The gengrid object
8194 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8197 * @see elm_gengrid_reorder_mode_set() for more details
8201 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8204 * Append a new item in a given gengrid widget.
8206 * @param obj The gengrid object.
8207 * @param gic The item class for the item.
8208 * @param data The item data.
8209 * @param func Convenience function called when the item is
8211 * @param func_data Data to be passed to @p func.
8212 * @return A handle to the item added or @c NULL, on errors.
8214 * This adds an item to the beginning of the gengrid.
8216 * @see elm_gengrid_item_prepend()
8217 * @see elm_gengrid_item_insert_before()
8218 * @see elm_gengrid_item_insert_after()
8219 * @see elm_gengrid_item_del()
8223 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);
8226 * Prepend a new item in a given gengrid widget.
8228 * @param obj The gengrid object.
8229 * @param gic The item class for the item.
8230 * @param data The item data.
8231 * @param func Convenience function called when the item is
8233 * @param func_data Data to be passed to @p func.
8234 * @return A handle to the item added or @c NULL, on errors.
8236 * This adds an item to the end of the gengrid.
8238 * @see elm_gengrid_item_append()
8239 * @see elm_gengrid_item_insert_before()
8240 * @see elm_gengrid_item_insert_after()
8241 * @see elm_gengrid_item_del()
8245 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);
8248 * Insert an item before another in a gengrid widget
8250 * @param obj The gengrid object.
8251 * @param gic The item class for the item.
8252 * @param data The item data.
8253 * @param relative The item to place this new one before.
8254 * @param func Convenience function called when the item is
8256 * @param func_data Data to be passed to @p func.
8257 * @return A handle to the item added or @c NULL, on errors.
8259 * This inserts an item before another in the gengrid.
8261 * @see elm_gengrid_item_append()
8262 * @see elm_gengrid_item_prepend()
8263 * @see elm_gengrid_item_insert_after()
8264 * @see elm_gengrid_item_del()
8268 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);
8271 * Insert an item after another in a gengrid widget
8273 * @param obj The gengrid object.
8274 * @param gic The item class for the item.
8275 * @param data The item data.
8276 * @param relative The item to place this new one after.
8277 * @param func Convenience function called when the item is
8279 * @param func_data Data to be passed to @p func.
8280 * @return A handle to the item added or @c NULL, on errors.
8282 * This inserts an item after another in the gengrid.
8284 * @see elm_gengrid_item_append()
8285 * @see elm_gengrid_item_prepend()
8286 * @see elm_gengrid_item_insert_after()
8287 * @see elm_gengrid_item_del()
8291 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);
8294 * Insert an item in a gengrid widget using a user-defined sort function.
8296 * @param obj The gengrid object.
8297 * @param gic The item class for the item.
8298 * @param data The item data.
8299 * @param comp User defined comparison function that defines the sort order based on
8300 * Elm_Gen_Item and its data param.
8301 * @param func Convenience function called when the item is selected.
8302 * @param func_data Data to be passed to @p func.
8303 * @return A handle to the item added or @c NULL, on errors.
8305 * This inserts an item in the gengrid based on user defined comparison function.
8307 * @see elm_gengrid_item_append()
8308 * @see elm_gengrid_item_prepend()
8309 * @see elm_gengrid_item_insert_after()
8310 * @see elm_gengrid_item_del()
8311 * @see elm_gengrid_item_direct_sorted_insert()
8315 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);
8318 * Insert an item in a gengrid widget using a user-defined sort function.
8320 * @param obj The gengrid object.
8321 * @param gic The item class for the item.
8322 * @param data The item data.
8323 * @param comp User defined comparison function that defines the sort order based on
8325 * @param func Convenience function called when the item is selected.
8326 * @param func_data Data to be passed to @p func.
8327 * @return A handle to the item added or @c NULL, on errors.
8329 * This inserts an item in the gengrid based on user defined comparison function.
8331 * @see elm_gengrid_item_append()
8332 * @see elm_gengrid_item_prepend()
8333 * @see elm_gengrid_item_insert_after()
8334 * @see elm_gengrid_item_del()
8335 * @see elm_gengrid_item_sorted_insert()
8339 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);
8342 * Set whether items on a given gengrid widget are to get their
8343 * selection callbacks issued for @b every subsequent selection
8344 * click on them or just for the first click.
8346 * @param obj The gengrid object
8347 * @param always_select @c EINA_TRUE to make items "always
8348 * selected", @c EINA_FALSE, otherwise
8350 * By default, grid items will only call their selection callback
8351 * function when firstly getting selected, any subsequent further
8352 * clicks will do nothing. With this call, you make those
8353 * subsequent clicks also to issue the selection callbacks.
8355 * @note <b>Double clicks</b> will @b always be reported on items.
8357 * @see elm_gengrid_always_select_mode_get()
8361 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8364 * Get whether items on a given gengrid widget have their selection
8365 * callbacks issued for @b every subsequent selection click on them
8366 * or just for the first click.
8368 * @param obj The gengrid object.
8369 * @return @c EINA_TRUE if the gengrid items are "always selected",
8370 * @c EINA_FALSE, otherwise
8372 * @see elm_gengrid_always_select_mode_set() for more details
8376 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8379 * Set whether items on a given gengrid widget can be selected or not.
8381 * @param obj The gengrid object
8382 * @param no_select @c EINA_TRUE to make items selectable,
8383 * @c EINA_FALSE otherwise
8385 * This will make items in @p obj selectable or not. In the latter
8386 * case, any user interaction on the gengrid items will neither make
8387 * them appear selected nor them call their selection callback
8390 * @see elm_gengrid_no_select_mode_get()
8394 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8397 * Get whether items on a given gengrid widget can be selected or
8400 * @param obj The gengrid object
8401 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8404 * @see elm_gengrid_no_select_mode_set() for more details
8408 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8411 * Enable or disable multi-selection in a given gengrid widget
8413 * @param obj The gengrid object.
8414 * @param multi @c EINA_TRUE, to enable multi-selection,
8415 * @c EINA_FALSE to disable it.
8417 * Multi-selection is the ability to have @b more than one
8418 * item selected, on a given gengrid, simultaneously. When it is
8419 * enabled, a sequence of clicks on different items will make them
8420 * all selected, progressively. A click on an already selected item
8421 * will unselect it. If interacting via the keyboard,
8422 * multi-selection is enabled while holding the "Shift" key.
8424 * @note By default, multi-selection is @b disabled on gengrids
8426 * @see elm_gengrid_multi_select_get()
8430 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8433 * Get whether multi-selection is enabled or disabled for a given
8436 * @param obj The gengrid object.
8437 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8438 * EINA_FALSE otherwise
8440 * @see elm_gengrid_multi_select_set() for more details
8444 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8447 * Enable or disable bouncing effect for a given gengrid widget
8449 * @param obj The gengrid object
8450 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8451 * @c EINA_FALSE to disable it
8452 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8453 * @c EINA_FALSE to disable it
8455 * The bouncing effect occurs whenever one reaches the gengrid's
8456 * edge's while panning it -- it will scroll past its limits a
8457 * little bit and return to the edge again, in a animated for,
8460 * @note By default, gengrids have bouncing enabled on both axis
8462 * @see elm_gengrid_bounce_get()
8466 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8469 * Get whether bouncing effects are enabled or disabled, for a
8470 * given gengrid widget, on each axis
8472 * @param obj The gengrid object
8473 * @param h_bounce Pointer to a variable where to store the
8474 * horizontal bouncing flag.
8475 * @param v_bounce Pointer to a variable where to store the
8476 * vertical bouncing flag.
8478 * @see elm_gengrid_bounce_set() for more details
8482 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8485 * Set a given gengrid widget's scrolling page size, relative to
8486 * its viewport size.
8488 * @param obj The gengrid object
8489 * @param h_pagerel The horizontal page (relative) size
8490 * @param v_pagerel The vertical page (relative) size
8492 * The gengrid's scroller is capable of binding scrolling by the
8493 * user to "pages". It means that, while scrolling and, specially
8494 * after releasing the mouse button, the grid will @b snap to the
8495 * nearest displaying page's area. When page sizes are set, the
8496 * grid's continuous content area is split into (equal) page sized
8499 * This function sets the size of a page <b>relatively to the
8500 * viewport dimensions</b> of the gengrid, for each axis. A value
8501 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8502 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8503 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8504 * 1.0. Values beyond those will make it behave behave
8505 * inconsistently. If you only want one axis to snap to pages, use
8506 * the value @c 0.0 for the other one.
8508 * There is a function setting page size values in @b absolute
8509 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8510 * is mutually exclusive to this one.
8512 * @see elm_gengrid_page_relative_get()
8516 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8519 * Get a given gengrid widget's scrolling page size, relative to
8520 * its viewport size.
8522 * @param obj The gengrid object
8523 * @param h_pagerel Pointer to a variable where to store the
8524 * horizontal page (relative) size
8525 * @param v_pagerel Pointer to a variable where to store the
8526 * vertical page (relative) size
8528 * @see elm_gengrid_page_relative_set() for more details
8532 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8535 * Set a given gengrid widget's scrolling page size
8537 * @param obj The gengrid object
8538 * @param h_pagerel The horizontal page size, in pixels
8539 * @param v_pagerel The vertical page size, in pixels
8541 * The gengrid's scroller is capable of binding scrolling by the
8542 * user to "pages". It means that, while scrolling and, specially
8543 * after releasing the mouse button, the grid will @b snap to the
8544 * nearest displaying page's area. When page sizes are set, the
8545 * grid's continuous content area is split into (equal) page sized
8548 * This function sets the size of a page of the gengrid, in pixels,
8549 * for each axis. Sane usable values are, between @c 0 and the
8550 * dimensions of @p obj, for each axis. Values beyond those will
8551 * make it behave behave inconsistently. If you only want one axis
8552 * to snap to pages, use the value @c 0 for the other one.
8554 * There is a function setting page size values in @b relative
8555 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8556 * use is mutually exclusive to this one.
8560 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8563 * Set the direction in which a given gengrid widget will expand while
8564 * placing its items.
8566 * @param obj The gengrid object.
8567 * @param setting @c EINA_TRUE to make the gengrid expand
8568 * horizontally, @c EINA_FALSE to expand vertically.
8570 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8571 * in @b columns, from top to bottom and, when the space for a
8572 * column is filled, another one is started on the right, thus
8573 * expanding the grid horizontally. When in "vertical mode"
8574 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8575 * to right and, when the space for a row is filled, another one is
8576 * started below, thus expanding the grid vertically.
8578 * @see elm_gengrid_horizontal_get()
8582 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8585 * Get for what direction a given gengrid widget will expand while
8586 * placing its items.
8588 * @param obj The gengrid object.
8589 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8590 * @c EINA_FALSE if it's set to expand vertically.
8592 * @see elm_gengrid_horizontal_set() for more detais
8596 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8599 * Get the first item in a given gengrid widget
8601 * @param obj The gengrid object
8602 * @return The first item's handle or @c NULL, if there are no
8603 * items in @p obj (and on errors)
8605 * This returns the first item in the @p obj's internal list of
8608 * @see elm_gengrid_last_item_get()
8612 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8615 * Get the last item in a given gengrid widget
8617 * @param obj The gengrid object
8618 * @return The last item's handle or @c NULL, if there are no
8619 * items in @p obj (and on errors)
8621 * This returns the last item in the @p obj's internal list of
8624 * @see elm_gengrid_first_item_get()
8628 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8631 * Get the @b next item in a gengrid widget's internal list of items,
8632 * given a handle to one of those items.
8634 * @param item The gengrid item to fetch next from
8635 * @return The item after @p item, or @c NULL if there's none (and
8638 * This returns the item placed after the @p item, on the container
8641 * @see elm_gengrid_item_prev_get()
8645 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8648 * Get the @b previous item in a gengrid widget's internal list of items,
8649 * given a handle to one of those items.
8651 * @param item The gengrid item to fetch previous from
8652 * @return The item before @p item, or @c NULL if there's none (and
8655 * This returns the item placed before the @p item, on the container
8658 * @see elm_gengrid_item_next_get()
8662 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8665 * Get the gengrid object's handle which contains a given gengrid
8668 * @param item The item to fetch the container from
8669 * @return The gengrid (parent) object
8671 * This returns the gengrid object itself that an item belongs to.
8675 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8678 * Remove a gengrid item from its parent, deleting it.
8680 * @param item The item to be removed.
8681 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8683 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8688 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8691 * Update the contents of a given gengrid item
8693 * @param item The gengrid item
8695 * This updates an item by calling all the item class functions
8696 * again to get the contents, labels and states. Use this when the
8697 * original item data has changed and you want the changes to be
8702 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8705 * Get the Gengrid Item class for the given Gengrid Item.
8707 * @param item The gengrid item
8709 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8710 * the function pointers and item_style.
8714 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8717 * Get the Gengrid Item class for the given Gengrid Item.
8719 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8720 * the function pointers and item_style.
8722 * @param item The gengrid item
8723 * @param gic The gengrid item class describing the function pointers and the item style.
8727 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8730 * Return the data associated to a given gengrid item
8732 * @param item The gengrid item.
8733 * @return the data associated with this item.
8735 * This returns the @c data value passed on the
8736 * elm_gengrid_item_append() and related item addition calls.
8738 * @see elm_gengrid_item_append()
8739 * @see elm_gengrid_item_data_set()
8743 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8746 * Set the data associated with a given gengrid item
8748 * @param item The gengrid item
8749 * @param data The data pointer to set on it
8751 * This @b overrides the @c data value passed on the
8752 * elm_gengrid_item_append() and related item addition calls. This
8753 * function @b won't call elm_gengrid_item_update() automatically,
8754 * so you'd issue it afterwards if you want to have the item
8755 * updated to reflect the new data.
8757 * @see elm_gengrid_item_data_get()
8758 * @see elm_gengrid_item_update()
8762 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8765 * Get a given gengrid item's position, relative to the whole
8766 * gengrid's grid area.
8768 * @param item The Gengrid item.
8769 * @param x Pointer to variable to store the item's <b>row number</b>.
8770 * @param y Pointer to variable to store the item's <b>column number</b>.
8772 * This returns the "logical" position of the item within the
8773 * gengrid. For example, @c (0, 1) would stand for first row,
8778 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8781 * Set whether a given gengrid item is selected or not
8783 * @param item The gengrid item
8784 * @param selected Use @c EINA_TRUE, to make it selected, @c
8785 * EINA_FALSE to make it unselected
8787 * This sets the selected state of an item. If multi-selection is
8788 * not enabled on the containing gengrid and @p selected is @c
8789 * EINA_TRUE, any other previously selected items will get
8790 * unselected in favor of this new one.
8792 * @see elm_gengrid_item_selected_get()
8796 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8799 * Get whether a given gengrid item is selected or not
8801 * @param item The gengrid item
8802 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8804 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8806 * @see elm_gengrid_item_selected_set() for more details
8810 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8813 * Get the real Evas object created to implement the view of a
8814 * given gengrid item
8816 * @param item The gengrid item.
8817 * @return the Evas object implementing this item's view.
8819 * This returns the actual Evas object used to implement the
8820 * specified gengrid item's view. This may be @c NULL, as it may
8821 * not have been created or may have been deleted, at any time, by
8822 * the gengrid. <b>Do not modify this object</b> (move, resize,
8823 * show, hide, etc.), as the gengrid is controlling it. This
8824 * function is for querying, emitting custom signals or hooking
8825 * lower level callbacks for events on that object. Do not delete
8826 * this object under any circumstances.
8828 * @see elm_gengrid_item_data_get()
8832 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8835 * Show the portion of a gengrid's internal grid containing a given
8836 * item, @b immediately.
8838 * @param item The item to display
8840 * This causes gengrid to @b redraw its viewport's contents to the
8841 * region contining the given @p item item, if it is not fully
8844 * @see elm_gengrid_item_bring_in()
8848 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8851 * Animatedly bring in, to the visible area of a gengrid, a given
8854 * @param item The gengrid item to display
8856 * This causes gengrid to jump to the given @p item and show
8857 * it (by scrolling), if it is not fully visible. This will use
8858 * animation to do so and take a period of time to complete.
8860 * @see elm_gengrid_item_show()
8864 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8867 * Set whether a given gengrid item is disabled or not.
8869 * @param item The gengrid item
8870 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8871 * to enable it back.
8873 * A disabled item cannot be selected or unselected. It will also
8874 * change its appearance, to signal the user it's disabled.
8876 * @see elm_gengrid_item_disabled_get()
8880 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8883 * Get whether a given gengrid item is disabled or not.
8885 * @param item The gengrid item
8886 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8889 * @see elm_gengrid_item_disabled_set() for more details
8893 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8896 * Set the text to be shown in a given gengrid item's tooltips.
8898 * @param item The gengrid item
8899 * @param text The text to set in the content
8901 * This call will setup the text to be used as tooltip to that item
8902 * (analogous to elm_object_tooltip_text_set(), but being item
8903 * tooltips with higher precedence than object tooltips). It can
8904 * have only one tooltip at a time, so any previous tooltip data
8909 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8912 * Set the content to be shown in a given gengrid item's tooltip
8914 * @param item The gengrid item.
8915 * @param func The function returning the tooltip contents.
8916 * @param data What to provide to @a func as callback data/context.
8917 * @param del_cb Called when data is not needed anymore, either when
8918 * another callback replaces @p func, the tooltip is unset with
8919 * elm_gengrid_item_tooltip_unset() or the owner @p item
8920 * dies. This callback receives as its first parameter the
8921 * given @p data, being @c event_info the item handle.
8923 * This call will setup the tooltip's contents to @p item
8924 * (analogous to elm_object_tooltip_content_cb_set(), but being
8925 * item tooltips with higher precedence than object tooltips). It
8926 * can have only one tooltip at a time, so any previous tooltip
8927 * content will get removed. @p func (with @p data) will be called
8928 * every time Elementary needs to show the tooltip and it should
8929 * return a valid Evas object, which will be fully managed by the
8930 * tooltip system, getting deleted when the tooltip is gone.
8934 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);
8937 * Unset a tooltip from a given gengrid item
8939 * @param item gengrid item to remove a previously set tooltip from.
8941 * This call removes any tooltip set on @p item. The callback
8942 * provided as @c del_cb to
8943 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8944 * notify it is not used anymore (and have resources cleaned, if
8947 * @see elm_gengrid_item_tooltip_content_cb_set()
8951 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8954 * Set a different @b style for a given gengrid item's tooltip.
8956 * @param item gengrid item with tooltip set
8957 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8958 * "default", @c "transparent", etc)
8960 * Tooltips can have <b>alternate styles</b> to be displayed on,
8961 * which are defined by the theme set on Elementary. This function
8962 * works analogously as elm_object_tooltip_style_set(), but here
8963 * applied only to gengrid item objects. The default style for
8964 * tooltips is @c "default".
8966 * @note before you set a style you should define a tooltip with
8967 * elm_gengrid_item_tooltip_content_cb_set() or
8968 * elm_gengrid_item_tooltip_text_set()
8970 * @see elm_gengrid_item_tooltip_style_get()
8974 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8977 * Get the style set a given gengrid item's tooltip.
8979 * @param item gengrid item with tooltip already set on.
8980 * @return style the theme style in use, which defaults to
8981 * "default". If the object does not have a tooltip set,
8982 * then @c NULL is returned.
8984 * @see elm_gengrid_item_tooltip_style_set() for more details
8988 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8990 * Set the type of mouse pointer/cursor decoration to be shown,
8991 * when the mouse pointer is over the given gengrid widget item
8993 * @param item gengrid item to customize cursor on
8994 * @param cursor the cursor type's name
8996 * This function works analogously as elm_object_cursor_set(), but
8997 * here the cursor's changing area is restricted to the item's
8998 * area, and not the whole widget's. Note that that item cursors
8999 * have precedence over widget cursors, so that a mouse over @p
9000 * item will always show cursor @p type.
9002 * If this function is called twice for an object, a previously set
9003 * cursor will be unset on the second call.
9005 * @see elm_object_cursor_set()
9006 * @see elm_gengrid_item_cursor_get()
9007 * @see elm_gengrid_item_cursor_unset()
9011 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9014 * Get the type of mouse pointer/cursor decoration set to be shown,
9015 * when the mouse pointer is over the given gengrid widget item
9017 * @param item gengrid item with custom cursor set
9018 * @return the cursor type's name or @c NULL, if no custom cursors
9019 * were set to @p item (and on errors)
9021 * @see elm_object_cursor_get()
9022 * @see elm_gengrid_item_cursor_set() for more details
9023 * @see elm_gengrid_item_cursor_unset()
9027 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9030 * Unset any custom mouse pointer/cursor decoration set to be
9031 * shown, when the mouse pointer is over the given gengrid widget
9032 * item, thus making it show the @b default cursor again.
9034 * @param item a gengrid item
9036 * Use this call to undo any custom settings on this item's cursor
9037 * decoration, bringing it back to defaults (no custom style set).
9039 * @see elm_object_cursor_unset()
9040 * @see elm_gengrid_item_cursor_set() for more details
9044 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9047 * Set a different @b style for a given custom cursor set for a
9050 * @param item gengrid item with custom cursor set
9051 * @param style the <b>theme style</b> to use (e.g. @c "default",
9052 * @c "transparent", etc)
9054 * This function only makes sense when one is using custom mouse
9055 * cursor decorations <b>defined in a theme file</b> , which can
9056 * have, given a cursor name/type, <b>alternate styles</b> on
9057 * it. It works analogously as elm_object_cursor_style_set(), but
9058 * here applied only to gengrid item objects.
9060 * @warning Before you set a cursor style you should have defined a
9061 * custom cursor previously on the item, with
9062 * elm_gengrid_item_cursor_set()
9064 * @see elm_gengrid_item_cursor_engine_only_set()
9065 * @see elm_gengrid_item_cursor_style_get()
9069 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9072 * Get the current @b style set for a given gengrid item's custom
9075 * @param item gengrid item with custom cursor set.
9076 * @return style the cursor style in use. If the object does not
9077 * have a cursor set, then @c NULL is returned.
9079 * @see elm_gengrid_item_cursor_style_set() for more details
9083 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9086 * Set if the (custom) cursor for a given gengrid item should be
9087 * searched in its theme, also, or should only rely on the
9090 * @param item item with custom (custom) cursor already set on
9091 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9092 * only on those provided by the rendering engine, @c EINA_FALSE to
9093 * have them searched on the widget's theme, as well.
9095 * @note This call is of use only if you've set a custom cursor
9096 * for gengrid items, with elm_gengrid_item_cursor_set().
9098 * @note By default, cursors will only be looked for between those
9099 * provided by the rendering engine.
9103 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9106 * Get if the (custom) cursor for a given gengrid item is being
9107 * searched in its theme, also, or is only relying on the rendering
9110 * @param item a gengrid item
9111 * @return @c EINA_TRUE, if cursors are being looked for only on
9112 * those provided by the rendering engine, @c EINA_FALSE if they
9113 * are being searched on the widget's theme, as well.
9115 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9119 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122 * Remove all items from a given gengrid widget
9124 * @param obj The gengrid object.
9126 * This removes (and deletes) all items in @p obj, leaving it
9129 * @see elm_gengrid_item_del(), to remove just one item.
9133 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9136 * Get the selected item in a given gengrid widget
9138 * @param obj The gengrid object.
9139 * @return The selected item's handleor @c NULL, if none is
9140 * selected at the moment (and on errors)
9142 * This returns the selected item in @p obj. If multi selection is
9143 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9144 * the first item in the list is selected, which might not be very
9145 * useful. For that case, see elm_gengrid_selected_items_get().
9149 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9152 * Get <b>a list</b> of selected items in a given gengrid
9154 * @param obj The gengrid object.
9155 * @return The list of selected items or @c NULL, if none is
9156 * selected at the moment (and on errors)
9158 * This returns a list of the selected items, in the order that
9159 * they appear in the grid. This list is only valid as long as no
9160 * more items are selected or unselected (or unselected implictly
9161 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9164 * @see elm_gengrid_selected_item_get()
9168 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9175 * @defgroup Clock Clock
9177 * @image html img/widget/clock/preview-00.png
9178 * @image latex img/widget/clock/preview-00.eps
9180 * This is a @b digital clock widget. In its default theme, it has a
9181 * vintage "flipping numbers clock" appearance, which will animate
9182 * sheets of individual algarisms individually as time goes by.
9184 * A newly created clock will fetch system's time (already
9185 * considering local time adjustments) to start with, and will tick
9186 * accondingly. It may or may not show seconds.
9188 * Clocks have an @b edition mode. When in it, the sheets will
9189 * display extra arrow indications on the top and bottom and the
9190 * user may click on them to raise or lower the time values. After
9191 * it's told to exit edition mode, it will keep ticking with that
9192 * new time set (it keeps the difference from local time).
9194 * Also, when under edition mode, user clicks on the cited arrows
9195 * which are @b held for some time will make the clock to flip the
9196 * sheet, thus editing the time, continuosly and automatically for
9197 * the user. The interval between sheet flips will keep growing in
9198 * time, so that it helps the user to reach a time which is distant
9201 * The time display is, by default, in military mode (24h), but an
9202 * am/pm indicator may be optionally shown, too, when it will
9205 * Smart callbacks one can register to:
9206 * - "changed" - the clock's user changed the time
9208 * Here is an example on its usage:
9209 * @li @ref clock_example
9218 * Identifiers for which clock digits should be editable, when a
9219 * clock widget is in edition mode. Values may be ORed together to
9220 * make a mask, naturally.
9222 * @see elm_clock_edit_set()
9223 * @see elm_clock_digit_edit_set()
9225 typedef enum _Elm_Clock_Digedit
9227 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9228 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9229 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9230 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9231 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9232 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9233 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9234 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9235 } Elm_Clock_Digedit;
9238 * Add a new clock widget to the given parent Elementary
9239 * (container) object
9241 * @param parent The parent object
9242 * @return a new clock widget handle or @c NULL, on errors
9244 * This function inserts a new clock widget on the canvas.
9248 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9251 * Set a clock widget's time, programmatically
9253 * @param obj The clock widget object
9254 * @param hrs The hours to set
9255 * @param min The minutes to set
9256 * @param sec The secondes to set
9258 * This function updates the time that is showed by the clock
9261 * Values @b must be set within the following ranges:
9262 * - 0 - 23, for hours
9263 * - 0 - 59, for minutes
9264 * - 0 - 59, for seconds,
9266 * even if the clock is not in "military" mode.
9268 * @warning The behavior for values set out of those ranges is @b
9273 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9276 * Get a clock widget's time values
9278 * @param obj The clock object
9279 * @param[out] hrs Pointer to the variable to get the hours value
9280 * @param[out] min Pointer to the variable to get the minutes value
9281 * @param[out] sec Pointer to the variable to get the seconds value
9283 * This function gets the time set for @p obj, returning
9284 * it on the variables passed as the arguments to function
9286 * @note Use @c NULL pointers on the time values you're not
9287 * interested in: they'll be ignored by the function.
9291 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9294 * Set whether a given clock widget is under <b>edition mode</b> or
9295 * under (default) displaying-only mode.
9297 * @param obj The clock object
9298 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9299 * put it back to "displaying only" mode
9301 * This function makes a clock's time to be editable or not <b>by
9302 * user interaction</b>. When in edition mode, clocks @b stop
9303 * ticking, until one brings them back to canonical mode. The
9304 * elm_clock_digit_edit_set() function will influence which digits
9305 * of the clock will be editable. By default, all of them will be
9306 * (#ELM_CLOCK_NONE).
9308 * @note am/pm sheets, if being shown, will @b always be editable
9309 * under edition mode.
9311 * @see elm_clock_edit_get()
9315 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9318 * Retrieve whether a given clock widget is under <b>edition
9319 * mode</b> or under (default) displaying-only mode.
9321 * @param obj The clock object
9322 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9325 * This function retrieves whether the clock's time can be edited
9326 * or not by user interaction.
9328 * @see elm_clock_edit_set() for more details
9332 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9335 * Set what digits of the given clock widget should be editable
9336 * when in edition mode.
9338 * @param obj The clock object
9339 * @param digedit Bit mask indicating the digits to be editable
9340 * (values in #Elm_Clock_Digedit).
9342 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9343 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9346 * @see elm_clock_digit_edit_get()
9350 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9353 * Retrieve what digits of the given clock widget should be
9354 * editable when in edition mode.
9356 * @param obj The clock object
9357 * @return Bit mask indicating the digits to be editable
9358 * (values in #Elm_Clock_Digedit).
9360 * @see elm_clock_digit_edit_set() for more details
9364 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9367 * Set if the given clock widget must show hours in military or
9370 * @param obj The clock object
9371 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9374 * This function sets if the clock must show hours in military or
9375 * am/pm mode. In some countries like Brazil the military mode
9376 * (00-24h-format) is used, in opposition to the USA, where the
9377 * am/pm mode is more commonly used.
9379 * @see elm_clock_show_am_pm_get()
9383 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9386 * Get if the given clock widget shows hours in military or am/pm
9389 * @param obj The clock object
9390 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9393 * This function gets if the clock shows hours in military or am/pm
9396 * @see elm_clock_show_am_pm_set() for more details
9400 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9403 * Set if the given clock widget must show time with seconds or not
9405 * @param obj The clock object
9406 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9408 * This function sets if the given clock must show or not elapsed
9409 * seconds. By default, they are @b not shown.
9411 * @see elm_clock_show_seconds_get()
9415 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9418 * Get whether the given clock widget is showing time with seconds
9421 * @param obj The clock object
9422 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9424 * This function gets whether @p obj is showing or not the elapsed
9427 * @see elm_clock_show_seconds_set()
9431 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9434 * Set the interval on time updates for an user mouse button hold
9435 * on clock widgets' time edition.
9437 * @param obj The clock object
9438 * @param interval The (first) interval value in seconds
9440 * This interval value is @b decreased while the user holds the
9441 * mouse pointer either incrementing or decrementing a given the
9442 * clock digit's value.
9444 * This helps the user to get to a given time distant from the
9445 * current one easier/faster, as it will start to flip quicker and
9446 * quicker on mouse button holds.
9448 * The calculation for the next flip interval value, starting from
9449 * the one set with this call, is the previous interval divided by
9450 * 1.05, so it decreases a little bit.
9452 * The default starting interval value for automatic flips is
9455 * @see elm_clock_interval_get()
9459 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9462 * Get the interval on time updates for an user mouse button hold
9463 * on clock widgets' time edition.
9465 * @param obj The clock object
9466 * @return The (first) interval value, in seconds, set on it
9468 * @see elm_clock_interval_set() for more details
9472 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9479 * @defgroup Layout Layout
9481 * @image html img/widget/layout/preview-00.png
9482 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9484 * @image html img/layout-predefined.png
9485 * @image latex img/layout-predefined.eps width=\textwidth
9487 * This is a container widget that takes a standard Edje design file and
9488 * wraps it very thinly in a widget.
9490 * An Edje design (theme) file has a very wide range of possibilities to
9491 * describe the behavior of elements added to the Layout. Check out the Edje
9492 * documentation and the EDC reference to get more information about what can
9493 * be done with Edje.
9495 * Just like @ref List, @ref Box, and other container widgets, any
9496 * object added to the Layout will become its child, meaning that it will be
9497 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9499 * The Layout widget can contain as many Contents, Boxes or Tables as
9500 * described in its theme file. For instance, objects can be added to
9501 * different Tables by specifying the respective Table part names. The same
9502 * is valid for Content and Box.
9504 * The objects added as child of the Layout will behave as described in the
9505 * part description where they were added. There are 3 possible types of
9506 * parts where a child can be added:
9508 * @section secContent Content (SWALLOW part)
9510 * Only one object can be added to the @c SWALLOW part (but you still can
9511 * have many @c SWALLOW parts and one object on each of them). Use the @c
9512 * elm_object_content_set/get/unset functions to set, retrieve and unset
9513 * objects as content of the @c SWALLOW. After being set to this part, the
9514 * object size, position, visibility, clipping and other description
9515 * properties will be totally controled by the description of the given part
9516 * (inside the Edje theme file).
9518 * One can use @c evas_object_size_hint_* functions on the child to have some
9519 * kind of control over its behavior, but the resulting behavior will still
9520 * depend heavily on the @c SWALLOW part description.
9522 * The Edje theme also can change the part description, based on signals or
9523 * scripts running inside the theme. This change can also be animated. All of
9524 * this will affect the child object set as content accordingly. The object
9525 * size will be changed if the part size is changed, it will animate move if
9526 * the part is moving, and so on.
9528 * The following picture demonstrates a Layout widget with a child object
9529 * added to its @c SWALLOW:
9531 * @image html layout_swallow.png
9532 * @image latex layout_swallow.eps width=\textwidth
9534 * @section secBox Box (BOX part)
9536 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9537 * allows one to add objects to the box and have them distributed along its
9538 * area, accordingly to the specified @a layout property (now by @a layout we
9539 * mean the chosen layouting design of the Box, not the Layout widget
9542 * A similar effect for having a box with its position, size and other things
9543 * controled by the Layout theme would be to create an Elementary @ref Box
9544 * widget and add it as a Content in the @c SWALLOW part.
9546 * The main difference of using the Layout Box is that its behavior, the box
9547 * properties like layouting format, padding, align, etc. will be all
9548 * controled by the theme. This means, for example, that a signal could be
9549 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9550 * handled the signal by changing the box padding, or align, or both. Using
9551 * the Elementary @ref Box widget is not necessarily harder or easier, it
9552 * just depends on the circunstances and requirements.
9554 * The Layout Box can be used through the @c elm_layout_box_* set of
9557 * The following picture demonstrates a Layout widget with many child objects
9558 * added to its @c BOX part:
9560 * @image html layout_box.png
9561 * @image latex layout_box.eps width=\textwidth
9563 * @section secTable Table (TABLE part)
9565 * Just like the @ref secBox, the Layout Table is very similar to the
9566 * Elementary @ref Table widget. It allows one to add objects to the Table
9567 * specifying the row and column where the object should be added, and any
9568 * column or row span if necessary.
9570 * Again, we could have this design by adding a @ref Table widget to the @c
9571 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9572 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9573 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9575 * The Layout Table can be used through the @c elm_layout_table_* set of
9578 * The following picture demonstrates a Layout widget with many child objects
9579 * added to its @c TABLE part:
9581 * @image html layout_table.png
9582 * @image latex layout_table.eps width=\textwidth
9584 * @section secPredef Predefined Layouts
9586 * Another interesting thing about the Layout widget is that it offers some
9587 * predefined themes that come with the default Elementary theme. These
9588 * themes can be set by the call elm_layout_theme_set(), and provide some
9589 * basic functionality depending on the theme used.
9591 * Most of them already send some signals, some already provide a toolbar or
9592 * back and next buttons.
9594 * These are available predefined theme layouts. All of them have class = @c
9595 * layout, group = @c application, and style = one of the following options:
9597 * @li @c toolbar-content - application with toolbar and main content area
9598 * @li @c toolbar-content-back - application with toolbar and main content
9599 * area with a back button and title area
9600 * @li @c toolbar-content-back-next - application with toolbar and main
9601 * content area with a back and next buttons and title area
9602 * @li @c content-back - application with a main content area with a back
9603 * button and title area
9604 * @li @c content-back-next - application with a main content area with a
9605 * back and next buttons and title area
9606 * @li @c toolbar-vbox - application with toolbar and main content area as a
9608 * @li @c toolbar-table - application with toolbar and main content area as a
9611 * @section secExamples Examples
9613 * Some examples of the Layout widget can be found here:
9614 * @li @ref layout_example_01
9615 * @li @ref layout_example_02
9616 * @li @ref layout_example_03
9617 * @li @ref layout_example_edc
9622 * Add a new layout to the parent
9624 * @param parent The parent object
9625 * @return The new object or NULL if it cannot be created
9627 * @see elm_layout_file_set()
9628 * @see elm_layout_theme_set()
9632 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9634 * Set the file that will be used as layout
9636 * @param obj The layout object
9637 * @param file The path to file (edj) that will be used as layout
9638 * @param group The group that the layout belongs in edje file
9640 * @return (1 = success, 0 = error)
9644 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9646 * Set the edje group from the elementary theme that will be used as layout
9648 * @param obj The layout object
9649 * @param clas the clas of the group
9650 * @param group the group
9651 * @param style the style to used
9653 * @return (1 = success, 0 = error)
9657 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9659 * Set the layout content.
9661 * @param obj The layout object
9662 * @param swallow The swallow part name in the edje file
9663 * @param content The child that will be added in this layout object
9665 * Once the content object is set, a previously set one will be deleted.
9666 * If you want to keep that old content object, use the
9667 * elm_object_content_part_unset() function.
9669 * @note In an Edje theme, the part used as a content container is called @c
9670 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9671 * expected to be a part name just like the second parameter of
9672 * elm_layout_box_append().
9674 * @see elm_layout_box_append()
9675 * @see elm_object_content_part_get()
9676 * @see elm_object_content_part_unset()
9681 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9683 * Get the child object in the given content part.
9685 * @param obj The layout object
9686 * @param swallow The SWALLOW part to get its content
9688 * @return The swallowed object or NULL if none or an error occurred
9690 * @see elm_object_content_part_set()
9694 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9696 * Unset the layout content.
9698 * @param obj The layout object
9699 * @param swallow The swallow part name in the edje file
9700 * @return The content that was being used
9702 * Unparent and return the content object which was set for this part.
9704 * @see elm_object_content_part_set()
9708 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9710 * Set the text of the given part
9712 * @param obj The layout object
9713 * @param part The TEXT part where to set the text
9714 * @param text The text to set
9717 * @deprecated use elm_object_text_* instead.
9719 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9721 * Get the text set in the given part
9723 * @param obj The layout object
9724 * @param part The TEXT part to retrieve the text off
9726 * @return The text set in @p part
9729 * @deprecated use elm_object_text_* instead.
9731 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9733 * Append child to layout box part.
9735 * @param obj the layout object
9736 * @param part the box part to which the object will be appended.
9737 * @param child the child object to append to box.
9739 * Once the object is appended, it will become child of the layout. Its
9740 * lifetime will be bound to the layout, whenever the layout dies the child
9741 * will be deleted automatically. One should use elm_layout_box_remove() to
9742 * make this layout forget about the object.
9744 * @see elm_layout_box_prepend()
9745 * @see elm_layout_box_insert_before()
9746 * @see elm_layout_box_insert_at()
9747 * @see elm_layout_box_remove()
9751 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9753 * Prepend child to layout box part.
9755 * @param obj the layout object
9756 * @param part the box part to prepend.
9757 * @param child the child object to prepend to box.
9759 * Once the object is prepended, it will become child of the layout. Its
9760 * lifetime will be bound to the layout, whenever the layout dies the child
9761 * will be deleted automatically. One should use elm_layout_box_remove() to
9762 * make this layout forget about the object.
9764 * @see elm_layout_box_append()
9765 * @see elm_layout_box_insert_before()
9766 * @see elm_layout_box_insert_at()
9767 * @see elm_layout_box_remove()
9771 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9773 * Insert child to layout box part before a reference object.
9775 * @param obj the layout object
9776 * @param part the box part to insert.
9777 * @param child the child object to insert into box.
9778 * @param reference another reference object to insert before in box.
9780 * Once the object is inserted, it will become child of the layout. Its
9781 * lifetime will be bound to the layout, whenever the layout dies the child
9782 * will be deleted automatically. One should use elm_layout_box_remove() to
9783 * make this layout forget about the object.
9785 * @see elm_layout_box_append()
9786 * @see elm_layout_box_prepend()
9787 * @see elm_layout_box_insert_before()
9788 * @see elm_layout_box_remove()
9792 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9794 * Insert child to layout box part at a given position.
9796 * @param obj the layout object
9797 * @param part the box part to insert.
9798 * @param child the child object to insert into box.
9799 * @param pos the numeric position >=0 to insert the child.
9801 * Once the object is inserted, it will become child of the layout. Its
9802 * lifetime will be bound to the layout, whenever the layout dies the child
9803 * will be deleted automatically. One should use elm_layout_box_remove() to
9804 * make this layout forget about the object.
9806 * @see elm_layout_box_append()
9807 * @see elm_layout_box_prepend()
9808 * @see elm_layout_box_insert_before()
9809 * @see elm_layout_box_remove()
9813 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9815 * Remove a child of the given part box.
9817 * @param obj The layout object
9818 * @param part The box part name to remove child.
9819 * @param child The object to remove from box.
9820 * @return The object that was being used, or NULL if not found.
9822 * The object will be removed from the box part and its lifetime will
9823 * not be handled by the layout anymore. This is equivalent to
9824 * elm_object_content_part_unset() for box.
9826 * @see elm_layout_box_append()
9827 * @see elm_layout_box_remove_all()
9831 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9833 * Remove all child of the given part box.
9835 * @param obj The layout object
9836 * @param part The box part name to remove child.
9837 * @param clear If EINA_TRUE, then all objects will be deleted as
9838 * well, otherwise they will just be removed and will be
9839 * dangling on the canvas.
9841 * The objects will be removed from the box part and their lifetime will
9842 * not be handled by the layout anymore. This is equivalent to
9843 * elm_layout_box_remove() for all box children.
9845 * @see elm_layout_box_append()
9846 * @see elm_layout_box_remove()
9850 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9852 * Insert child to layout table part.
9854 * @param obj the layout object
9855 * @param part the box part to pack child.
9856 * @param child_obj the child object to pack into table.
9857 * @param col the column to which the child should be added. (>= 0)
9858 * @param row the row to which the child should be added. (>= 0)
9859 * @param colspan how many columns should be used to store this object. (>=
9861 * @param rowspan how many rows should be used to store this object. (>= 1)
9863 * Once the object is inserted, it will become child of the table. Its
9864 * lifetime will be bound to the layout, and whenever the layout dies the
9865 * child will be deleted automatically. One should use
9866 * elm_layout_table_remove() to make this layout forget about the object.
9868 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9869 * more space than a single cell. For instance, the following code:
9871 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9874 * Would result in an object being added like the following picture:
9876 * @image html layout_colspan.png
9877 * @image latex layout_colspan.eps width=\textwidth
9879 * @see elm_layout_table_unpack()
9880 * @see elm_layout_table_clear()
9884 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);
9886 * Unpack (remove) a child of the given part table.
9888 * @param obj The layout object
9889 * @param part The table part name to remove child.
9890 * @param child_obj The object to remove from table.
9891 * @return The object that was being used, or NULL if not found.
9893 * The object will be unpacked from the table part and its lifetime
9894 * will not be handled by the layout anymore. This is equivalent to
9895 * elm_object_content_part_unset() for table.
9897 * @see elm_layout_table_pack()
9898 * @see elm_layout_table_clear()
9902 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9904 * Remove all child of the given part table.
9906 * @param obj The layout object
9907 * @param part The table part name to remove child.
9908 * @param clear If EINA_TRUE, then all objects will be deleted as
9909 * well, otherwise they will just be removed and will be
9910 * dangling on the canvas.
9912 * The objects will be removed from the table part and their lifetime will
9913 * not be handled by the layout anymore. This is equivalent to
9914 * elm_layout_table_unpack() for all table children.
9916 * @see elm_layout_table_pack()
9917 * @see elm_layout_table_unpack()
9921 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9923 * Get the edje layout
9925 * @param obj The layout object
9927 * @return A Evas_Object with the edje layout settings loaded
9928 * with function elm_layout_file_set
9930 * This returns the edje object. It is not expected to be used to then
9931 * swallow objects via edje_object_part_swallow() for example. Use
9932 * elm_object_content_part_set() instead so child object handling and sizing is
9935 * @note This function should only be used if you really need to call some
9936 * low level Edje function on this edje object. All the common stuff (setting
9937 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9938 * with proper elementary functions.
9940 * @see elm_object_signal_callback_add()
9941 * @see elm_object_signal_emit()
9942 * @see elm_object_text_part_set()
9943 * @see elm_object_content_part_set()
9944 * @see elm_layout_box_append()
9945 * @see elm_layout_table_pack()
9946 * @see elm_layout_data_get()
9950 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9952 * Get the edje data from the given layout
9954 * @param obj The layout object
9955 * @param key The data key
9957 * @return The edje data string
9959 * This function fetches data specified inside the edje theme of this layout.
9960 * This function return NULL if data is not found.
9962 * In EDC this comes from a data block within the group block that @p
9963 * obj was loaded from. E.g.
9970 * item: "key1" "value1";
9971 * item: "key2" "value2";
9979 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9983 * @param obj The layout object
9985 * Manually forces a sizing re-evaluation. This is useful when the minimum
9986 * size required by the edje theme of this layout has changed. The change on
9987 * the minimum size required by the edje theme is not immediately reported to
9988 * the elementary layout, so one needs to call this function in order to tell
9989 * the widget (layout) that it needs to reevaluate its own size.
9991 * The minimum size of the theme is calculated based on minimum size of
9992 * parts, the size of elements inside containers like box and table, etc. All
9993 * of this can change due to state changes, and that's when this function
9996 * Also note that a standard signal of "size,eval" "elm" emitted from the
9997 * edje object will cause this to happen too.
10001 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10004 * Sets a specific cursor for an edje part.
10006 * @param obj The layout object.
10007 * @param part_name a part from loaded edje group.
10008 * @param cursor cursor name to use, see Elementary_Cursor.h
10010 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10011 * part not exists or it has "mouse_events: 0".
10015 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10018 * Get the cursor to be shown when mouse is over an edje part
10020 * @param obj The layout object.
10021 * @param part_name a part from loaded edje group.
10022 * @return the cursor name.
10026 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10029 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10031 * @param obj The layout object.
10032 * @param part_name a part from loaded edje group, that had a cursor set
10033 * with elm_layout_part_cursor_set().
10037 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10040 * Sets a specific cursor style for an edje part.
10042 * @param obj The layout object.
10043 * @param part_name a part from loaded edje group.
10044 * @param style the theme style to use (default, transparent, ...)
10046 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10047 * part not exists or it did not had a cursor set.
10051 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10054 * Gets a specific cursor style for an edje part.
10056 * @param obj The layout object.
10057 * @param part_name a part from loaded edje group.
10059 * @return the theme style in use, defaults to "default". If the
10060 * object does not have a cursor set, then NULL is returned.
10064 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10067 * Sets if the cursor set should be searched on the theme or should use
10068 * the provided by the engine, only.
10070 * @note before you set if should look on theme you should define a
10071 * cursor with elm_layout_part_cursor_set(). By default it will only
10072 * look for cursors provided by the engine.
10074 * @param obj The layout object.
10075 * @param part_name a part from loaded edje group.
10076 * @param engine_only if cursors should be just provided by the engine
10077 * or should also search on widget's theme as well
10079 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10080 * part not exists or it did not had a cursor set.
10084 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);
10087 * Gets a specific cursor engine_only for an edje part.
10089 * @param obj The layout object.
10090 * @param part_name a part from loaded edje group.
10092 * @return whenever the cursor is just provided by engine or also from theme.
10096 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10099 * @def elm_layout_icon_set
10100 * Convienience macro to set the icon object in a layout that follows the
10101 * Elementary naming convention for its parts.
10105 #define elm_layout_icon_set(_ly, _obj) \
10108 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10109 if ((_obj)) sig = "elm,state,icon,visible"; \
10110 else sig = "elm,state,icon,hidden"; \
10111 elm_object_signal_emit((_ly), sig, "elm"); \
10115 * @def elm_layout_icon_get
10116 * Convienience macro to get the icon object from a layout that follows the
10117 * Elementary naming convention for its parts.
10121 #define elm_layout_icon_get(_ly) \
10122 elm_layout_content_get((_ly), "elm.swallow.icon")
10125 * @def elm_layout_end_set
10126 * Convienience macro to set the end object in a layout that follows the
10127 * Elementary naming convention for its parts.
10131 #define elm_layout_end_set(_ly, _obj) \
10134 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10135 if ((_obj)) sig = "elm,state,end,visible"; \
10136 else sig = "elm,state,end,hidden"; \
10137 elm_object_signal_emit((_ly), sig, "elm"); \
10141 * @def elm_layout_end_get
10142 * Convienience macro to get the end object in a layout that follows the
10143 * Elementary naming convention for its parts.
10147 #define elm_layout_end_get(_ly) \
10148 elm_layout_content_get((_ly), "elm.swallow.end")
10151 * @def elm_layout_label_set
10152 * Convienience macro to set the label in a layout that follows the
10153 * Elementary naming convention for its parts.
10156 * @deprecated use elm_object_text_* instead.
10158 #define elm_layout_label_set(_ly, _txt) \
10159 elm_layout_text_set((_ly), "elm.text", (_txt))
10162 * @def elm_layout_label_get
10163 * Convenience macro to get the label in a layout that follows the
10164 * Elementary naming convention for its parts.
10167 * @deprecated use elm_object_text_* instead.
10169 #define elm_layout_label_get(_ly) \
10170 elm_layout_text_get((_ly), "elm.text")
10172 /* smart callbacks called:
10173 * "theme,changed" - when elm theme is changed.
10177 * @defgroup Notify Notify
10179 * @image html img/widget/notify/preview-00.png
10180 * @image latex img/widget/notify/preview-00.eps
10182 * Display a container in a particular region of the parent(top, bottom,
10183 * etc). A timeout can be set to automatically hide the notify. This is so
10184 * that, after an evas_object_show() on a notify object, if a timeout was set
10185 * on it, it will @b automatically get hidden after that time.
10187 * Signals that you can add callbacks for are:
10188 * @li "timeout" - when timeout happens on notify and it's hidden
10189 * @li "block,clicked" - when a click outside of the notify happens
10191 * Default contents parts of the notify widget that you can use for are:
10192 * @li "elm.swallow.content" - A content of the notify
10194 * @ref tutorial_notify show usage of the API.
10199 * @brief Possible orient values for notify.
10201 * This values should be used in conjunction to elm_notify_orient_set() to
10202 * set the position in which the notify should appear(relative to its parent)
10203 * and in conjunction with elm_notify_orient_get() to know where the notify
10206 typedef enum _Elm_Notify_Orient
10208 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10209 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10210 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10211 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10212 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10213 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10214 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10215 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10216 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10217 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10218 } Elm_Notify_Orient;
10220 * @brief Add a new notify to the parent
10222 * @param parent The parent object
10223 * @return The new object or NULL if it cannot be created
10225 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10227 * @brief Set the content of the notify widget
10229 * @param obj The notify object
10230 * @param content The content will be filled in this notify object
10232 * Once the content object is set, a previously set one will be deleted. If
10233 * you want to keep that old content object, use the
10234 * elm_notify_content_unset() function.
10236 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10238 * @brief Unset the content of the notify widget
10240 * @param obj The notify object
10241 * @return The content that was being used
10243 * Unparent and return the content object which was set for this widget
10245 * @see elm_notify_content_set()
10247 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10249 * @brief Return the content of the notify widget
10251 * @param obj The notify object
10252 * @return The content that is being used
10254 * @see elm_notify_content_set()
10256 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10258 * @brief Set the notify parent
10260 * @param obj The notify object
10261 * @param content The new parent
10263 * Once the parent object is set, a previously set one will be disconnected
10266 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10268 * @brief Get the notify parent
10270 * @param obj The notify object
10271 * @return The parent
10273 * @see elm_notify_parent_set()
10275 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10277 * @brief Set the orientation
10279 * @param obj The notify object
10280 * @param orient The new orientation
10282 * Sets the position in which the notify will appear in its parent.
10284 * @see @ref Elm_Notify_Orient for possible values.
10286 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10288 * @brief Return the orientation
10289 * @param obj The notify object
10290 * @return The orientation of the notification
10292 * @see elm_notify_orient_set()
10293 * @see Elm_Notify_Orient
10295 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10297 * @brief Set the time interval after which the notify window is going to be
10300 * @param obj The notify object
10301 * @param time The timeout in seconds
10303 * This function sets a timeout and starts the timer controlling when the
10304 * notify is hidden. Since calling evas_object_show() on a notify restarts
10305 * the timer controlling when the notify is hidden, setting this before the
10306 * notify is shown will in effect mean starting the timer when the notify is
10309 * @note Set a value <= 0.0 to disable a running timer.
10311 * @note If the value > 0.0 and the notify is previously visible, the
10312 * timer will be started with this value, canceling any running timer.
10314 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10316 * @brief Return the timeout value (in seconds)
10317 * @param obj the notify object
10319 * @see elm_notify_timeout_set()
10321 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10323 * @brief Sets whether events should be passed to by a click outside
10326 * @param obj The notify object
10327 * @param repeats EINA_TRUE Events are repeats, else no
10329 * When true if the user clicks outside the window the events will be caught
10330 * by the others widgets, else the events are blocked.
10332 * @note The default value is EINA_TRUE.
10334 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10336 * @brief Return true if events are repeat below the notify object
10337 * @param obj the notify object
10339 * @see elm_notify_repeat_events_set()
10341 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10347 * @defgroup Hover Hover
10349 * @image html img/widget/hover/preview-00.png
10350 * @image latex img/widget/hover/preview-00.eps
10352 * A Hover object will hover over its @p parent object at the @p target
10353 * location. Anything in the background will be given a darker coloring to
10354 * indicate that the hover object is on top (at the default theme). When the
10355 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10356 * clicked that @b doesn't cause the hover to be dismissed.
10358 * A Hover object has two parents. One parent that owns it during creation
10359 * and the other parent being the one over which the hover object spans.
10362 * @note The hover object will take up the entire space of @p target
10365 * Elementary has the following styles for the hover widget:
10369 * @li hoversel_vertical
10371 * The following are the available position for content:
10383 * Signals that you can add callbacks for are:
10384 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10385 * @li "smart,changed" - a content object placed under the "smart"
10386 * policy was replaced to a new slot direction.
10388 * See @ref tutorial_hover for more information.
10392 typedef enum _Elm_Hover_Axis
10394 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10395 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10396 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10397 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10400 * @brief Adds a hover object to @p parent
10402 * @param parent The parent object
10403 * @return The hover object or NULL if one could not be created
10405 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10407 * @brief Sets the target object for the hover.
10409 * @param obj The hover object
10410 * @param target The object to center the hover onto. The hover
10412 * This function will cause the hover to be centered on the target object.
10414 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10416 * @brief Gets the target object for the hover.
10418 * @param obj The hover object
10419 * @param parent The object to locate the hover over.
10421 * @see elm_hover_target_set()
10423 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10425 * @brief Sets the parent object for the hover.
10427 * @param obj The hover object
10428 * @param parent The object to locate the hover over.
10430 * This function will cause the hover to take up the entire space that the
10431 * parent object fills.
10433 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10435 * @brief Gets the parent object for the hover.
10437 * @param obj The hover object
10438 * @return The parent object to locate the hover over.
10440 * @see elm_hover_parent_set()
10442 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10444 * @brief Sets the content of the hover object and the direction in which it
10447 * @param obj The hover object
10448 * @param swallow The direction that the object will be displayed
10449 * at. Accepted values are "left", "top-left", "top", "top-right",
10450 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10452 * @param content The content to place at @p swallow
10454 * Once the content object is set for a given direction, a previously
10455 * set one (on the same direction) will be deleted. If you want to
10456 * keep that old content object, use the elm_hover_content_unset()
10459 * All directions may have contents at the same time, except for
10460 * "smart". This is a special placement hint and its use case
10461 * independs of the calculations coming from
10462 * elm_hover_best_content_location_get(). Its use is for cases when
10463 * one desires only one hover content, but with a dinamic special
10464 * placement within the hover area. The content's geometry, whenever
10465 * it changes, will be used to decide on a best location not
10466 * extrapolating the hover's parent object view to show it in (still
10467 * being the hover's target determinant of its medium part -- move and
10468 * resize it to simulate finger sizes, for example). If one of the
10469 * directions other than "smart" are used, a previously content set
10470 * using it will be deleted, and vice-versa.
10472 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10474 * @brief Get the content of the hover object, in a given direction.
10476 * Return the content object which was set for this widget in the
10477 * @p swallow direction.
10479 * @param obj The hover object
10480 * @param swallow The direction that the object was display at.
10481 * @return The content that was being used
10483 * @see elm_hover_content_set()
10485 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10487 * @brief Unset the content of the hover object, in a given direction.
10489 * Unparent and return the content object set at @p swallow direction.
10491 * @param obj The hover object
10492 * @param swallow The direction that the object was display at.
10493 * @return The content that was being used.
10495 * @see elm_hover_content_set()
10497 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10499 * @brief Returns the best swallow location for content in the hover.
10501 * @param obj The hover object
10502 * @param pref_axis The preferred orientation axis for the hover object to use
10503 * @return The edje location to place content into the hover or @c
10506 * Best is defined here as the location at which there is the most available
10509 * @p pref_axis may be one of
10510 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10511 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10512 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10513 * - @c ELM_HOVER_AXIS_BOTH -- both
10515 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10516 * nescessarily be along the horizontal axis("left" or "right"). If
10517 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10518 * be along the vertical axis("top" or "bottom"). Chossing
10519 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10520 * returned position may be in either axis.
10522 * @see elm_hover_content_set()
10524 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10531 * @defgroup Entry Entry
10533 * @image html img/widget/entry/preview-00.png
10534 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10535 * @image html img/widget/entry/preview-01.png
10536 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10537 * @image html img/widget/entry/preview-02.png
10538 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10539 * @image html img/widget/entry/preview-03.png
10540 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10542 * An entry is a convenience widget which shows a box that the user can
10543 * enter text into. Entries by default don't scroll, so they grow to
10544 * accomodate the entire text, resizing the parent window as needed. This
10545 * can be changed with the elm_entry_scrollable_set() function.
10547 * They can also be single line or multi line (the default) and when set
10548 * to multi line mode they support text wrapping in any of the modes
10549 * indicated by #Elm_Wrap_Type.
10551 * Other features include password mode, filtering of inserted text with
10552 * elm_entry_text_filter_append() and related functions, inline "items" and
10553 * formatted markup text.
10555 * @section entry-markup Formatted text
10557 * The markup tags supported by the Entry are defined by the theme, but
10558 * even when writing new themes or extensions it's a good idea to stick to
10559 * a sane default, to maintain coherency and avoid application breakages.
10560 * Currently defined by the default theme are the following tags:
10561 * @li \<br\>: Inserts a line break.
10562 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10564 * @li \<tab\>: Inserts a tab.
10565 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10567 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10568 * @li \<link\>...\</link\>: Underlines the enclosed text.
10569 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10571 * @section entry-special Special markups
10573 * Besides those used to format text, entries support two special markup
10574 * tags used to insert clickable portions of text or items inlined within
10577 * @subsection entry-anchors Anchors
10579 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10580 * \</a\> tags and an event will be generated when this text is clicked,
10584 * This text is outside <a href=anc-01>but this one is an anchor</a>
10587 * The @c href attribute in the opening tag gives the name that will be
10588 * used to identify the anchor and it can be any valid utf8 string.
10590 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10591 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10592 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10593 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10596 * @subsection entry-items Items
10598 * Inlined in the text, any other @c Evas_Object can be inserted by using
10599 * \<item\> tags this way:
10602 * <item size=16x16 vsize=full href=emoticon/haha></item>
10605 * Just like with anchors, the @c href identifies each item, but these need,
10606 * in addition, to indicate their size, which is done using any one of
10607 * @c size, @c absize or @c relsize attributes. These attributes take their
10608 * value in the WxH format, where W is the width and H the height of the
10611 * @li absize: Absolute pixel size for the item. Whatever value is set will
10612 * be the item's size regardless of any scale value the object may have
10613 * been set to. The final line height will be adjusted to fit larger items.
10614 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10616 * @li relsize: Size is adjusted for the item to fit within the current
10619 * Besides their size, items are specificed a @c vsize value that affects
10620 * how their final size and position are calculated. The possible values
10622 * @li ascent: Item will be placed within the line's baseline and its
10623 * ascent. That is, the height between the line where all characters are
10624 * positioned and the highest point in the line. For @c size and @c absize
10625 * items, the descent value will be added to the total line height to make
10626 * them fit. @c relsize items will be adjusted to fit within this space.
10627 * @li full: Items will be placed between the descent and ascent, or the
10628 * lowest point in the line and its highest.
10630 * The next image shows different configurations of items and how they
10631 * are the previously mentioned options affect their sizes. In all cases,
10632 * the green line indicates the ascent, blue for the baseline and red for
10635 * @image html entry_item.png
10636 * @image latex entry_item.eps width=\textwidth
10638 * And another one to show how size differs from absize. In the first one,
10639 * the scale value is set to 1.0, while the second one is using one of 2.0.
10641 * @image html entry_item_scale.png
10642 * @image latex entry_item_scale.eps width=\textwidth
10644 * After the size for an item is calculated, the entry will request an
10645 * object to place in its space. For this, the functions set with
10646 * elm_entry_item_provider_append() and related functions will be called
10647 * in order until one of them returns a @c non-NULL value. If no providers
10648 * are available, or all of them return @c NULL, then the entry falls back
10649 * to one of the internal defaults, provided the name matches with one of
10652 * All of the following are currently supported:
10655 * - emoticon/angry-shout
10656 * - emoticon/crazy-laugh
10657 * - emoticon/evil-laugh
10659 * - emoticon/goggle-smile
10660 * - emoticon/grumpy
10661 * - emoticon/grumpy-smile
10662 * - emoticon/guilty
10663 * - emoticon/guilty-smile
10665 * - emoticon/half-smile
10666 * - emoticon/happy-panting
10668 * - emoticon/indifferent
10670 * - emoticon/knowing-grin
10672 * - emoticon/little-bit-sorry
10673 * - emoticon/love-lots
10675 * - emoticon/minimal-smile
10676 * - emoticon/not-happy
10677 * - emoticon/not-impressed
10679 * - emoticon/opensmile
10682 * - emoticon/squint-laugh
10683 * - emoticon/surprised
10684 * - emoticon/suspicious
10685 * - emoticon/tongue-dangling
10686 * - emoticon/tongue-poke
10688 * - emoticon/unhappy
10689 * - emoticon/very-sorry
10692 * - emoticon/worried
10695 * Alternatively, an item may reference an image by its path, using
10696 * the URI form @c file:///path/to/an/image.png and the entry will then
10697 * use that image for the item.
10699 * @section entry-files Loading and saving files
10701 * Entries have convinience functions to load text from a file and save
10702 * changes back to it after a short delay. The automatic saving is enabled
10703 * by default, but can be disabled with elm_entry_autosave_set() and files
10704 * can be loaded directly as plain text or have any markup in them
10705 * recognized. See elm_entry_file_set() for more details.
10707 * @section entry-signals Emitted signals
10709 * This widget emits the following signals:
10711 * @li "changed": The text within the entry was changed.
10712 * @li "changed,user": The text within the entry was changed because of user interaction.
10713 * @li "activated": The enter key was pressed on a single line entry.
10714 * @li "press": A mouse button has been pressed on the entry.
10715 * @li "longpressed": A mouse button has been pressed and held for a couple
10717 * @li "clicked": The entry has been clicked (mouse press and release).
10718 * @li "clicked,double": The entry has been double clicked.
10719 * @li "clicked,triple": The entry has been triple clicked.
10720 * @li "focused": The entry has received focus.
10721 * @li "unfocused": The entry has lost focus.
10722 * @li "selection,paste": A paste of the clipboard contents was requested.
10723 * @li "selection,copy": A copy of the selected text into the clipboard was
10725 * @li "selection,cut": A cut of the selected text into the clipboard was
10727 * @li "selection,start": A selection has begun and no previous selection
10729 * @li "selection,changed": The current selection has changed.
10730 * @li "selection,cleared": The current selection has been cleared.
10731 * @li "cursor,changed": The cursor has changed position.
10732 * @li "anchor,clicked": An anchor has been clicked. The event_info
10733 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10734 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10735 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10736 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10737 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10738 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10739 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10740 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10741 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10742 * @li "preedit,changed": The preedit string has changed.
10743 * @li "language,changed": Program language changed.
10745 * @section entry-examples
10747 * An overview of the Entry API can be seen in @ref entry_example_01
10752 * @typedef Elm_Entry_Anchor_Info
10754 * The info sent in the callback for the "anchor,clicked" signals emitted
10757 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10759 * @struct _Elm_Entry_Anchor_Info
10761 * The info sent in the callback for the "anchor,clicked" signals emitted
10764 struct _Elm_Entry_Anchor_Info
10766 const char *name; /**< The name of the anchor, as stated in its href */
10767 int button; /**< The mouse button used to click on it */
10768 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10769 y, /**< Anchor geometry, relative to canvas */
10770 w, /**< Anchor geometry, relative to canvas */
10771 h; /**< Anchor geometry, relative to canvas */
10774 * @typedef Elm_Entry_Filter_Cb
10775 * This callback type is used by entry filters to modify text.
10776 * @param data The data specified as the last param when adding the filter
10777 * @param entry The entry object
10778 * @param text A pointer to the location of the text being filtered. This data can be modified,
10779 * but any additional allocations must be managed by the user.
10780 * @see elm_entry_text_filter_append
10781 * @see elm_entry_text_filter_prepend
10783 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10786 * This adds an entry to @p parent object.
10788 * By default, entries are:
10792 * @li autosave is enabled
10794 * @param parent The parent object
10795 * @return The new object or NULL if it cannot be created
10797 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10799 * Sets the entry to single line mode.
10801 * In single line mode, entries don't ever wrap when the text reaches the
10802 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10803 * key will generate an @c "activate" event instead of adding a new line.
10805 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10806 * and pressing enter will break the text into a different line
10807 * without generating any events.
10809 * @param obj The entry object
10810 * @param single_line If true, the text in the entry
10811 * will be on a single line.
10813 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10815 * Gets whether the entry is set to be single line.
10817 * @param obj The entry object
10818 * @return single_line If true, the text in the entry is set to display
10819 * on a single line.
10821 * @see elm_entry_single_line_set()
10823 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10825 * Sets the entry to password mode.
10827 * In password mode, entries are implicitly single line and the display of
10828 * any text in them is replaced with asterisks (*).
10830 * @param obj The entry object
10831 * @param password If true, password mode is enabled.
10833 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10835 * Gets whether the entry is set to password mode.
10837 * @param obj The entry object
10838 * @return If true, the entry is set to display all characters
10839 * as asterisks (*).
10841 * @see elm_entry_password_set()
10843 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10845 * This sets the text displayed within the entry to @p entry.
10847 * @param obj The entry object
10848 * @param entry The text to be displayed
10850 * @deprecated Use elm_object_text_set() instead.
10851 * @note Using this function bypasses text filters
10853 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10855 * This returns the text currently shown in object @p entry.
10856 * See also elm_entry_entry_set().
10858 * @param obj The entry object
10859 * @return The currently displayed text or NULL on failure
10861 * @deprecated Use elm_object_text_get() instead.
10863 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10865 * Appends @p entry to the text of the entry.
10867 * Adds the text in @p entry to the end of any text already present in the
10870 * The appended text is subject to any filters set for the widget.
10872 * @param obj The entry object
10873 * @param entry The text to be displayed
10875 * @see elm_entry_text_filter_append()
10877 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10879 * Gets whether the entry is empty.
10881 * Empty means no text at all. If there are any markup tags, like an item
10882 * tag for which no provider finds anything, and no text is displayed, this
10883 * function still returns EINA_FALSE.
10885 * @param obj The entry object
10886 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10888 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10890 * Gets any selected text within the entry.
10892 * If there's any selected text in the entry, this function returns it as
10893 * a string in markup format. NULL is returned if no selection exists or
10894 * if an error occurred.
10896 * The returned value points to an internal string and should not be freed
10897 * or modified in any way. If the @p entry object is deleted or its
10898 * contents are changed, the returned pointer should be considered invalid.
10900 * @param obj The entry object
10901 * @return The selected text within the entry or NULL on failure
10903 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10905 * Inserts the given text into the entry at the current cursor position.
10907 * This inserts text at the cursor position as if it was typed
10908 * by the user (note that this also allows markup which a user
10909 * can't just "type" as it would be converted to escaped text, so this
10910 * call can be used to insert things like emoticon items or bold push/pop
10911 * tags, other font and color change tags etc.)
10913 * If any selection exists, it will be replaced by the inserted text.
10915 * The inserted text is subject to any filters set for the widget.
10917 * @param obj The entry object
10918 * @param entry The text to insert
10920 * @see elm_entry_text_filter_append()
10922 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10924 * Set the line wrap type to use on multi-line entries.
10926 * Sets the wrap type used by the entry to any of the specified in
10927 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10928 * line (without inserting a line break or paragraph separator) when it
10929 * reaches the far edge of the widget.
10931 * Note that this only makes sense for multi-line entries. A widget set
10932 * to be single line will never wrap.
10934 * @param obj The entry object
10935 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10937 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10938 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
10940 * Gets the wrap mode the entry was set to use.
10942 * @param obj The entry object
10943 * @return Wrap type
10945 * @see also elm_entry_line_wrap_set()
10947 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10949 * Sets if the entry is to be editable or not.
10951 * By default, entries are editable and when focused, any text input by the
10952 * user will be inserted at the current cursor position. But calling this
10953 * function with @p editable as EINA_FALSE will prevent the user from
10954 * inputting text into the entry.
10956 * The only way to change the text of a non-editable entry is to use
10957 * elm_object_text_set(), elm_entry_entry_insert() and other related
10960 * @param obj The entry object
10961 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10962 * if not, the entry is read-only and no user input is allowed.
10964 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10966 * Gets whether the entry is editable or not.
10968 * @param obj The entry object
10969 * @return If true, the entry is editable by the user.
10970 * If false, it is not editable by the user
10972 * @see elm_entry_editable_set()
10974 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10976 * This drops any existing text selection within the entry.
10978 * @param obj The entry object
10980 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10982 * This selects all text within the entry.
10984 * @param obj The entry object
10986 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10988 * This moves the cursor one place to the right within the entry.
10990 * @param obj The entry object
10991 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10993 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10995 * This moves the cursor one place to the left within the entry.
10997 * @param obj The entry object
10998 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11000 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11002 * This moves the cursor one line up within the entry.
11004 * @param obj The entry object
11005 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11007 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11009 * This moves the cursor one line down within the entry.
11011 * @param obj The entry object
11012 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11014 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * This moves the cursor to the beginning of the entry.
11018 * @param obj The entry object
11020 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * This moves the cursor to the end of the entry.
11024 * @param obj The entry object
11026 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11028 * This moves the cursor to the beginning of the current line.
11030 * @param obj The entry object
11032 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11034 * This moves the cursor to the end of the current line.
11036 * @param obj The entry object
11038 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11040 * This begins a selection within the entry as though
11041 * the user were holding down the mouse button to make a selection.
11043 * @param obj The entry object
11045 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11047 * This ends a selection within the entry as though
11048 * the user had just released the mouse button while making a selection.
11050 * @param obj The entry object
11052 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11054 * Gets whether a format node exists at the current cursor position.
11056 * A format node is anything that defines how the text is rendered. It can
11057 * be a visible format node, such as a line break or a paragraph separator,
11058 * or an invisible one, such as bold begin or end tag.
11059 * This function returns whether any format node exists at the current
11062 * @param obj The entry object
11063 * @return EINA_TRUE if the current cursor position contains a format node,
11064 * EINA_FALSE otherwise.
11066 * @see elm_entry_cursor_is_visible_format_get()
11068 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11070 * Gets if the current cursor position holds a visible format node.
11072 * @param obj The entry object
11073 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11074 * if it's an invisible one or no format exists.
11076 * @see elm_entry_cursor_is_format_get()
11078 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080 * Gets the character pointed by the cursor at its current position.
11082 * This function returns a string with the utf8 character stored at the
11083 * current cursor position.
11084 * Only the text is returned, any format that may exist will not be part
11085 * of the return value.
11087 * @param obj The entry object
11088 * @return The text pointed by the cursors.
11090 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11092 * This function returns the geometry of the cursor.
11094 * It's useful if you want to draw something on the cursor (or where it is),
11095 * or for example in the case of scrolled entry where you want to show the
11098 * @param obj The entry object
11099 * @param x returned geometry
11100 * @param y returned geometry
11101 * @param w returned geometry
11102 * @param h returned geometry
11103 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11105 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);
11107 * Sets the cursor position in the entry to the given value
11109 * The value in @p pos is the index of the character position within the
11110 * contents of the string as returned by elm_entry_cursor_pos_get().
11112 * @param obj The entry object
11113 * @param pos The position of the cursor
11115 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11117 * Retrieves the current position of the cursor in the entry
11119 * @param obj The entry object
11120 * @return The cursor position
11122 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11124 * This executes a "cut" action on the selected text in the entry.
11126 * @param obj The entry object
11128 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11130 * This executes a "copy" action on the selected text in the entry.
11132 * @param obj The entry object
11134 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11136 * This executes a "paste" action in the entry.
11138 * @param obj The entry object
11140 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11142 * This clears and frees the items in a entry's contextual (longpress)
11145 * @param obj The entry object
11147 * @see elm_entry_context_menu_item_add()
11149 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11151 * This adds an item to the entry's contextual menu.
11153 * A longpress on an entry will make the contextual menu show up, if this
11154 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11155 * By default, this menu provides a few options like enabling selection mode,
11156 * which is useful on embedded devices that need to be explicit about it,
11157 * and when a selection exists it also shows the copy and cut actions.
11159 * With this function, developers can add other options to this menu to
11160 * perform any action they deem necessary.
11162 * @param obj The entry object
11163 * @param label The item's text label
11164 * @param icon_file The item's icon file
11165 * @param icon_type The item's icon type
11166 * @param func The callback to execute when the item is clicked
11167 * @param data The data to associate with the item for related functions
11169 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);
11171 * This disables the entry's contextual (longpress) menu.
11173 * @param obj The entry object
11174 * @param disabled If true, the menu is disabled
11176 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11178 * This returns whether the entry's contextual (longpress) menu is
11181 * @param obj The entry object
11182 * @return If true, the menu is disabled
11184 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11186 * This appends a custom item provider to the list for that entry
11188 * This appends the given callback. The list is walked from beginning to end
11189 * with each function called given the item href string in the text. If the
11190 * function returns an object handle other than NULL (it should create an
11191 * object to do this), then this object is used to replace that item. If
11192 * not the next provider is called until one provides an item object, or the
11193 * default provider in entry does.
11195 * @param obj The entry object
11196 * @param func The function called to provide the item object
11197 * @param data The data passed to @p func
11199 * @see @ref entry-items
11201 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);
11203 * This prepends a custom item provider to the list for that entry
11205 * This prepends the given callback. See elm_entry_item_provider_append() for
11208 * @param obj The entry object
11209 * @param func The function called to provide the item object
11210 * @param data The data passed to @p func
11212 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);
11214 * This removes a custom item provider to the list for that entry
11216 * This removes the given callback. See elm_entry_item_provider_append() for
11219 * @param obj The entry object
11220 * @param func The function called to provide the item object
11221 * @param data The data passed to @p func
11223 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);
11225 * Append a filter function for text inserted in the entry
11227 * Append the given callback to the list. This functions will be called
11228 * whenever any text is inserted into the entry, with the text to be inserted
11229 * as a parameter. The callback function is free to alter the text in any way
11230 * it wants, but it must remember to free the given pointer and update it.
11231 * If the new text is to be discarded, the function can free it and set its
11232 * text parameter to NULL. This will also prevent any following filters from
11235 * @param obj The entry object
11236 * @param func The function to use as text filter
11237 * @param data User data to pass to @p func
11239 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11241 * Prepend a filter function for text insdrted in the entry
11243 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11244 * for more information
11246 * @param obj The entry object
11247 * @param func The function to use as text filter
11248 * @param data User data to pass to @p func
11250 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11252 * Remove a filter from the list
11254 * Removes the given callback from the filter list. See
11255 * elm_entry_text_filter_append() for more information.
11257 * @param obj The entry object
11258 * @param func The filter function to remove
11259 * @param data The user data passed when adding the function
11261 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11263 * This converts a markup (HTML-like) string into UTF-8.
11265 * The returned string is a malloc'ed buffer and it should be freed when
11266 * not needed anymore.
11268 * @param s The string (in markup) to be converted
11269 * @return The converted string (in UTF-8). It should be freed.
11271 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11273 * This converts a UTF-8 string into markup (HTML-like).
11275 * The returned string is a malloc'ed buffer and it should be freed when
11276 * not needed anymore.
11278 * @param s The string (in UTF-8) to be converted
11279 * @return The converted string (in markup). It should be freed.
11281 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11283 * This sets the file (and implicitly loads it) for the text to display and
11284 * then edit. All changes are written back to the file after a short delay if
11285 * the entry object is set to autosave (which is the default).
11287 * If the entry had any other file set previously, any changes made to it
11288 * will be saved if the autosave feature is enabled, otherwise, the file
11289 * will be silently discarded and any non-saved changes will be lost.
11291 * @param obj The entry object
11292 * @param file The path to the file to load and save
11293 * @param format The file format
11295 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11297 * Gets the file being edited by the entry.
11299 * This function can be used to retrieve any file set on the entry for
11300 * edition, along with the format used to load and save it.
11302 * @param obj The entry object
11303 * @param file The path to the file to load and save
11304 * @param format The file format
11306 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11308 * This function writes any changes made to the file set with
11309 * elm_entry_file_set()
11311 * @param obj The entry object
11313 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11315 * This sets the entry object to 'autosave' the loaded text file or not.
11317 * @param obj The entry object
11318 * @param autosave Autosave the loaded file or not
11320 * @see elm_entry_file_set()
11322 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11324 * This gets the entry object's 'autosave' status.
11326 * @param obj The entry object
11327 * @return Autosave the loaded file or not
11329 * @see elm_entry_file_set()
11331 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11333 * Control pasting of text and images for the widget.
11335 * Normally the entry allows both text and images to be pasted. By setting
11336 * textonly to be true, this prevents images from being pasted.
11338 * Note this only changes the behaviour of text.
11340 * @param obj The entry object
11341 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11342 * text+image+other.
11344 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11346 * Getting elm_entry text paste/drop mode.
11348 * In textonly mode, only text may be pasted or dropped into the widget.
11350 * @param obj The entry object
11351 * @return If the widget only accepts text from pastes.
11353 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11355 * Enable or disable scrolling in entry
11357 * Normally the entry is not scrollable unless you enable it with this call.
11359 * @param obj The entry object
11360 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11362 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11364 * Get the scrollable state of the entry
11366 * Normally the entry is not scrollable. This gets the scrollable state
11367 * of the entry. See elm_entry_scrollable_set() for more information.
11369 * @param obj The entry object
11370 * @return The scrollable state
11372 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11374 * This sets a widget to be displayed to the left of a scrolled entry.
11376 * @param obj The scrolled entry object
11377 * @param icon The widget to display on the left side of the scrolled
11380 * @note A previously set widget will be destroyed.
11381 * @note If the object being set does not have minimum size hints set,
11382 * it won't get properly displayed.
11384 * @see elm_entry_end_set()
11386 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11388 * Gets the leftmost widget of the scrolled entry. This object is
11389 * owned by the scrolled entry and should not be modified.
11391 * @param obj The scrolled entry object
11392 * @return the left widget inside the scroller
11394 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11396 * Unset the leftmost widget of the scrolled entry, unparenting and
11399 * @param obj The scrolled entry object
11400 * @return the previously set icon sub-object of this entry, on
11403 * @see elm_entry_icon_set()
11405 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11407 * Sets the visibility of the left-side widget of the scrolled entry,
11408 * set by elm_entry_icon_set().
11410 * @param obj The scrolled entry object
11411 * @param setting EINA_TRUE if the object should be displayed,
11412 * EINA_FALSE if not.
11414 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11416 * This sets a widget to be displayed to the end of a scrolled entry.
11418 * @param obj The scrolled entry object
11419 * @param end The widget to display on the right side of the scrolled
11422 * @note A previously set widget will be destroyed.
11423 * @note If the object being set does not have minimum size hints set,
11424 * it won't get properly displayed.
11426 * @see elm_entry_icon_set
11428 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11430 * Gets the endmost widget of the scrolled entry. This object is owned
11431 * by the scrolled entry and should not be modified.
11433 * @param obj The scrolled entry object
11434 * @return the right widget inside the scroller
11436 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11438 * Unset the endmost widget of the scrolled entry, unparenting and
11441 * @param obj The scrolled entry object
11442 * @return the previously set icon sub-object of this entry, on
11445 * @see elm_entry_icon_set()
11447 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11449 * Sets the visibility of the end widget of the scrolled entry, set by
11450 * elm_entry_end_set().
11452 * @param obj The scrolled entry object
11453 * @param setting EINA_TRUE if the object should be displayed,
11454 * EINA_FALSE if not.
11456 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11458 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11461 * Setting an entry to single-line mode with elm_entry_single_line_set()
11462 * will automatically disable the display of scrollbars when the entry
11463 * moves inside its scroller.
11465 * @param obj The scrolled entry object
11466 * @param h The horizontal scrollbar policy to apply
11467 * @param v The vertical scrollbar policy to apply
11469 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11471 * This enables/disables bouncing within the entry.
11473 * This function sets whether the entry will bounce when scrolling reaches
11474 * the end of the contained entry.
11476 * @param obj The scrolled entry object
11477 * @param h The horizontal bounce state
11478 * @param v The vertical bounce state
11480 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11482 * Get the bounce mode
11484 * @param obj The Entry object
11485 * @param h_bounce Allow bounce horizontally
11486 * @param v_bounce Allow bounce vertically
11488 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11490 /* pre-made filters for entries */
11492 * @typedef Elm_Entry_Filter_Limit_Size
11494 * Data for the elm_entry_filter_limit_size() entry filter.
11496 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11498 * @struct _Elm_Entry_Filter_Limit_Size
11500 * Data for the elm_entry_filter_limit_size() entry filter.
11502 struct _Elm_Entry_Filter_Limit_Size
11504 int max_char_count; /**< The maximum number of characters allowed. */
11505 int max_byte_count; /**< The maximum number of bytes allowed*/
11508 * Filter inserted text based on user defined character and byte limits
11510 * Add this filter to an entry to limit the characters that it will accept
11511 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11512 * The funtion works on the UTF-8 representation of the string, converting
11513 * it from the set markup, thus not accounting for any format in it.
11515 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11516 * it as data when setting the filter. In it, it's possible to set limits
11517 * by character count or bytes (any of them is disabled if 0), and both can
11518 * be set at the same time. In that case, it first checks for characters,
11521 * The function will cut the inserted text in order to allow only the first
11522 * number of characters that are still allowed. The cut is made in
11523 * characters, even when limiting by bytes, in order to always contain
11524 * valid ones and avoid half unicode characters making it in.
11526 * This filter, like any others, does not apply when setting the entry text
11527 * directly with elm_object_text_set() (or the deprecated
11528 * elm_entry_entry_set()).
11530 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11532 * @typedef Elm_Entry_Filter_Accept_Set
11534 * Data for the elm_entry_filter_accept_set() entry filter.
11536 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11538 * @struct _Elm_Entry_Filter_Accept_Set
11540 * Data for the elm_entry_filter_accept_set() entry filter.
11542 struct _Elm_Entry_Filter_Accept_Set
11544 const char *accepted; /**< Set of characters accepted in the entry. */
11545 const char *rejected; /**< Set of characters rejected from the entry. */
11548 * Filter inserted text based on accepted or rejected sets of characters
11550 * Add this filter to an entry to restrict the set of accepted characters
11551 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11552 * This structure contains both accepted and rejected sets, but they are
11553 * mutually exclusive.
11555 * The @c accepted set takes preference, so if it is set, the filter will
11556 * only work based on the accepted characters, ignoring anything in the
11557 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11559 * In both cases, the function filters by matching utf8 characters to the
11560 * raw markup text, so it can be used to remove formatting tags.
11562 * This filter, like any others, does not apply when setting the entry text
11563 * directly with elm_object_text_set() (or the deprecated
11564 * elm_entry_entry_set()).
11566 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11568 * Set the input panel layout of the entry
11570 * @param obj The entry object
11571 * @param layout layout type
11573 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11575 * Get the input panel layout of the entry
11577 * @param obj The entry object
11578 * @return layout type
11580 * @see elm_entry_input_panel_layout_set
11582 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11584 * Set the autocapitalization type on the immodule.
11586 * @param obj The entry object
11587 * @param autocapital_type The type of autocapitalization
11589 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11591 * Retrieve the autocapitalization type on the immodule.
11593 * @param obj The entry object
11594 * @return autocapitalization type
11596 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11598 * Sets the attribute to show the input panel automatically.
11600 * @param obj The entry object
11601 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11603 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11605 * Retrieve the attribute to show the input panel automatically.
11607 * @param obj The entry object
11608 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11610 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11612 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11613 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11614 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11615 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11616 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11617 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11618 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11620 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11621 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
11622 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11623 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11624 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11630 /* composite widgets - these basically put together basic widgets above
11631 * in convenient packages that do more than basic stuff */
11635 * @defgroup Anchorview Anchorview
11637 * @image html img/widget/anchorview/preview-00.png
11638 * @image latex img/widget/anchorview/preview-00.eps
11640 * Anchorview is for displaying text that contains markup with anchors
11641 * like <c>\<a href=1234\>something\</\></c> in it.
11643 * Besides being styled differently, the anchorview widget provides the
11644 * necessary functionality so that clicking on these anchors brings up a
11645 * popup with user defined content such as "call", "add to contacts" or
11646 * "open web page". This popup is provided using the @ref Hover widget.
11648 * This widget is very similar to @ref Anchorblock, so refer to that
11649 * widget for an example. The only difference Anchorview has is that the
11650 * widget is already provided with scrolling functionality, so if the
11651 * text set to it is too large to fit in the given space, it will scroll,
11652 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11653 * text can be displayed.
11655 * This widget emits the following signals:
11656 * @li "anchor,clicked": will be called when an anchor is clicked. The
11657 * @p event_info parameter on the callback will be a pointer of type
11658 * ::Elm_Entry_Anchorview_Info.
11660 * See @ref Anchorblock for an example on how to use both of them.
11669 * @typedef Elm_Entry_Anchorview_Info
11671 * The info sent in the callback for "anchor,clicked" signals emitted by
11672 * the Anchorview widget.
11674 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11676 * @struct _Elm_Entry_Anchorview_Info
11678 * The info sent in the callback for "anchor,clicked" signals emitted by
11679 * the Anchorview widget.
11681 struct _Elm_Entry_Anchorview_Info
11683 const char *name; /**< Name of the anchor, as indicated in its href
11685 int button; /**< The mouse button used to click on it */
11686 Evas_Object *hover; /**< The hover object to use for the popup */
11688 Evas_Coord x, y, w, h;
11689 } anchor, /**< Geometry selection of text used as anchor */
11690 hover_parent; /**< Geometry of the object used as parent by the
11692 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11693 for content on the left side of
11694 the hover. Before calling the
11695 callback, the widget will make the
11696 necessary calculations to check
11697 which sides are fit to be set with
11698 content, based on the position the
11699 hover is activated and its distance
11700 to the edges of its parent object
11702 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11703 the right side of the hover.
11704 See @ref hover_left */
11705 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11706 of the hover. See @ref hover_left */
11707 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11708 below the hover. See @ref
11712 * Add a new Anchorview object
11714 * @param parent The parent object
11715 * @return The new object or NULL if it cannot be created
11717 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11719 * Set the text to show in the anchorview
11721 * Sets the text of the anchorview to @p text. This text can include markup
11722 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11723 * text that will be specially styled and react to click events, ended with
11724 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11725 * "anchor,clicked" signal that you can attach a callback to with
11726 * evas_object_smart_callback_add(). The name of the anchor given in the
11727 * event info struct will be the one set in the href attribute, in this
11728 * case, anchorname.
11730 * Other markup can be used to style the text in different ways, but it's
11731 * up to the style defined in the theme which tags do what.
11732 * @deprecated use elm_object_text_set() instead.
11734 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11736 * Get the markup text set for the anchorview
11738 * Retrieves the text set on the anchorview, with markup tags included.
11740 * @param obj The anchorview object
11741 * @return The markup text set or @c NULL if nothing was set or an error
11743 * @deprecated use elm_object_text_set() instead.
11745 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11747 * Set the parent of the hover popup
11749 * Sets the parent object to use by the hover created by the anchorview
11750 * when an anchor is clicked. See @ref Hover for more details on this.
11751 * If no parent is set, the same anchorview object will be used.
11753 * @param obj The anchorview object
11754 * @param parent The object to use as parent for the hover
11756 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11758 * Get the parent of the hover popup
11760 * Get the object used as parent for the hover created by the anchorview
11761 * widget. See @ref Hover for more details on this.
11763 * @param obj The anchorview object
11764 * @return The object used as parent for the hover, NULL if none is set.
11766 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11768 * Set the style that the hover should use
11770 * When creating the popup hover, anchorview will request that it's
11771 * themed according to @p style.
11773 * @param obj The anchorview object
11774 * @param style The style to use for the underlying hover
11776 * @see elm_object_style_set()
11778 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11780 * Get the style that the hover should use
11782 * Get the style the hover created by anchorview will use.
11784 * @param obj The anchorview object
11785 * @return The style to use by the hover. NULL means the default is used.
11787 * @see elm_object_style_set()
11789 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11791 * Ends the hover popup in the anchorview
11793 * When an anchor is clicked, the anchorview widget will create a hover
11794 * object to use as a popup with user provided content. This function
11795 * terminates this popup, returning the anchorview to its normal state.
11797 * @param obj The anchorview object
11799 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11801 * Set bouncing behaviour when the scrolled content reaches an edge
11803 * Tell the internal scroller object whether it should bounce or not
11804 * when it reaches the respective edges for each axis.
11806 * @param obj The anchorview object
11807 * @param h_bounce Whether to bounce or not in the horizontal axis
11808 * @param v_bounce Whether to bounce or not in the vertical axis
11810 * @see elm_scroller_bounce_set()
11812 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11814 * Get the set bouncing behaviour of the internal scroller
11816 * Get whether the internal scroller should bounce when the edge of each
11817 * axis is reached scrolling.
11819 * @param obj The anchorview object
11820 * @param h_bounce Pointer where to store the bounce state of the horizontal
11822 * @param v_bounce Pointer where to store the bounce state of the vertical
11825 * @see elm_scroller_bounce_get()
11827 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11829 * Appends a custom item provider to the given anchorview
11831 * Appends the given function to the list of items providers. This list is
11832 * called, one function at a time, with the given @p data pointer, the
11833 * anchorview object and, in the @p item parameter, the item name as
11834 * referenced in its href string. Following functions in the list will be
11835 * called in order until one of them returns something different to NULL,
11836 * which should be an Evas_Object which will be used in place of the item
11839 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11840 * href=item/name\>\</item\>
11842 * @param obj The anchorview object
11843 * @param func The function to add to the list of providers
11844 * @param data User data that will be passed to the callback function
11846 * @see elm_entry_item_provider_append()
11848 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);
11850 * Prepend a custom item provider to the given anchorview
11852 * Like elm_anchorview_item_provider_append(), but it adds the function
11853 * @p func to the beginning of the list, instead of the end.
11855 * @param obj The anchorview object
11856 * @param func The function to add to the list of providers
11857 * @param data User data that will be passed to the callback function
11859 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);
11861 * Remove a custom item provider from the list of the given anchorview
11863 * Removes the function and data pairing that matches @p func and @p data.
11864 * That is, unless the same function and same user data are given, the
11865 * function will not be removed from the list. This allows us to add the
11866 * same callback several times, with different @p data pointers and be
11867 * able to remove them later without conflicts.
11869 * @param obj The anchorview object
11870 * @param func The function to remove from the list
11871 * @param data The data matching the function to remove from the list
11873 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);
11880 * @defgroup Anchorblock Anchorblock
11882 * @image html img/widget/anchorblock/preview-00.png
11883 * @image latex img/widget/anchorblock/preview-00.eps
11885 * Anchorblock is for displaying text that contains markup with anchors
11886 * like <c>\<a href=1234\>something\</\></c> in it.
11888 * Besides being styled differently, the anchorblock widget provides the
11889 * necessary functionality so that clicking on these anchors brings up a
11890 * popup with user defined content such as "call", "add to contacts" or
11891 * "open web page". This popup is provided using the @ref Hover widget.
11893 * This widget emits the following signals:
11894 * @li "anchor,clicked": will be called when an anchor is clicked. The
11895 * @p event_info parameter on the callback will be a pointer of type
11896 * ::Elm_Entry_Anchorblock_Info.
11902 * Since examples are usually better than plain words, we might as well
11903 * try @ref tutorial_anchorblock_example "one".
11906 * @addtogroup Anchorblock
11910 * @typedef Elm_Entry_Anchorblock_Info
11912 * The info sent in the callback for "anchor,clicked" signals emitted by
11913 * the Anchorblock widget.
11915 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11917 * @struct _Elm_Entry_Anchorblock_Info
11919 * The info sent in the callback for "anchor,clicked" signals emitted by
11920 * the Anchorblock widget.
11922 struct _Elm_Entry_Anchorblock_Info
11924 const char *name; /**< Name of the anchor, as indicated in its href
11926 int button; /**< The mouse button used to click on it */
11927 Evas_Object *hover; /**< The hover object to use for the popup */
11929 Evas_Coord x, y, w, h;
11930 } anchor, /**< Geometry selection of text used as anchor */
11931 hover_parent; /**< Geometry of the object used as parent by the
11933 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11934 for content on the left side of
11935 the hover. Before calling the
11936 callback, the widget will make the
11937 necessary calculations to check
11938 which sides are fit to be set with
11939 content, based on the position the
11940 hover is activated and its distance
11941 to the edges of its parent object
11943 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11944 the right side of the hover.
11945 See @ref hover_left */
11946 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11947 of the hover. See @ref hover_left */
11948 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11949 below the hover. See @ref
11953 * Add a new Anchorblock object
11955 * @param parent The parent object
11956 * @return The new object or NULL if it cannot be created
11958 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11960 * Set the text to show in the anchorblock
11962 * Sets the text of the anchorblock to @p text. This text can include markup
11963 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11964 * of text that will be specially styled and react to click events, ended
11965 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11966 * "anchor,clicked" signal that you can attach a callback to with
11967 * evas_object_smart_callback_add(). The name of the anchor given in the
11968 * event info struct will be the one set in the href attribute, in this
11969 * case, anchorname.
11971 * Other markup can be used to style the text in different ways, but it's
11972 * up to the style defined in the theme which tags do what.
11973 * @deprecated use elm_object_text_set() instead.
11975 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11977 * Get the markup text set for the anchorblock
11979 * Retrieves the text set on the anchorblock, with markup tags included.
11981 * @param obj The anchorblock object
11982 * @return The markup text set or @c NULL if nothing was set or an error
11984 * @deprecated use elm_object_text_set() instead.
11986 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11988 * Set the parent of the hover popup
11990 * Sets the parent object to use by the hover created by the anchorblock
11991 * when an anchor is clicked. See @ref Hover for more details on this.
11993 * @param obj The anchorblock object
11994 * @param parent The object to use as parent for the hover
11996 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11998 * Get the parent of the hover popup
12000 * Get the object used as parent for the hover created by the anchorblock
12001 * widget. See @ref Hover for more details on this.
12002 * If no parent is set, the same anchorblock object will be used.
12004 * @param obj The anchorblock object
12005 * @return The object used as parent for the hover, NULL if none is set.
12007 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12009 * Set the style that the hover should use
12011 * When creating the popup hover, anchorblock will request that it's
12012 * themed according to @p style.
12014 * @param obj The anchorblock object
12015 * @param style The style to use for the underlying hover
12017 * @see elm_object_style_set()
12019 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12021 * Get the style that the hover should use
12023 * Get the style, the hover created by anchorblock will use.
12025 * @param obj The anchorblock object
12026 * @return The style to use by the hover. NULL means the default is used.
12028 * @see elm_object_style_set()
12030 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12032 * Ends the hover popup in the anchorblock
12034 * When an anchor is clicked, the anchorblock widget will create a hover
12035 * object to use as a popup with user provided content. This function
12036 * terminates this popup, returning the anchorblock to its normal state.
12038 * @param obj The anchorblock object
12040 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12042 * Appends a custom item provider to the given anchorblock
12044 * Appends the given function to the list of items providers. This list is
12045 * called, one function at a time, with the given @p data pointer, the
12046 * anchorblock object and, in the @p item parameter, the item name as
12047 * referenced in its href string. Following functions in the list will be
12048 * called in order until one of them returns something different to NULL,
12049 * which should be an Evas_Object which will be used in place of the item
12052 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12053 * href=item/name\>\</item\>
12055 * @param obj The anchorblock object
12056 * @param func The function to add to the list of providers
12057 * @param data User data that will be passed to the callback function
12059 * @see elm_entry_item_provider_append()
12061 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);
12063 * Prepend a custom item provider to the given anchorblock
12065 * Like elm_anchorblock_item_provider_append(), but it adds the function
12066 * @p func to the beginning of the list, instead of the end.
12068 * @param obj The anchorblock object
12069 * @param func The function to add to the list of providers
12070 * @param data User data that will be passed to the callback function
12072 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);
12074 * Remove a custom item provider from the list of the given anchorblock
12076 * Removes the function and data pairing that matches @p func and @p data.
12077 * That is, unless the same function and same user data are given, the
12078 * function will not be removed from the list. This allows us to add the
12079 * same callback several times, with different @p data pointers and be
12080 * able to remove them later without conflicts.
12082 * @param obj The anchorblock object
12083 * @param func The function to remove from the list
12084 * @param data The data matching the function to remove from the list
12086 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);
12092 * @defgroup Bubble Bubble
12094 * @image html img/widget/bubble/preview-00.png
12095 * @image latex img/widget/bubble/preview-00.eps
12096 * @image html img/widget/bubble/preview-01.png
12097 * @image latex img/widget/bubble/preview-01.eps
12098 * @image html img/widget/bubble/preview-02.png
12099 * @image latex img/widget/bubble/preview-02.eps
12101 * @brief The Bubble is a widget to show text similar to how speech is
12102 * represented in comics.
12104 * The bubble widget contains 5 important visual elements:
12105 * @li The frame is a rectangle with rounded edjes and an "arrow".
12106 * @li The @p icon is an image to which the frame's arrow points to.
12107 * @li The @p label is a text which appears to the right of the icon if the
12108 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12110 * @li The @p info is a text which appears to the right of the label. Info's
12111 * font is of a ligther color than label.
12112 * @li The @p content is an evas object that is shown inside the frame.
12114 * The position of the arrow, icon, label and info depends on which corner is
12115 * selected. The four available corners are:
12116 * @li "top_left" - Default
12118 * @li "bottom_left"
12119 * @li "bottom_right"
12121 * Signals that you can add callbacks for are:
12122 * @li "clicked" - This is called when a user has clicked the bubble.
12124 * For an example of using a buble see @ref bubble_01_example_page "this".
12129 * Add a new bubble to the parent
12131 * @param parent The parent object
12132 * @return The new object or NULL if it cannot be created
12134 * This function adds a text bubble to the given parent evas object.
12136 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12138 * Set the label of the bubble
12140 * @param obj The bubble object
12141 * @param label The string to set in the label
12143 * This function sets the title of the bubble. Where this appears depends on
12144 * the selected corner.
12145 * @deprecated use elm_object_text_set() instead.
12147 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12149 * Get the label of the bubble
12151 * @param obj The bubble object
12152 * @return The string of set in the label
12154 * This function gets the title of the bubble.
12155 * @deprecated use elm_object_text_get() instead.
12157 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 * Set the info of the bubble
12161 * @param obj The bubble object
12162 * @param info The given info about the bubble
12164 * This function sets the info of the bubble. Where this appears depends on
12165 * the selected corner.
12166 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12168 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12170 * Get the info of the bubble
12172 * @param obj The bubble object
12174 * @return The "info" string of the bubble
12176 * This function gets the info text.
12177 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12179 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12181 * Set the content to be shown in the bubble
12183 * Once the content object is set, a previously set one will be deleted.
12184 * If you want to keep the old content object, use the
12185 * elm_bubble_content_unset() function.
12187 * @param obj The bubble object
12188 * @param content The given content of the bubble
12190 * This function sets the content shown on the middle of the bubble.
12192 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12194 * Get the content shown in the bubble
12196 * Return the content object which is set for this widget.
12198 * @param obj The bubble object
12199 * @return The content that is being used
12201 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12203 * Unset the content shown in the bubble
12205 * Unparent and return the content object which was set for this widget.
12207 * @param obj The bubble object
12208 * @return The content that was being used
12210 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12212 * Set the icon of the bubble
12214 * Once the icon object is set, a previously set one will be deleted.
12215 * If you want to keep the old content object, use the
12216 * elm_icon_content_unset() function.
12218 * @param obj The bubble object
12219 * @param icon The given icon for the bubble
12221 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12223 * Get the icon of the bubble
12225 * @param obj The bubble object
12226 * @return The icon for the bubble
12228 * This function gets the icon shown on the top left of bubble.
12230 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12232 * Unset the icon of the bubble
12234 * Unparent and return the icon object which was set for this widget.
12236 * @param obj The bubble object
12237 * @return The icon that was being used
12239 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12241 * Set the corner of the bubble
12243 * @param obj The bubble object.
12244 * @param corner The given corner for the bubble.
12246 * This function sets the corner of the bubble. The corner will be used to
12247 * determine where the arrow in the frame points to and where label, icon and
12250 * Possible values for corner are:
12251 * @li "top_left" - Default
12253 * @li "bottom_left"
12254 * @li "bottom_right"
12256 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12258 * Get the corner of the bubble
12260 * @param obj The bubble object.
12261 * @return The given corner for the bubble.
12263 * This function gets the selected corner of the bubble.
12265 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12267 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12268 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12275 * @defgroup Photo Photo
12277 * For displaying the photo of a person (contact). Simple, yet
12278 * with a very specific purpose.
12280 * Signals that you can add callbacks for are:
12282 * "clicked" - This is called when a user has clicked the photo
12283 * "drag,start" - Someone started dragging the image out of the object
12284 * "drag,end" - Dragged item was dropped (somewhere)
12290 * Add a new photo to the parent
12292 * @param parent The parent object
12293 * @return The new object or NULL if it cannot be created
12297 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12300 * Set the file that will be used as photo
12302 * @param obj The photo object
12303 * @param file The path to file that will be used as photo
12305 * @return (1 = success, 0 = error)
12309 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12312 * Set the size that will be used on the photo
12314 * @param obj The photo object
12315 * @param size The size that the photo will be
12319 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12322 * Set if the photo should be completely visible or not.
12324 * @param obj The photo object
12325 * @param fill if true the photo will be completely visible
12329 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12332 * Set editability of the photo.
12334 * An editable photo can be dragged to or from, and can be cut or
12335 * pasted too. Note that pasting an image or dropping an item on
12336 * the image will delete the existing content.
12338 * @param obj The photo object.
12339 * @param set To set of clear editablity.
12341 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12347 /* gesture layer */
12349 * @defgroup Elm_Gesture_Layer Gesture Layer
12350 * Gesture Layer Usage:
12352 * Use Gesture Layer to detect gestures.
12353 * The advantage is that you don't have to implement
12354 * gesture detection, just set callbacks of gesture state.
12355 * By using gesture layer we make standard interface.
12357 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12358 * with a parent object parameter.
12359 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12360 * call. Usually with same object as target (2nd parameter).
12362 * Now you need to tell gesture layer what gestures you follow.
12363 * This is done with @ref elm_gesture_layer_cb_set call.
12364 * By setting the callback you actually saying to gesture layer:
12365 * I would like to know when the gesture @ref Elm_Gesture_Types
12366 * switches to state @ref Elm_Gesture_State.
12368 * Next, you need to implement the actual action that follows the input
12369 * in your callback.
12371 * Note that if you like to stop being reported about a gesture, just set
12372 * all callbacks referring this gesture to NULL.
12373 * (again with @ref elm_gesture_layer_cb_set)
12375 * The information reported by gesture layer to your callback is depending
12376 * on @ref Elm_Gesture_Types:
12377 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12378 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12379 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12381 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12382 * @ref ELM_GESTURE_MOMENTUM.
12384 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12385 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12386 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12387 * Note that we consider a flick as a line-gesture that should be completed
12388 * in flick-time-limit as defined in @ref Config.
12390 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12392 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12395 * Gesture Layer Tweaks:
12397 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12398 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12400 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12401 * so gesture starts when user touches (a *DOWN event) touch-surface
12402 * and ends when no fingers touches surface (a *UP event).
12406 * @enum _Elm_Gesture_Types
12407 * Enum of supported gesture types.
12408 * @ingroup Elm_Gesture_Layer
12410 enum _Elm_Gesture_Types
12412 ELM_GESTURE_FIRST = 0,
12414 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12415 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12416 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12417 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12419 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12421 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12422 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12424 ELM_GESTURE_ZOOM, /**< Zoom */
12425 ELM_GESTURE_ROTATE, /**< Rotate */
12431 * @typedef Elm_Gesture_Types
12432 * gesture types enum
12433 * @ingroup Elm_Gesture_Layer
12435 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12438 * @enum _Elm_Gesture_State
12439 * Enum of gesture states.
12440 * @ingroup Elm_Gesture_Layer
12442 enum _Elm_Gesture_State
12444 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12445 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12446 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12447 ELM_GESTURE_STATE_END, /**< Gesture completed */
12448 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12452 * @typedef Elm_Gesture_State
12453 * gesture states enum
12454 * @ingroup Elm_Gesture_Layer
12456 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12459 * @struct _Elm_Gesture_Taps_Info
12460 * Struct holds taps info for user
12461 * @ingroup Elm_Gesture_Layer
12463 struct _Elm_Gesture_Taps_Info
12465 Evas_Coord x, y; /**< Holds center point between fingers */
12466 unsigned int n; /**< Number of fingers tapped */
12467 unsigned int timestamp; /**< event timestamp */
12471 * @typedef Elm_Gesture_Taps_Info
12472 * holds taps info for user
12473 * @ingroup Elm_Gesture_Layer
12475 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12478 * @struct _Elm_Gesture_Momentum_Info
12479 * Struct holds momentum info for user
12480 * x1 and y1 are not necessarily in sync
12481 * x1 holds x value of x direction starting point
12482 * and same holds for y1.
12483 * This is noticeable when doing V-shape movement
12484 * @ingroup Elm_Gesture_Layer
12486 struct _Elm_Gesture_Momentum_Info
12487 { /* Report line ends, timestamps, and momentum computed */
12488 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12489 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12490 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12491 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12493 unsigned int tx; /**< Timestamp of start of final x-swipe */
12494 unsigned int ty; /**< Timestamp of start of final y-swipe */
12496 Evas_Coord mx; /**< Momentum on X */
12497 Evas_Coord my; /**< Momentum on Y */
12499 unsigned int n; /**< Number of fingers */
12503 * @typedef Elm_Gesture_Momentum_Info
12504 * holds momentum info for user
12505 * @ingroup Elm_Gesture_Layer
12507 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12510 * @struct _Elm_Gesture_Line_Info
12511 * Struct holds line info for user
12512 * @ingroup Elm_Gesture_Layer
12514 struct _Elm_Gesture_Line_Info
12515 { /* Report line ends, timestamps, and momentum computed */
12516 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12517 /* FIXME should be radians, bot degrees */
12518 double angle; /**< Angle (direction) of lines */
12522 * @typedef Elm_Gesture_Line_Info
12523 * Holds line info for user
12524 * @ingroup Elm_Gesture_Layer
12526 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12529 * @struct _Elm_Gesture_Zoom_Info
12530 * Struct holds zoom info for user
12531 * @ingroup Elm_Gesture_Layer
12533 struct _Elm_Gesture_Zoom_Info
12535 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12536 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12537 double zoom; /**< Zoom value: 1.0 means no zoom */
12538 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12542 * @typedef Elm_Gesture_Zoom_Info
12543 * Holds zoom info for user
12544 * @ingroup Elm_Gesture_Layer
12546 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12549 * @struct _Elm_Gesture_Rotate_Info
12550 * Struct holds rotation info for user
12551 * @ingroup Elm_Gesture_Layer
12553 struct _Elm_Gesture_Rotate_Info
12555 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12556 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12557 double base_angle; /**< Holds start-angle */
12558 double angle; /**< Rotation value: 0.0 means no rotation */
12559 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12563 * @typedef Elm_Gesture_Rotate_Info
12564 * Holds rotation info for user
12565 * @ingroup Elm_Gesture_Layer
12567 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12570 * @typedef Elm_Gesture_Event_Cb
12571 * User callback used to stream gesture info from gesture layer
12572 * @param data user data
12573 * @param event_info gesture report info
12574 * Returns a flag field to be applied on the causing event.
12575 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12576 * upon the event, in an irreversible way.
12578 * @ingroup Elm_Gesture_Layer
12580 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12583 * Use function to set callbacks to be notified about
12584 * change of state of gesture.
12585 * When a user registers a callback with this function
12586 * this means this gesture has to be tested.
12588 * When ALL callbacks for a gesture are set to NULL
12589 * it means user isn't interested in gesture-state
12590 * and it will not be tested.
12592 * @param obj Pointer to gesture-layer.
12593 * @param idx The gesture you would like to track its state.
12594 * @param cb callback function pointer.
12595 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12596 * @param data user info to be sent to callback (usually, Smart Data)
12598 * @ingroup Elm_Gesture_Layer
12600 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);
12603 * Call this function to get repeat-events settings.
12605 * @param obj Pointer to gesture-layer.
12607 * @return repeat events settings.
12608 * @see elm_gesture_layer_hold_events_set()
12609 * @ingroup Elm_Gesture_Layer
12611 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12614 * This function called in order to make gesture-layer repeat events.
12615 * Set this of you like to get the raw events only if gestures were not detected.
12616 * Clear this if you like gesture layer to fwd events as testing gestures.
12618 * @param obj Pointer to gesture-layer.
12619 * @param r Repeat: TRUE/FALSE
12621 * @ingroup Elm_Gesture_Layer
12623 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12626 * This function sets step-value for zoom action.
12627 * Set step to any positive value.
12628 * Cancel step setting by setting to 0.0
12630 * @param obj Pointer to gesture-layer.
12631 * @param s new zoom step value.
12633 * @ingroup Elm_Gesture_Layer
12635 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12638 * This function sets step-value for rotate action.
12639 * Set step to any positive value.
12640 * Cancel step setting by setting to 0.0
12642 * @param obj Pointer to gesture-layer.
12643 * @param s new roatate step value.
12645 * @ingroup Elm_Gesture_Layer
12647 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12650 * This function called to attach gesture-layer to an Evas_Object.
12651 * @param obj Pointer to gesture-layer.
12652 * @param t Pointer to underlying object (AKA Target)
12654 * @return TRUE, FALSE on success, failure.
12656 * @ingroup Elm_Gesture_Layer
12658 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12661 * Call this function to construct a new gesture-layer object.
12662 * This does not activate the gesture layer. You have to
12663 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12665 * @param parent the parent object.
12667 * @return Pointer to new gesture-layer object.
12669 * @ingroup Elm_Gesture_Layer
12671 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12674 * @defgroup Thumb Thumb
12676 * @image html img/widget/thumb/preview-00.png
12677 * @image latex img/widget/thumb/preview-00.eps
12679 * A thumb object is used for displaying the thumbnail of an image or video.
12680 * You must have compiled Elementary with Ethumb_Client support and the DBus
12681 * service must be present and auto-activated in order to have thumbnails to
12684 * Once the thumbnail object becomes visible, it will check if there is a
12685 * previously generated thumbnail image for the file set on it. If not, it
12686 * will start generating this thumbnail.
12688 * Different config settings will cause different thumbnails to be generated
12689 * even on the same file.
12691 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12692 * Ethumb documentation to change this path, and to see other configuration
12695 * Signals that you can add callbacks for are:
12697 * - "clicked" - This is called when a user has clicked the thumb without dragging
12699 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12700 * - "press" - This is called when a user has pressed down the thumb.
12701 * - "generate,start" - The thumbnail generation started.
12702 * - "generate,stop" - The generation process stopped.
12703 * - "generate,error" - The generation failed.
12704 * - "load,error" - The thumbnail image loading failed.
12706 * available styles:
12710 * An example of use of thumbnail:
12712 * - @ref thumb_example_01
12716 * @addtogroup Thumb
12721 * @enum _Elm_Thumb_Animation_Setting
12722 * @typedef Elm_Thumb_Animation_Setting
12724 * Used to set if a video thumbnail is animating or not.
12728 typedef enum _Elm_Thumb_Animation_Setting
12730 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12731 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12732 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12733 ELM_THUMB_ANIMATION_LAST
12734 } Elm_Thumb_Animation_Setting;
12737 * Add a new thumb object to the parent.
12739 * @param parent The parent object.
12740 * @return The new object or NULL if it cannot be created.
12742 * @see elm_thumb_file_set()
12743 * @see elm_thumb_ethumb_client_get()
12747 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12749 * Reload thumbnail if it was generated before.
12751 * @param obj The thumb object to reload
12753 * This is useful if the ethumb client configuration changed, like its
12754 * size, aspect or any other property one set in the handle returned
12755 * by elm_thumb_ethumb_client_get().
12757 * If the options didn't change, the thumbnail won't be generated again, but
12758 * the old one will still be used.
12760 * @see elm_thumb_file_set()
12764 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12766 * Set the file that will be used as thumbnail.
12768 * @param obj The thumb object.
12769 * @param file The path to file that will be used as thumb.
12770 * @param key The key used in case of an EET file.
12772 * The file can be an image or a video (in that case, acceptable extensions are:
12773 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12774 * function elm_thumb_animate().
12776 * @see elm_thumb_file_get()
12777 * @see elm_thumb_reload()
12778 * @see elm_thumb_animate()
12782 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12784 * Get the image or video path and key used to generate the thumbnail.
12786 * @param obj The thumb object.
12787 * @param file Pointer to filename.
12788 * @param key Pointer to key.
12790 * @see elm_thumb_file_set()
12791 * @see elm_thumb_path_get()
12795 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12797 * Get the path and key to the image or video generated by ethumb.
12799 * One just need to make sure that the thumbnail was generated before getting
12800 * its path; otherwise, the path will be NULL. One way to do that is by asking
12801 * for the path when/after the "generate,stop" smart callback is called.
12803 * @param obj The thumb object.
12804 * @param file Pointer to thumb path.
12805 * @param key Pointer to thumb key.
12807 * @see elm_thumb_file_get()
12811 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12813 * Set the animation state for the thumb object. If its content is an animated
12814 * video, you may start/stop the animation or tell it to play continuously and
12817 * @param obj The thumb object.
12818 * @param setting The animation setting.
12820 * @see elm_thumb_file_set()
12824 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12826 * Get the animation state for the thumb object.
12828 * @param obj The thumb object.
12829 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12832 * @see elm_thumb_animate_set()
12836 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12838 * Get the ethumb_client handle so custom configuration can be made.
12840 * @return Ethumb_Client instance or NULL.
12842 * This must be called before the objects are created to be sure no object is
12843 * visible and no generation started.
12845 * Example of usage:
12848 * #include <Elementary.h>
12849 * #ifndef ELM_LIB_QUICKLAUNCH
12851 * elm_main(int argc, char **argv)
12853 * Ethumb_Client *client;
12855 * elm_need_ethumb();
12859 * client = elm_thumb_ethumb_client_get();
12862 * ERR("could not get ethumb_client");
12865 * ethumb_client_size_set(client, 100, 100);
12866 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12869 * // Create elm_thumb objects here
12879 * @note There's only one client handle for Ethumb, so once a configuration
12880 * change is done to it, any other request for thumbnails (for any thumbnail
12881 * object) will use that configuration. Thus, this configuration is global.
12885 EAPI void *elm_thumb_ethumb_client_get(void);
12887 * Get the ethumb_client connection state.
12889 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12892 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12894 * Make the thumbnail 'editable'.
12896 * @param obj Thumb object.
12897 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12899 * This means the thumbnail is a valid drag target for drag and drop, and can be
12900 * cut or pasted too.
12902 * @see elm_thumb_editable_get()
12906 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12907 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12909 * Make the thumbnail 'editable'.
12911 * @param obj Thumb object.
12912 * @return Editability.
12914 * This means the thumbnail is a valid drag target for drag and drop, and can be
12915 * cut or pasted too.
12917 * @see elm_thumb_editable_set()
12921 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12929 * @defgroup Web Web
12931 * @image html img/widget/web/preview-00.png
12932 * @image latex img/widget/web/preview-00.eps
12934 * A web object is used for displaying web pages (HTML/CSS/JS)
12935 * using WebKit-EFL. You must have compiled Elementary with
12938 * Signals that you can add callbacks for are:
12939 * @li "download,request": A file download has been requested. Event info is
12940 * a pointer to a Elm_Web_Download
12941 * @li "editorclient,contents,changed": Editor client's contents changed
12942 * @li "editorclient,selection,changed": Editor client's selection changed
12943 * @li "frame,created": A new frame was created. Event info is an
12944 * Evas_Object which can be handled with WebKit's ewk_frame API
12945 * @li "icon,received": An icon was received by the main frame
12946 * @li "inputmethod,changed": Input method changed. Event info is an
12947 * Eina_Bool indicating whether it's enabled or not
12948 * @li "js,windowobject,clear": JS window object has been cleared
12949 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12950 * is a char *link[2], where the first string contains the URL the link
12951 * points to, and the second one the title of the link
12952 * @li "link,hover,out": Mouse cursor left the link
12953 * @li "load,document,finished": Loading of a document finished. Event info
12954 * is the frame that finished loading
12955 * @li "load,error": Load failed. Event info is a pointer to
12956 * Elm_Web_Frame_Load_Error
12957 * @li "load,finished": Load finished. Event info is NULL on success, on
12958 * error it's a pointer to Elm_Web_Frame_Load_Error
12959 * @li "load,newwindow,show": A new window was created and is ready to be
12961 * @li "load,progress": Overall load progress. Event info is a pointer to
12962 * a double containing a value between 0.0 and 1.0
12963 * @li "load,provisional": Started provisional load
12964 * @li "load,started": Loading of a document started
12965 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12966 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12967 * the menubar is visible, or EINA_FALSE in case it's not
12968 * @li "menubar,visible,set": Informs menubar visibility. Event info is
12969 * an Eina_Bool indicating the visibility
12970 * @li "popup,created": A dropdown widget was activated, requesting its
12971 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12972 * @li "popup,willdelete": The web object is ready to destroy the popup
12973 * object created. Event info is a pointer to Elm_Web_Menu
12974 * @li "ready": Page is fully loaded
12975 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12976 * info is a pointer to Eina_Bool where the visibility state should be set
12977 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12978 * is an Eina_Bool with the visibility state set
12979 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12980 * a string with the new text
12981 * @li "statusbar,visible,get": Queries visibility of the status bar.
12982 * Event info is a pointer to Eina_Bool where the visibility state should be
12984 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12985 * an Eina_Bool with the visibility value
12986 * @li "title,changed": Title of the main frame changed. Event info is a
12987 * string with the new title
12988 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12989 * is a pointer to Eina_Bool where the visibility state should be set
12990 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12991 * info is an Eina_Bool with the visibility state
12992 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12993 * a string with the text to show
12994 * @li "uri,changed": URI of the main frame changed. Event info is a string
12996 * @li "view,resized": The web object internal's view changed sized
12997 * @li "windows,close,request": A JavaScript request to close the current
12998 * window was requested
12999 * @li "zoom,animated,end": Animated zoom finished
13001 * available styles:
13004 * An example of use of web:
13006 * - @ref web_example_01 TBD
13015 * Structure used to report load errors.
13017 * Load errors are reported as signal by elm_web. All the strings are
13018 * temporary references and should @b not be used after the signal
13019 * callback returns. If it's required, make copies with strdup() or
13020 * eina_stringshare_add() (they are not even guaranteed to be
13021 * stringshared, so must use eina_stringshare_add() and not
13022 * eina_stringshare_ref()).
13024 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13026 * Structure used to report load errors.
13028 * Load errors are reported as signal by elm_web. All the strings are
13029 * temporary references and should @b not be used after the signal
13030 * callback returns. If it's required, make copies with strdup() or
13031 * eina_stringshare_add() (they are not even guaranteed to be
13032 * stringshared, so must use eina_stringshare_add() and not
13033 * eina_stringshare_ref()).
13035 struct _Elm_Web_Frame_Load_Error
13037 int code; /**< Numeric error code */
13038 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13039 const char *domain; /**< Error domain name */
13040 const char *description; /**< Error description (already localized) */
13041 const char *failing_url; /**< The URL that failed to load */
13042 Evas_Object *frame; /**< Frame object that produced the error */
13046 * The possibles types that the items in a menu can be
13048 typedef enum _Elm_Web_Menu_Item_Type
13050 ELM_WEB_MENU_SEPARATOR,
13051 ELM_WEB_MENU_GROUP,
13052 ELM_WEB_MENU_OPTION
13053 } Elm_Web_Menu_Item_Type;
13056 * Structure describing the items in a menu
13058 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13060 * Structure describing the items in a menu
13062 struct _Elm_Web_Menu_Item
13064 const char *text; /**< The text for the item */
13065 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13069 * Structure describing the menu of a popup
13071 * This structure will be passed as the @c event_info for the "popup,create"
13072 * signal, which is emitted when a dropdown menu is opened. Users wanting
13073 * to handle these popups by themselves should listen to this signal and
13074 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13075 * property as @c EINA_FALSE means that the user will not handle the popup
13076 * and the default implementation will be used.
13078 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13079 * will be emitted to notify the user that it can destroy any objects and
13080 * free all data related to it.
13082 * @see elm_web_popup_selected_set()
13083 * @see elm_web_popup_destroy()
13085 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13087 * Structure describing the menu of a popup
13089 * This structure will be passed as the @c event_info for the "popup,create"
13090 * signal, which is emitted when a dropdown menu is opened. Users wanting
13091 * to handle these popups by themselves should listen to this signal and
13092 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13093 * property as @c EINA_FALSE means that the user will not handle the popup
13094 * and the default implementation will be used.
13096 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13097 * will be emitted to notify the user that it can destroy any objects and
13098 * free all data related to it.
13100 * @see elm_web_popup_selected_set()
13101 * @see elm_web_popup_destroy()
13103 struct _Elm_Web_Menu
13105 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13106 int x; /**< The X position of the popup, relative to the elm_web object */
13107 int y; /**< The Y position of the popup, relative to the elm_web object */
13108 int width; /**< Width of the popup menu */
13109 int height; /**< Height of the popup menu */
13111 Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13114 typedef struct _Elm_Web_Download Elm_Web_Download;
13115 struct _Elm_Web_Download
13121 * Types of zoom available.
13123 typedef enum _Elm_Web_Zoom_Mode
13125 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13126 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13127 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13128 ELM_WEB_ZOOM_MODE_LAST
13129 } Elm_Web_Zoom_Mode;
13131 * Opaque handler containing the features (such as statusbar, menubar, etc)
13132 * that are to be set on a newly requested window.
13134 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13136 * Callback type for the create_window hook.
13138 * The function parameters are:
13139 * @li @p data User data pointer set when setting the hook function
13140 * @li @p obj The elm_web object requesting the new window
13141 * @li @p js Set to @c EINA_TRUE if the request was originated from
13142 * JavaScript. @c EINA_FALSE otherwise.
13143 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13144 * the features requested for the new window.
13146 * The returned value of the function should be the @c elm_web widget where
13147 * the request will be loaded. That is, if a new window or tab is created,
13148 * the elm_web widget in it should be returned, and @b NOT the window
13150 * Returning @c NULL should cancel the request.
13152 * @see elm_web_window_create_hook_set()
13154 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13156 * Callback type for the JS alert hook.
13158 * The function parameters are:
13159 * @li @p data User data pointer set when setting the hook function
13160 * @li @p obj The elm_web object requesting the new window
13161 * @li @p message The message to show in the alert dialog
13163 * The function should return the object representing the alert dialog.
13164 * Elm_Web will run a second main loop to handle the dialog and normal
13165 * flow of the application will be restored when the object is deleted, so
13166 * the user should handle the popup properly in order to delete the object
13167 * when the action is finished.
13168 * If the function returns @c NULL the popup will be ignored.
13170 * @see elm_web_dialog_alert_hook_set()
13172 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13174 * Callback type for the JS confirm hook.
13176 * The function parameters are:
13177 * @li @p data User data pointer set when setting the hook function
13178 * @li @p obj The elm_web object requesting the new window
13179 * @li @p message The message to show in the confirm dialog
13180 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13181 * the user selected @c Ok, @c EINA_FALSE otherwise.
13183 * The function should return the object representing the confirm dialog.
13184 * Elm_Web will run a second main loop to handle the dialog and normal
13185 * flow of the application will be restored when the object is deleted, so
13186 * the user should handle the popup properly in order to delete the object
13187 * when the action is finished.
13188 * If the function returns @c NULL the popup will be ignored.
13190 * @see elm_web_dialog_confirm_hook_set()
13192 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13194 * Callback type for the JS prompt hook.
13196 * The function parameters are:
13197 * @li @p data User data pointer set when setting the hook function
13198 * @li @p obj The elm_web object requesting the new window
13199 * @li @p message The message to show in the prompt dialog
13200 * @li @p def_value The default value to present the user in the entry
13201 * @li @p value Pointer where to store the value given by the user. Must
13202 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13203 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13204 * the user selected @c Ok, @c EINA_FALSE otherwise.
13206 * The function should return the object representing the prompt dialog.
13207 * Elm_Web will run a second main loop to handle the dialog and normal
13208 * flow of the application will be restored when the object is deleted, so
13209 * the user should handle the popup properly in order to delete the object
13210 * when the action is finished.
13211 * If the function returns @c NULL the popup will be ignored.
13213 * @see elm_web_dialog_prompt_hook_set()
13215 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13217 * Callback type for the JS file selector hook.
13219 * The function parameters are:
13220 * @li @p data User data pointer set when setting the hook function
13221 * @li @p obj The elm_web object requesting the new window
13222 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13223 * @li @p accept_types Mime types accepted
13224 * @li @p selected Pointer where to store the list of malloc'ed strings
13225 * containing the path to each file selected. Must be @c NULL if the file
13226 * dialog is cancelled
13227 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13228 * the user selected @c Ok, @c EINA_FALSE otherwise.
13230 * The function should return the object representing the file selector
13232 * Elm_Web will run a second main loop to handle the dialog and normal
13233 * flow of the application will be restored when the object is deleted, so
13234 * the user should handle the popup properly in order to delete the object
13235 * when the action is finished.
13236 * If the function returns @c NULL the popup will be ignored.
13238 * @see elm_web_dialog_file selector_hook_set()
13240 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13242 * Callback type for the JS console message hook.
13244 * When a console message is added from JavaScript, any set function to the
13245 * console message hook will be called for the user to handle. There is no
13246 * default implementation of this hook.
13248 * The function parameters are:
13249 * @li @p data User data pointer set when setting the hook function
13250 * @li @p obj The elm_web object that originated the message
13251 * @li @p message The message sent
13252 * @li @p line_number The line number
13253 * @li @p source_id Source id
13255 * @see elm_web_console_message_hook_set()
13257 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13259 * Add a new web object to the parent.
13261 * @param parent The parent object.
13262 * @return The new object or NULL if it cannot be created.
13264 * @see elm_web_uri_set()
13265 * @see elm_web_webkit_view_get()
13267 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13270 * Get internal ewk_view object from web object.
13272 * Elementary may not provide some low level features of EWebKit,
13273 * instead of cluttering the API with proxy methods we opted to
13274 * return the internal reference. Be careful using it as it may
13275 * interfere with elm_web behavior.
13277 * @param obj The web object.
13278 * @return The internal ewk_view object or NULL if it does not
13279 * exist. (Failure to create or Elementary compiled without
13282 * @see elm_web_add()
13284 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13287 * Sets the function to call when a new window is requested
13289 * This hook will be called when a request to create a new window is
13290 * issued from the web page loaded.
13291 * There is no default implementation for this feature, so leaving this
13292 * unset or passing @c NULL in @p func will prevent new windows from
13295 * @param obj The web object where to set the hook function
13296 * @param func The hook function to be called when a window is requested
13297 * @param data User data
13299 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13301 * Sets the function to call when an alert dialog
13303 * This hook will be called when a JavaScript alert dialog is requested.
13304 * If no function is set or @c NULL is passed in @p func, the default
13305 * implementation will take place.
13307 * @param obj The web object where to set the hook function
13308 * @param func The callback function to be used
13309 * @param data User data
13311 * @see elm_web_inwin_mode_set()
13313 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13315 * Sets the function to call when an confirm dialog
13317 * This hook will be called when a JavaScript confirm dialog is requested.
13318 * If no function is set or @c NULL is passed in @p func, the default
13319 * implementation will take place.
13321 * @param obj The web object where to set the hook function
13322 * @param func The callback function to be used
13323 * @param data User data
13325 * @see elm_web_inwin_mode_set()
13327 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13329 * Sets the function to call when an prompt dialog
13331 * This hook will be called when a JavaScript prompt dialog is requested.
13332 * If no function is set or @c NULL is passed in @p func, the default
13333 * implementation will take place.
13335 * @param obj The web object where to set the hook function
13336 * @param func The callback function to be used
13337 * @param data User data
13339 * @see elm_web_inwin_mode_set()
13341 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13343 * Sets the function to call when an file selector dialog
13345 * This hook will be called when a JavaScript file selector dialog is
13347 * If no function is set or @c NULL is passed in @p func, the default
13348 * implementation will take place.
13350 * @param obj The web object where to set the hook function
13351 * @param func The callback function to be used
13352 * @param data User data
13354 * @see elm_web_inwin_mode_set()
13356 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13358 * Sets the function to call when a console message is emitted from JS
13360 * This hook will be called when a console message is emitted from
13361 * JavaScript. There is no default implementation for this feature.
13363 * @param obj The web object where to set the hook function
13364 * @param func The callback function to be used
13365 * @param data User data
13367 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13369 * Gets the status of the tab propagation
13371 * @param obj The web object to query
13372 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13374 * @see elm_web_tab_propagate_set()
13376 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13378 * Sets whether to use tab propagation
13380 * If tab propagation is enabled, whenever the user presses the Tab key,
13381 * Elementary will handle it and switch focus to the next widget.
13382 * The default value is disabled, where WebKit will handle the Tab key to
13383 * cycle focus though its internal objects, jumping to the next widget
13384 * only when that cycle ends.
13386 * @param obj The web object
13387 * @param propagate Whether to propagate Tab keys to Elementary or not
13389 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13391 * Sets the URI for the web object
13393 * It must be a full URI, with resource included, in the form
13394 * http://www.enlightenment.org or file:///tmp/something.html
13396 * @param obj The web object
13397 * @param uri The URI to set
13398 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13400 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13402 * Gets the current URI for the object
13404 * The returned string must not be freed and is guaranteed to be
13407 * @param obj The web object
13408 * @return A stringshared internal string with the current URI, or NULL on
13411 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13413 * Gets the current title
13415 * The returned string must not be freed and is guaranteed to be
13418 * @param obj The web object
13419 * @return A stringshared internal string with the current title, or NULL on
13422 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13424 * Sets the background color to be used by the web object
13426 * This is the color that will be used by default when the loaded page
13427 * does not set it's own. Color values are pre-multiplied.
13429 * @param obj The web object
13430 * @param r Red component
13431 * @param g Green component
13432 * @param b Blue component
13433 * @param a Alpha component
13435 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13437 * Gets the background color to be used by the web object
13439 * This is the color that will be used by default when the loaded page
13440 * does not set it's own. Color values are pre-multiplied.
13442 * @param obj The web object
13443 * @param r Red component
13444 * @param g Green component
13445 * @param b Blue component
13446 * @param a Alpha component
13448 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13450 * Gets a copy of the currently selected text
13452 * The string returned must be freed by the user when it's done with it.
13454 * @param obj The web object
13455 * @return A newly allocated string, or NULL if nothing is selected or an
13458 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13460 * Tells the web object which index in the currently open popup was selected
13462 * When the user handles the popup creation from the "popup,created" signal,
13463 * it needs to tell the web object which item was selected by calling this
13464 * function with the index corresponding to the item.
13466 * @param obj The web object
13467 * @param index The index selected
13469 * @see elm_web_popup_destroy()
13471 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13473 * Dismisses an open dropdown popup
13475 * When the popup from a dropdown widget is to be dismissed, either after
13476 * selecting an option or to cancel it, this function must be called, which
13477 * will later emit an "popup,willdelete" signal to notify the user that
13478 * any memory and objects related to this popup can be freed.
13480 * @param obj The web object
13481 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13482 * if there was no menu to destroy
13484 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13486 * Searches the given string in a document.
13488 * @param obj The web object where to search the text
13489 * @param string String to search
13490 * @param case_sensitive If search should be case sensitive or not
13491 * @param forward If search is from cursor and on or backwards
13492 * @param wrap If search should wrap at the end
13494 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13497 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13499 * Marks matches of the given string in a document.
13501 * @param obj The web object where to search text
13502 * @param string String to match
13503 * @param case_sensitive If match should be case sensitive or not
13504 * @param highlight If matches should be highlighted
13505 * @param limit Maximum amount of matches, or zero to unlimited
13507 * @return number of matched @a string
13509 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13511 * Clears all marked matches in the document
13513 * @param obj The web object
13515 * @return EINA_TRUE on success, EINA_FALSE otherwise
13517 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13519 * Sets whether to highlight the matched marks
13521 * If enabled, marks set with elm_web_text_matches_mark() will be
13524 * @param obj The web object
13525 * @param highlight Whether to highlight the marks or not
13527 * @return EINA_TRUE on success, EINA_FALSE otherwise
13529 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13531 * Gets whether highlighting marks is enabled
13533 * @param The web object
13535 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13538 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13540 * Gets the overall loading progress of the page
13542 * Returns the estimated loading progress of the page, with a value between
13543 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13544 * included in the page.
13546 * @param The web object
13548 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13551 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13553 * Stops loading the current page
13555 * Cancels the loading of the current page in the web object. This will
13556 * cause a "load,error" signal to be emitted, with the is_cancellation
13557 * flag set to EINA_TRUE.
13559 * @param obj The web object
13561 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13563 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13565 * Requests a reload of the current document in the object
13567 * @param obj The web object
13569 * @return EINA_TRUE on success, EINA_FALSE otherwise
13571 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13573 * Requests a reload of the current document, avoiding any existing caches
13575 * @param obj The web object
13577 * @return EINA_TRUE on success, EINA_FALSE otherwise
13579 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13581 * Goes back one step in the browsing history
13583 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13585 * @param obj The web object
13587 * @return EINA_TRUE on success, EINA_FALSE otherwise
13589 * @see elm_web_history_enable_set()
13590 * @see elm_web_back_possible()
13591 * @see elm_web_forward()
13592 * @see elm_web_navigate()
13594 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13596 * Goes forward one step in the browsing history
13598 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13600 * @param obj The web object
13602 * @return EINA_TRUE on success, EINA_FALSE otherwise
13604 * @see elm_web_history_enable_set()
13605 * @see elm_web_forward_possible()
13606 * @see elm_web_back()
13607 * @see elm_web_navigate()
13609 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13611 * Jumps the given number of steps in the browsing history
13613 * The @p steps value can be a negative integer to back in history, or a
13614 * positive to move forward.
13616 * @param obj The web object
13617 * @param steps The number of steps to jump
13619 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13620 * history exists to jump the given number of steps
13622 * @see elm_web_history_enable_set()
13623 * @see elm_web_navigate_possible()
13624 * @see elm_web_back()
13625 * @see elm_web_forward()
13627 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13629 * Queries whether it's possible to go back in history
13631 * @param obj The web object
13633 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13636 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13638 * Queries whether it's possible to go forward in history
13640 * @param obj The web object
13642 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13645 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13647 * Queries whether it's possible to jump the given number of steps
13649 * The @p steps value can be a negative integer to back in history, or a
13650 * positive to move forward.
13652 * @param obj The web object
13653 * @param steps The number of steps to check for
13655 * @return EINA_TRUE if enough history exists to perform the given jump,
13656 * EINA_FALSE otherwise
13658 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13660 * Gets whether browsing history is enabled for the given object
13662 * @param obj The web object
13664 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13666 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13668 * Enables or disables the browsing history
13670 * @param obj The web object
13671 * @param enable Whether to enable or disable the browsing history
13673 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13675 * Sets the zoom level of the web object
13677 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13678 * values meaning zoom in and lower meaning zoom out. This function will
13679 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13680 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13682 * @param obj The web object
13683 * @param zoom The zoom level to set
13685 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13687 * Gets the current zoom level set on the web object
13689 * Note that this is the zoom level set on the web object and not that
13690 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13691 * the two zoom levels should match, but for the other two modes the
13692 * Webkit zoom is calculated internally to match the chosen mode without
13693 * changing the zoom level set for the web object.
13695 * @param obj The web object
13697 * @return The zoom level set on the object
13699 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13701 * Sets the zoom mode to use
13703 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13704 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13706 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13707 * with the elm_web_zoom_set() function.
13708 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13709 * make sure the entirety of the web object's contents are shown.
13710 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13711 * fit the contents in the web object's size, without leaving any space
13714 * @param obj The web object
13715 * @param mode The mode to set
13717 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13719 * Gets the currently set zoom mode
13721 * @param obj The web object
13723 * @return The current zoom mode set for the object, or
13724 * ::ELM_WEB_ZOOM_MODE_LAST on error
13726 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13728 * Shows the given region in the web object
13730 * @param obj The web object
13731 * @param x The x coordinate of the region to show
13732 * @param y The y coordinate of the region to show
13733 * @param w The width of the region to show
13734 * @param h The height of the region to show
13736 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13738 * Brings in the region to the visible area
13740 * Like elm_web_region_show(), but it animates the scrolling of the object
13743 * @param obj The web object
13744 * @param x The x coordinate of the region to show
13745 * @param y The y coordinate of the region to show
13746 * @param w The width of the region to show
13747 * @param h The height of the region to show
13749 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13751 * Sets the default dialogs to use an Inwin instead of a normal window
13753 * If set, then the default implementation for the JavaScript dialogs and
13754 * file selector will be opened in an Inwin. Otherwise they will use a
13755 * normal separated window.
13757 * @param obj The web object
13758 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13760 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13762 * Gets whether Inwin mode is set for the current object
13764 * @param obj The web object
13766 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13768 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13770 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13771 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13772 EAPI void elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
13773 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13781 * @defgroup Hoversel Hoversel
13783 * @image html img/widget/hoversel/preview-00.png
13784 * @image latex img/widget/hoversel/preview-00.eps
13786 * A hoversel is a button that pops up a list of items (automatically
13787 * choosing the direction to display) that have a label and, optionally, an
13788 * icon to select from. It is a convenience widget to avoid the need to do
13789 * all the piecing together yourself. It is intended for a small number of
13790 * items in the hoversel menu (no more than 8), though is capable of many
13793 * Signals that you can add callbacks for are:
13794 * "clicked" - the user clicked the hoversel button and popped up the sel
13795 * "selected" - an item in the hoversel list is selected. event_info is the item
13796 * "dismissed" - the hover is dismissed
13798 * See @ref tutorial_hoversel for an example.
13801 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13803 * @brief Add a new Hoversel object
13805 * @param parent The parent object
13806 * @return The new object or NULL if it cannot be created
13808 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13810 * @brief This sets the hoversel to expand horizontally.
13812 * @param obj The hoversel object
13813 * @param horizontal If true, the hover will expand horizontally to the
13816 * @note The initial button will display horizontally regardless of this
13819 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13821 * @brief This returns whether the hoversel is set to expand horizontally.
13823 * @param obj The hoversel object
13824 * @return If true, the hover will expand horizontally to the right.
13826 * @see elm_hoversel_horizontal_set()
13828 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13830 * @brief Set the Hover parent
13832 * @param obj The hoversel object
13833 * @param parent The parent to use
13835 * Sets the hover parent object, the area that will be darkened when the
13836 * hoversel is clicked. Should probably be the window that the hoversel is
13837 * in. See @ref Hover objects for more information.
13839 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13841 * @brief Get the Hover parent
13843 * @param obj The hoversel object
13844 * @return The used parent
13846 * Gets the hover parent object.
13848 * @see elm_hoversel_hover_parent_set()
13850 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13852 * @brief Set the hoversel button label
13854 * @param obj The hoversel object
13855 * @param label The label text.
13857 * This sets the label of the button that is always visible (before it is
13858 * clicked and expanded).
13860 * @deprecated elm_object_text_set()
13862 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13864 * @brief Get the hoversel button label
13866 * @param obj The hoversel object
13867 * @return The label text.
13869 * @deprecated elm_object_text_get()
13871 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13873 * @brief Set the icon of the hoversel button
13875 * @param obj The hoversel object
13876 * @param icon The icon object
13878 * Sets the icon of the button that is always visible (before it is clicked
13879 * and expanded). Once the icon object is set, a previously set one will be
13880 * deleted, if you want to keep that old content object, use the
13881 * elm_hoversel_icon_unset() function.
13883 * @see elm_object_content_set() for the button widget
13885 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13887 * @brief Get the icon of the hoversel button
13889 * @param obj The hoversel object
13890 * @return The icon object
13892 * Get the icon of the button that is always visible (before it is clicked
13893 * and expanded). Also see elm_object_content_get() for the button widget.
13895 * @see elm_hoversel_icon_set()
13897 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13899 * @brief Get and unparent the icon of the hoversel button
13901 * @param obj The hoversel object
13902 * @return The icon object that was being used
13904 * Unparent and return the icon of the button that is always visible
13905 * (before it is clicked and expanded).
13907 * @see elm_hoversel_icon_set()
13908 * @see elm_object_content_unset() for the button widget
13910 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13912 * @brief This triggers the hoversel popup from code, the same as if the user
13913 * had clicked the button.
13915 * @param obj The hoversel object
13917 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13919 * @brief This dismisses the hoversel popup as if the user had clicked
13920 * outside the hover.
13922 * @param obj The hoversel object
13924 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13926 * @brief Returns whether the hoversel is expanded.
13928 * @param obj The hoversel object
13929 * @return This will return EINA_TRUE if the hoversel is expanded or
13930 * EINA_FALSE if it is not expanded.
13932 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13934 * @brief This will remove all the children items from the hoversel.
13936 * @param obj The hoversel object
13938 * @warning Should @b not be called while the hoversel is active; use
13939 * elm_hoversel_expanded_get() to check first.
13941 * @see elm_hoversel_item_del_cb_set()
13942 * @see elm_hoversel_item_del()
13944 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13946 * @brief Get the list of items within the given hoversel.
13948 * @param obj The hoversel object
13949 * @return Returns a list of Elm_Hoversel_Item*
13951 * @see elm_hoversel_item_add()
13953 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13955 * @brief Add an item to the hoversel button
13957 * @param obj The hoversel object
13958 * @param label The text label to use for the item (NULL if not desired)
13959 * @param icon_file An image file path on disk to use for the icon or standard
13960 * icon name (NULL if not desired)
13961 * @param icon_type The icon type if relevant
13962 * @param func Convenience function to call when this item is selected
13963 * @param data Data to pass to item-related functions
13964 * @return A handle to the item added.
13966 * This adds an item to the hoversel to show when it is clicked. Note: if you
13967 * need to use an icon from an edje file then use
13968 * elm_hoversel_item_icon_set() right after the this function, and set
13969 * icon_file to NULL here.
13971 * For more information on what @p icon_file and @p icon_type are see the
13972 * @ref Icon "icon documentation".
13974 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);
13976 * @brief Delete an item from the hoversel
13978 * @param item The item to delete
13980 * This deletes the item from the hoversel (should not be called while the
13981 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13983 * @see elm_hoversel_item_add()
13984 * @see elm_hoversel_item_del_cb_set()
13986 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13988 * @brief Set the function to be called when an item from the hoversel is
13991 * @param item The item to set the callback on
13992 * @param func The function called
13994 * That function will receive these parameters:
13995 * @li void *item_data
13996 * @li Evas_Object *the_item_object
13997 * @li Elm_Hoversel_Item *the_object_struct
13999 * @see elm_hoversel_item_add()
14001 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14003 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14004 * that will be passed to associated function callbacks.
14006 * @param item The item to get the data from
14007 * @return The data pointer set with elm_hoversel_item_add()
14009 * @see elm_hoversel_item_add()
14011 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14013 * @brief This returns the label text of the given hoversel item.
14015 * @param item The item to get the label
14016 * @return The label text of the hoversel item
14018 * @see elm_hoversel_item_add()
14020 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14022 * @brief This sets the icon for the given hoversel item.
14024 * @param item The item to set the icon
14025 * @param icon_file An image file path on disk to use for the icon or standard
14027 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14028 * to NULL if the icon is not an edje file
14029 * @param icon_type The icon type
14031 * The icon can be loaded from the standard set, from an image file, or from
14034 * @see elm_hoversel_item_add()
14036 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);
14038 * @brief Get the icon object of the hoversel item
14040 * @param item The item to get the icon from
14041 * @param icon_file The image file path on disk used for the icon or standard
14043 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14044 * if the icon is not an edje file
14045 * @param icon_type The icon type
14047 * @see elm_hoversel_item_icon_set()
14048 * @see elm_hoversel_item_add()
14050 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);
14056 * @defgroup Toolbar Toolbar
14057 * @ingroup Elementary
14059 * @image html img/widget/toolbar/preview-00.png
14060 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14062 * @image html img/toolbar.png
14063 * @image latex img/toolbar.eps width=\textwidth
14065 * A toolbar is a widget that displays a list of items inside
14066 * a box. It can be scrollable, show a menu with items that don't fit
14067 * to toolbar size or even crop them.
14069 * Only one item can be selected at a time.
14071 * Items can have multiple states, or show menus when selected by the user.
14073 * Smart callbacks one can listen to:
14074 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14075 * - "language,changed" - when the program language changes
14077 * Available styles for it:
14079 * - @c "transparent" - no background or shadow, just show the content
14081 * List of examples:
14082 * @li @ref toolbar_example_01
14083 * @li @ref toolbar_example_02
14084 * @li @ref toolbar_example_03
14088 * @addtogroup Toolbar
14093 * @enum _Elm_Toolbar_Shrink_Mode
14094 * @typedef Elm_Toolbar_Shrink_Mode
14096 * Set toolbar's items display behavior, it can be scrollabel,
14097 * show a menu with exceeding items, or simply hide them.
14099 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14102 * Values <b> don't </b> work as bitmask, only one can be choosen.
14104 * @see elm_toolbar_mode_shrink_set()
14105 * @see elm_toolbar_mode_shrink_get()
14109 typedef enum _Elm_Toolbar_Shrink_Mode
14111 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14112 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14113 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14114 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14115 } Elm_Toolbar_Shrink_Mode;
14117 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(). */
14119 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(). */
14122 * Add a new toolbar widget to the given parent Elementary
14123 * (container) object.
14125 * @param parent The parent object.
14126 * @return a new toolbar widget handle or @c NULL, on errors.
14128 * This function inserts a new toolbar widget on the canvas.
14132 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14135 * Set the icon size, in pixels, to be used by toolbar items.
14137 * @param obj The toolbar object
14138 * @param icon_size The icon size in pixels
14140 * @note Default value is @c 32. It reads value from elm config.
14142 * @see elm_toolbar_icon_size_get()
14146 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14149 * Get the icon size, in pixels, to be used by toolbar items.
14151 * @param obj The toolbar object.
14152 * @return The icon size in pixels.
14154 * @see elm_toolbar_icon_size_set() for details.
14158 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14161 * Sets icon lookup order, for toolbar items' icons.
14163 * @param obj The toolbar object.
14164 * @param order The icon lookup order.
14166 * Icons added before calling this function will not be affected.
14167 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14169 * @see elm_toolbar_icon_order_lookup_get()
14173 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14176 * Gets the icon lookup order.
14178 * @param obj The toolbar object.
14179 * @return The icon lookup order.
14181 * @see elm_toolbar_icon_order_lookup_set() for details.
14185 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14188 * Set whether the toolbar items' should be selected by the user or not.
14190 * @param obj The toolbar object.
14191 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14194 * This will turn off the ability to select items entirely and they will
14195 * neither appear selected nor emit selected signals. The clicked
14196 * callback function will still be called.
14198 * Selection is enabled by default.
14200 * @see elm_toolbar_no_select_mode_get().
14204 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14207 * Set whether the toolbar items' should be selected by the user or not.
14209 * @param obj The toolbar object.
14210 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14211 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14213 * @see elm_toolbar_no_select_mode_set() for details.
14217 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14220 * Append item to the toolbar.
14222 * @param obj The toolbar object.
14223 * @param icon A string with icon name or the absolute path of an image file.
14224 * @param label The label of the item.
14225 * @param func The function to call when the item is clicked.
14226 * @param data The data to associate with the item for related callbacks.
14227 * @return The created item or @c NULL upon failure.
14229 * A new item will be created and appended to the toolbar, i.e., will
14230 * be set as @b last item.
14232 * Items created with this method can be deleted with
14233 * elm_toolbar_item_del().
14235 * Associated @p data can be properly freed when item is deleted if a
14236 * callback function is set with elm_toolbar_item_del_cb_set().
14238 * If a function is passed as argument, it will be called everytime this item
14239 * is selected, i.e., the user clicks over an unselected item.
14240 * If such function isn't needed, just passing
14241 * @c NULL as @p func is enough. The same should be done for @p data.
14243 * Toolbar will load icon image from fdo or current theme.
14244 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14245 * If an absolute path is provided it will load it direct from a file.
14247 * @see elm_toolbar_item_icon_set()
14248 * @see elm_toolbar_item_del()
14249 * @see elm_toolbar_item_del_cb_set()
14253 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);
14256 * Prepend item to the toolbar.
14258 * @param obj The toolbar object.
14259 * @param icon A string with icon name or the absolute path of an image file.
14260 * @param label The label of the item.
14261 * @param func The function to call when the item is clicked.
14262 * @param data The data to associate with the item for related callbacks.
14263 * @return The created item or @c NULL upon failure.
14265 * A new item will be created and prepended to the toolbar, i.e., will
14266 * be set as @b first item.
14268 * Items created with this method can be deleted with
14269 * elm_toolbar_item_del().
14271 * Associated @p data can be properly freed when item is deleted if a
14272 * callback function is set with elm_toolbar_item_del_cb_set().
14274 * If a function is passed as argument, it will be called everytime this item
14275 * is selected, i.e., the user clicks over an unselected item.
14276 * If such function isn't needed, just passing
14277 * @c NULL as @p func is enough. The same should be done for @p data.
14279 * Toolbar will load icon image from fdo or current theme.
14280 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14281 * If an absolute path is provided it will load it direct from a file.
14283 * @see elm_toolbar_item_icon_set()
14284 * @see elm_toolbar_item_del()
14285 * @see elm_toolbar_item_del_cb_set()
14289 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);
14292 * Insert a new item into the toolbar object before item @p before.
14294 * @param obj The toolbar object.
14295 * @param before The toolbar item to insert before.
14296 * @param icon A string with icon name or the absolute path of an image file.
14297 * @param label The label of the item.
14298 * @param func The function to call when the item is clicked.
14299 * @param data The data to associate with the item for related callbacks.
14300 * @return The created item or @c NULL upon failure.
14302 * A new item will be created and added to the toolbar. Its position in
14303 * this toolbar will be just before item @p before.
14305 * Items created with this method can be deleted with
14306 * elm_toolbar_item_del().
14308 * Associated @p data can be properly freed when item is deleted if a
14309 * callback function is set with elm_toolbar_item_del_cb_set().
14311 * If a function is passed as argument, it will be called everytime this item
14312 * is selected, i.e., the user clicks over an unselected item.
14313 * If such function isn't needed, just passing
14314 * @c NULL as @p func is enough. The same should be done for @p data.
14316 * Toolbar will load icon image from fdo or current theme.
14317 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14318 * If an absolute path is provided it will load it direct from a file.
14320 * @see elm_toolbar_item_icon_set()
14321 * @see elm_toolbar_item_del()
14322 * @see elm_toolbar_item_del_cb_set()
14326 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);
14329 * Insert a new item into the toolbar object after item @p after.
14331 * @param obj The toolbar object.
14332 * @param after The toolbar item to insert after.
14333 * @param icon A string with icon name or the absolute path of an image file.
14334 * @param label The label of the item.
14335 * @param func The function to call when the item is clicked.
14336 * @param data The data to associate with the item for related callbacks.
14337 * @return The created item or @c NULL upon failure.
14339 * A new item will be created and added to the toolbar. Its position in
14340 * this toolbar will be just after item @p after.
14342 * Items created with this method can be deleted with
14343 * elm_toolbar_item_del().
14345 * Associated @p data can be properly freed when item is deleted if a
14346 * callback function is set with elm_toolbar_item_del_cb_set().
14348 * If a function is passed as argument, it will be called everytime this item
14349 * is selected, i.e., the user clicks over an unselected item.
14350 * If such function isn't needed, just passing
14351 * @c NULL as @p func is enough. The same should be done for @p data.
14353 * Toolbar will load icon image from fdo or current theme.
14354 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14355 * If an absolute path is provided it will load it direct from a file.
14357 * @see elm_toolbar_item_icon_set()
14358 * @see elm_toolbar_item_del()
14359 * @see elm_toolbar_item_del_cb_set()
14363 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);
14366 * Get the first item in the given toolbar widget's list of
14369 * @param obj The toolbar object
14370 * @return The first item or @c NULL, if it has no items (and on
14373 * @see elm_toolbar_item_append()
14374 * @see elm_toolbar_last_item_get()
14378 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14381 * Get the last item in the given toolbar widget's list of
14384 * @param obj The toolbar object
14385 * @return The last item or @c NULL, if it has no items (and on
14388 * @see elm_toolbar_item_prepend()
14389 * @see elm_toolbar_first_item_get()
14393 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14396 * Get the item after @p item in toolbar.
14398 * @param item The toolbar item.
14399 * @return The item after @p item, or @c NULL if none or on failure.
14401 * @note If it is the last item, @c NULL will be returned.
14403 * @see elm_toolbar_item_append()
14407 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14410 * Get the item before @p item in toolbar.
14412 * @param item The toolbar item.
14413 * @return The item before @p item, or @c NULL if none or on failure.
14415 * @note If it is the first item, @c NULL will be returned.
14417 * @see elm_toolbar_item_prepend()
14421 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14424 * Get the toolbar object from an item.
14426 * @param item The item.
14427 * @return The toolbar object.
14429 * This returns the toolbar object itself that an item belongs to.
14433 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14436 * Set the priority of a toolbar item.
14438 * @param item The toolbar item.
14439 * @param priority The item priority. The default is zero.
14441 * This is used only when the toolbar shrink mode is set to
14442 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14443 * When space is less than required, items with low priority
14444 * will be removed from the toolbar and added to a dynamically-created menu,
14445 * while items with higher priority will remain on the toolbar,
14446 * with the same order they were added.
14448 * @see elm_toolbar_item_priority_get()
14452 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14455 * Get the priority of a toolbar item.
14457 * @param item The toolbar item.
14458 * @return The @p item priority, or @c 0 on failure.
14460 * @see elm_toolbar_item_priority_set() for details.
14464 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14467 * Get the label of item.
14469 * @param item The item of toolbar.
14470 * @return The label of item.
14472 * The return value is a pointer to the label associated to @p item when
14473 * it was created, with function elm_toolbar_item_append() or similar,
14475 * with function elm_toolbar_item_label_set. If no label
14476 * was passed as argument, it will return @c NULL.
14478 * @see elm_toolbar_item_label_set() for more details.
14479 * @see elm_toolbar_item_append()
14483 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14486 * Set the label of item.
14488 * @param item The item of toolbar.
14489 * @param text The label of item.
14491 * The label to be displayed by the item.
14492 * Label will be placed at icons bottom (if set).
14494 * If a label was passed as argument on item creation, with function
14495 * elm_toolbar_item_append() or similar, it will be already
14496 * displayed by the item.
14498 * @see elm_toolbar_item_label_get()
14499 * @see elm_toolbar_item_append()
14503 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14506 * Return the data associated with a given toolbar widget item.
14508 * @param item The toolbar widget item handle.
14509 * @return The data associated with @p item.
14511 * @see elm_toolbar_item_data_set()
14515 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14518 * Set the data associated with a given toolbar widget item.
14520 * @param item The toolbar widget item handle.
14521 * @param data The new data pointer to set to @p item.
14523 * This sets new item data on @p item.
14525 * @warning The old data pointer won't be touched by this function, so
14526 * the user had better to free that old data himself/herself.
14530 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14533 * Returns a pointer to a toolbar item by its label.
14535 * @param obj The toolbar object.
14536 * @param label The label of the item to find.
14538 * @return The pointer to the toolbar item matching @p label or @c NULL
14543 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14546 * Get whether the @p item is selected or not.
14548 * @param item The toolbar item.
14549 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14550 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14552 * @see elm_toolbar_selected_item_set() for details.
14553 * @see elm_toolbar_item_selected_get()
14557 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14560 * Set the selected state of an item.
14562 * @param item The toolbar item
14563 * @param selected The selected state
14565 * This sets the selected state of the given item @p it.
14566 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14568 * If a new item is selected the previosly selected will be unselected.
14569 * Previoulsy selected item can be get with function
14570 * elm_toolbar_selected_item_get().
14572 * Selected items will be highlighted.
14574 * @see elm_toolbar_item_selected_get()
14575 * @see elm_toolbar_selected_item_get()
14579 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14582 * Get the selected item.
14584 * @param obj The toolbar object.
14585 * @return The selected toolbar item.
14587 * The selected item can be unselected with function
14588 * elm_toolbar_item_selected_set().
14590 * The selected item always will be highlighted on toolbar.
14592 * @see elm_toolbar_selected_items_get()
14596 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14599 * Set the icon associated with @p item.
14601 * @param obj The parent of this item.
14602 * @param item The toolbar item.
14603 * @param icon A string with icon name or the absolute path of an image file.
14605 * Toolbar will load icon image from fdo or current theme.
14606 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14607 * If an absolute path is provided it will load it direct from a file.
14609 * @see elm_toolbar_icon_order_lookup_set()
14610 * @see elm_toolbar_icon_order_lookup_get()
14614 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14617 * Get the string used to set the icon of @p item.
14619 * @param item The toolbar item.
14620 * @return The string associated with the icon object.
14622 * @see elm_toolbar_item_icon_set() for details.
14626 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14629 * Get the object of @p item.
14631 * @param item The toolbar item.
14632 * @return The object
14636 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14639 * Get the icon object of @p item.
14641 * @param item The toolbar item.
14642 * @return The icon object
14644 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14648 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14651 * Set the icon associated with @p item to an image in a binary buffer.
14653 * @param item The toolbar item.
14654 * @param img The binary data that will be used as an image
14655 * @param size The size of binary data @p img
14656 * @param format Optional format of @p img to pass to the image loader
14657 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14659 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14661 * @note The icon image set by this function can be changed by
14662 * elm_toolbar_item_icon_set().
14666 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
14669 * Delete them item from the toolbar.
14671 * @param item The item of toolbar to be deleted.
14673 * @see elm_toolbar_item_append()
14674 * @see elm_toolbar_item_del_cb_set()
14678 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14681 * Set the function called when a toolbar item is freed.
14683 * @param item The item to set the callback on.
14684 * @param func The function called.
14686 * If there is a @p func, then it will be called prior item's memory release.
14687 * That will be called with the following arguments:
14689 * @li item's Evas object;
14692 * This way, a data associated to a toolbar item could be properly freed.
14696 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14699 * Get a value whether toolbar item is disabled or not.
14701 * @param item The item.
14702 * @return The disabled state.
14704 * @see elm_toolbar_item_disabled_set() for more details.
14708 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14711 * Sets the disabled/enabled state of a toolbar item.
14713 * @param item The item.
14714 * @param disabled The disabled state.
14716 * A disabled item cannot be selected or unselected. It will also
14717 * change its appearance (generally greyed out). This sets the
14718 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14723 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14726 * Set or unset item as a separator.
14728 * @param item The toolbar item.
14729 * @param setting @c EINA_TRUE to set item @p item as separator or
14730 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14732 * Items aren't set as separator by default.
14734 * If set as separator it will display separator theme, so won't display
14737 * @see elm_toolbar_item_separator_get()
14741 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14744 * Get a value whether item is a separator or not.
14746 * @param item The toolbar item.
14747 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14748 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14750 * @see elm_toolbar_item_separator_set() for details.
14754 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14757 * Set the shrink state of toolbar @p obj.
14759 * @param obj The toolbar object.
14760 * @param shrink_mode Toolbar's items display behavior.
14762 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14763 * but will enforce a minimun size so all the items will fit, won't scroll
14764 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14765 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14766 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14770 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14773 * Get the shrink mode of toolbar @p obj.
14775 * @param obj The toolbar object.
14776 * @return Toolbar's items display behavior.
14778 * @see elm_toolbar_mode_shrink_set() for details.
14782 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14785 * Enable/disable homogenous mode.
14787 * @param obj The toolbar object
14788 * @param homogeneous Assume the items within the toolbar are of the
14789 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14791 * This will enable the homogeneous mode where items are of the same size.
14792 * @see elm_toolbar_homogeneous_get()
14796 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14799 * Get whether the homogenous mode is enabled.
14801 * @param obj The toolbar object.
14802 * @return Assume the items within the toolbar are of the same height
14803 * and width (EINA_TRUE = on, EINA_FALSE = off).
14805 * @see elm_toolbar_homogeneous_set()
14809 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14812 * Enable/disable homogenous mode.
14814 * @param obj The toolbar object
14815 * @param homogeneous Assume the items within the toolbar are of the
14816 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14818 * This will enable the homogeneous mode where items are of the same size.
14819 * @see elm_toolbar_homogeneous_get()
14821 * @deprecated use elm_toolbar_homogeneous_set() instead.
14825 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14828 * Get whether the homogenous mode is enabled.
14830 * @param obj The toolbar object.
14831 * @return Assume the items within the toolbar are of the same height
14832 * and width (EINA_TRUE = on, EINA_FALSE = off).
14834 * @see elm_toolbar_homogeneous_set()
14835 * @deprecated use elm_toolbar_homogeneous_get() instead.
14839 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14842 * Set the parent object of the toolbar items' menus.
14844 * @param obj The toolbar object.
14845 * @param parent The parent of the menu objects.
14847 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14849 * For more details about setting the parent for toolbar menus, see
14850 * elm_menu_parent_set().
14852 * @see elm_menu_parent_set() for details.
14853 * @see elm_toolbar_item_menu_set() for details.
14857 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14860 * Get the parent object of the toolbar items' menus.
14862 * @param obj The toolbar object.
14863 * @return The parent of the menu objects.
14865 * @see elm_toolbar_menu_parent_set() for details.
14869 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14872 * Set the alignment of the items.
14874 * @param obj The toolbar object.
14875 * @param align The new alignment, a float between <tt> 0.0 </tt>
14876 * and <tt> 1.0 </tt>.
14878 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14879 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14882 * Centered items by default.
14884 * @see elm_toolbar_align_get()
14888 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14891 * Get the alignment of the items.
14893 * @param obj The toolbar object.
14894 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14897 * @see elm_toolbar_align_set() for details.
14901 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14904 * Set whether the toolbar item opens a menu.
14906 * @param item The toolbar item.
14907 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14909 * A toolbar item can be set to be a menu, using this function.
14911 * Once it is set to be a menu, it can be manipulated through the
14912 * menu-like function elm_toolbar_menu_parent_set() and the other
14913 * elm_menu functions, using the Evas_Object @c menu returned by
14914 * elm_toolbar_item_menu_get().
14916 * So, items to be displayed in this item's menu should be added with
14917 * elm_menu_item_add().
14919 * The following code exemplifies the most basic usage:
14921 * tb = elm_toolbar_add(win)
14922 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14923 * elm_toolbar_item_menu_set(item, EINA_TRUE);
14924 * elm_toolbar_menu_parent_set(tb, win);
14925 * menu = elm_toolbar_item_menu_get(item);
14926 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14927 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14931 * @see elm_toolbar_item_menu_get()
14935 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14938 * Get toolbar item's menu.
14940 * @param item The toolbar item.
14941 * @return Item's menu object or @c NULL on failure.
14943 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14944 * this function will set it.
14946 * @see elm_toolbar_item_menu_set() for details.
14950 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14953 * Add a new state to @p item.
14955 * @param item The item.
14956 * @param icon A string with icon name or the absolute path of an image file.
14957 * @param label The label of the new state.
14958 * @param func The function to call when the item is clicked when this
14959 * state is selected.
14960 * @param data The data to associate with the state.
14961 * @return The toolbar item state, or @c NULL upon failure.
14963 * Toolbar will load icon image from fdo or current theme.
14964 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14965 * If an absolute path is provided it will load it direct from a file.
14967 * States created with this function can be removed with
14968 * elm_toolbar_item_state_del().
14970 * @see elm_toolbar_item_state_del()
14971 * @see elm_toolbar_item_state_sel()
14972 * @see elm_toolbar_item_state_get()
14976 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);
14979 * Delete a previoulsy added state to @p item.
14981 * @param item The toolbar item.
14982 * @param state The state to be deleted.
14983 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14985 * @see elm_toolbar_item_state_add()
14987 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14990 * Set @p state as the current state of @p it.
14992 * @param it The item.
14993 * @param state The state to use.
14994 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14996 * If @p state is @c NULL, it won't select any state and the default item's
14997 * icon and label will be used. It's the same behaviour than
14998 * elm_toolbar_item_state_unser().
15000 * @see elm_toolbar_item_state_unset()
15004 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15007 * Unset the state of @p it.
15009 * @param it The item.
15011 * The default icon and label from this item will be displayed.
15013 * @see elm_toolbar_item_state_set() for more details.
15017 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15020 * Get the current state of @p it.
15022 * @param item The item.
15023 * @return The selected state or @c NULL if none is selected or on failure.
15025 * @see elm_toolbar_item_state_set() for details.
15026 * @see elm_toolbar_item_state_unset()
15027 * @see elm_toolbar_item_state_add()
15031 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15034 * Get the state after selected state in toolbar's @p item.
15036 * @param it The toolbar item to change state.
15037 * @return The state after current state, or @c NULL on failure.
15039 * If last state is selected, this function will return first state.
15041 * @see elm_toolbar_item_state_set()
15042 * @see elm_toolbar_item_state_add()
15046 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15049 * Get the state before selected state in toolbar's @p item.
15051 * @param it The toolbar item to change state.
15052 * @return The state before current state, or @c NULL on failure.
15054 * If first state is selected, this function will return last state.
15056 * @see elm_toolbar_item_state_set()
15057 * @see elm_toolbar_item_state_add()
15061 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15064 * Set the text to be shown in a given toolbar item's tooltips.
15066 * @param item Target item.
15067 * @param text The text to set in the content.
15069 * Setup the text as tooltip to object. The item can have only one tooltip,
15070 * so any previous tooltip data - set with this function or
15071 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15073 * @see elm_object_tooltip_text_set() for more details.
15077 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15080 * Set the content to be shown in the tooltip item.
15082 * Setup the tooltip to item. The item can have only one tooltip,
15083 * so any previous tooltip data is removed. @p func(with @p data) will
15084 * be called every time that need show the tooltip and it should
15085 * return a valid Evas_Object. This object is then managed fully by
15086 * tooltip system and is deleted when the tooltip is gone.
15088 * @param item the toolbar item being attached a tooltip.
15089 * @param func the function used to create the tooltip contents.
15090 * @param data what to provide to @a func as callback data/context.
15091 * @param del_cb called when data is not needed anymore, either when
15092 * another callback replaces @a func, the tooltip is unset with
15093 * elm_toolbar_item_tooltip_unset() or the owner @a item
15094 * dies. This callback receives as the first parameter the
15095 * given @a data, and @c event_info is the item.
15097 * @see elm_object_tooltip_content_cb_set() for more details.
15101 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);
15104 * Unset tooltip from item.
15106 * @param item toolbar item to remove previously set tooltip.
15108 * Remove tooltip from item. The callback provided as del_cb to
15109 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15110 * it is not used anymore.
15112 * @see elm_object_tooltip_unset() for more details.
15113 * @see elm_toolbar_item_tooltip_content_cb_set()
15117 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15120 * Sets a different style for this item tooltip.
15122 * @note before you set a style you should define a tooltip with
15123 * elm_toolbar_item_tooltip_content_cb_set() or
15124 * elm_toolbar_item_tooltip_text_set()
15126 * @param item toolbar item with tooltip already set.
15127 * @param style the theme style to use (default, transparent, ...)
15129 * @see elm_object_tooltip_style_set() for more details.
15133 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15136 * Get the style for this item tooltip.
15138 * @param item toolbar item with tooltip already set.
15139 * @return style the theme style in use, defaults to "default". If the
15140 * object does not have a tooltip set, then NULL is returned.
15142 * @see elm_object_tooltip_style_get() for more details.
15143 * @see elm_toolbar_item_tooltip_style_set()
15147 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15150 * Set the type of mouse pointer/cursor decoration to be shown,
15151 * when the mouse pointer is over the given toolbar widget item
15153 * @param item toolbar item to customize cursor on
15154 * @param cursor the cursor type's name
15156 * This function works analogously as elm_object_cursor_set(), but
15157 * here the cursor's changing area is restricted to the item's
15158 * area, and not the whole widget's. Note that that item cursors
15159 * have precedence over widget cursors, so that a mouse over an
15160 * item with custom cursor set will always show @b that cursor.
15162 * If this function is called twice for an object, a previously set
15163 * cursor will be unset on the second call.
15165 * @see elm_object_cursor_set()
15166 * @see elm_toolbar_item_cursor_get()
15167 * @see elm_toolbar_item_cursor_unset()
15171 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15174 * Get the type of mouse pointer/cursor decoration set to be shown,
15175 * when the mouse pointer is over the given toolbar widget item
15177 * @param item toolbar item with custom cursor set
15178 * @return the cursor type's name or @c NULL, if no custom cursors
15179 * were set to @p item (and on errors)
15181 * @see elm_object_cursor_get()
15182 * @see elm_toolbar_item_cursor_set()
15183 * @see elm_toolbar_item_cursor_unset()
15187 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15190 * Unset any custom mouse pointer/cursor decoration set to be
15191 * shown, when the mouse pointer is over the given toolbar widget
15192 * item, thus making it show the @b default cursor again.
15194 * @param item a toolbar item
15196 * Use this call to undo any custom settings on this item's cursor
15197 * decoration, bringing it back to defaults (no custom style set).
15199 * @see elm_object_cursor_unset()
15200 * @see elm_toolbar_item_cursor_set()
15204 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15207 * Set a different @b style for a given custom cursor set for a
15210 * @param item toolbar item with custom cursor set
15211 * @param style the <b>theme style</b> to use (e.g. @c "default",
15212 * @c "transparent", etc)
15214 * This function only makes sense when one is using custom mouse
15215 * cursor decorations <b>defined in a theme file</b>, which can have,
15216 * given a cursor name/type, <b>alternate styles</b> on it. It
15217 * works analogously as elm_object_cursor_style_set(), but here
15218 * applyed only to toolbar item objects.
15220 * @warning Before you set a cursor style you should have definen a
15221 * custom cursor previously on the item, with
15222 * elm_toolbar_item_cursor_set()
15224 * @see elm_toolbar_item_cursor_engine_only_set()
15225 * @see elm_toolbar_item_cursor_style_get()
15229 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15232 * Get the current @b style set for a given toolbar item's custom
15235 * @param item toolbar item with custom cursor set.
15236 * @return style the cursor style in use. If the object does not
15237 * have a cursor set, then @c NULL is returned.
15239 * @see elm_toolbar_item_cursor_style_set() for more details
15243 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15246 * Set if the (custom)cursor for a given toolbar item should be
15247 * searched in its theme, also, or should only rely on the
15248 * rendering engine.
15250 * @param item item with custom (custom) cursor already set on
15251 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15252 * only on those provided by the rendering engine, @c EINA_FALSE to
15253 * have them searched on the widget's theme, as well.
15255 * @note This call is of use only if you've set a custom cursor
15256 * for toolbar items, with elm_toolbar_item_cursor_set().
15258 * @note By default, cursors will only be looked for between those
15259 * provided by the rendering engine.
15263 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15266 * Get if the (custom) cursor for a given toolbar item is being
15267 * searched in its theme, also, or is only relying on the rendering
15270 * @param item a toolbar item
15271 * @return @c EINA_TRUE, if cursors are being looked for only on
15272 * those provided by the rendering engine, @c EINA_FALSE if they
15273 * are being searched on the widget's theme, as well.
15275 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15279 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15282 * Change a toolbar's orientation
15283 * @param obj The toolbar object
15284 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15285 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15287 * @deprecated use elm_toolbar_horizontal_set() instead.
15289 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15292 * Change a toolbar's orientation
15293 * @param obj The toolbar object
15294 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15295 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15298 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15301 * Get a toolbar's orientation
15302 * @param obj The toolbar object
15303 * @return If @c EINA_TRUE, the toolbar is vertical
15304 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15306 * @deprecated use elm_toolbar_horizontal_get() instead.
15308 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15311 * Get a toolbar's orientation
15312 * @param obj The toolbar object
15313 * @return If @c EINA_TRUE, the toolbar is horizontal
15314 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15317 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15323 * @defgroup Tooltips Tooltips
15325 * The Tooltip is an (internal, for now) smart object used to show a
15326 * content in a frame on mouse hover of objects(or widgets), with
15327 * tips/information about them.
15332 EAPI double elm_tooltip_delay_get(void);
15333 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15334 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15335 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15336 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15337 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);
15338 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15339 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15340 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15343 * @defgroup Cursors Cursors
15345 * The Elementary cursor is an internal smart object used to
15346 * customize the mouse cursor displayed over objects (or
15347 * widgets). In the most common scenario, the cursor decoration
15348 * comes from the graphical @b engine Elementary is running
15349 * on. Those engines may provide different decorations for cursors,
15350 * and Elementary provides functions to choose them (think of X11
15351 * cursors, as an example).
15353 * There's also the possibility of, besides using engine provided
15354 * cursors, also use ones coming from Edje theming files. Both
15355 * globally and per widget, Elementary makes it possible for one to
15356 * make the cursors lookup to be held on engines only or on
15357 * Elementary's theme file, too. To set cursor's hot spot,
15358 * two data items should be added to cursor's theme: "hot_x" and
15359 * "hot_y", that are the offset from upper-left corner of the cursor
15360 * (coordinates 0,0).
15366 * Set the cursor to be shown when mouse is over the object
15368 * Set the cursor that will be displayed when mouse is over the
15369 * object. The object can have only one cursor set to it, so if
15370 * this function is called twice for an object, the previous set
15372 * If using X cursors, a definition of all the valid cursor names
15373 * is listed on Elementary_Cursors.h. If an invalid name is set
15374 * the default cursor will be used.
15376 * @param obj the object being set a cursor.
15377 * @param cursor the cursor name to be used.
15381 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15384 * Get the cursor to be shown when mouse is over the object
15386 * @param obj an object with cursor already set.
15387 * @return the cursor name.
15391 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15394 * Unset cursor for object
15396 * Unset cursor for object, and set the cursor to default if the mouse
15397 * was over this object.
15399 * @param obj Target object
15400 * @see elm_object_cursor_set()
15404 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15407 * Sets a different style for this object cursor.
15409 * @note before you set a style you should define a cursor with
15410 * elm_object_cursor_set()
15412 * @param obj an object with cursor already set.
15413 * @param style the theme style to use (default, transparent, ...)
15417 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15420 * Get the style for this object cursor.
15422 * @param obj an object with cursor already set.
15423 * @return style the theme style in use, defaults to "default". If the
15424 * object does not have a cursor set, then NULL is returned.
15428 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15431 * Set if the cursor set should be searched on the theme or should use
15432 * the provided by the engine, only.
15434 * @note before you set if should look on theme you should define a cursor
15435 * with elm_object_cursor_set(). By default it will only look for cursors
15436 * provided by the engine.
15438 * @param obj an object with cursor already set.
15439 * @param engine_only boolean to define it cursors should be looked only
15440 * between the provided by the engine or searched on widget's theme as well.
15444 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15447 * Get the cursor engine only usage for this object cursor.
15449 * @param obj an object with cursor already set.
15450 * @return engine_only boolean to define it cursors should be
15451 * looked only between the provided by the engine or searched on
15452 * widget's theme as well. If the object does not have a cursor
15453 * set, then EINA_FALSE is returned.
15457 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15460 * Get the configured cursor engine only usage
15462 * This gets the globally configured exclusive usage of engine cursors.
15464 * @return 1 if only engine cursors should be used
15467 EAPI int elm_cursor_engine_only_get(void);
15470 * Set the configured cursor engine only usage
15472 * This sets the globally configured exclusive usage of engine cursors.
15473 * It won't affect cursors set before changing this value.
15475 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15476 * look for them on theme before.
15477 * @return EINA_TRUE if value is valid and setted (0 or 1)
15480 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15487 * @defgroup Menu Menu
15489 * @image html img/widget/menu/preview-00.png
15490 * @image latex img/widget/menu/preview-00.eps
15492 * A menu is a list of items displayed above its parent. When the menu is
15493 * showing its parent is darkened. Each item can have a sub-menu. The menu
15494 * object can be used to display a menu on a right click event, in a toolbar,
15497 * Signals that you can add callbacks for are:
15498 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15499 * event_info is NULL.
15501 * @see @ref tutorial_menu
15504 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15506 * @brief Add a new menu to the parent
15508 * @param parent The parent object.
15509 * @return The new object or NULL if it cannot be created.
15511 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15513 * @brief Set the parent for the given menu widget
15515 * @param obj The menu object.
15516 * @param parent The new parent.
15518 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15520 * @brief Get the parent for the given menu widget
15522 * @param obj The menu object.
15523 * @return The parent.
15525 * @see elm_menu_parent_set()
15527 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15529 * @brief Move the menu to a new position
15531 * @param obj The menu object.
15532 * @param x The new position.
15533 * @param y The new position.
15535 * Sets the top-left position of the menu to (@p x,@p y).
15537 * @note @p x and @p y coordinates are relative to parent.
15539 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15541 * @brief Close a opened menu
15543 * @param obj the menu object
15546 * Hides the menu and all it's sub-menus.
15548 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15550 * @brief Returns a list of @p item's items.
15552 * @param obj The menu object
15553 * @return An Eina_List* of @p item's items
15555 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15557 * @brief Get the Evas_Object of an Elm_Menu_Item
15559 * @param item The menu item object.
15560 * @return The edje object containing the swallowed content
15562 * @warning Don't manipulate this object!
15564 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15566 * @brief Add an item at the end of the given menu widget
15568 * @param obj The menu object.
15569 * @param parent The parent menu item (optional)
15570 * @param icon A icon display on the item. The icon will be destryed by the menu.
15571 * @param label The label of the item.
15572 * @param func Function called when the user select the item.
15573 * @param data Data sent by the callback.
15574 * @return Returns the new item.
15576 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);
15578 * @brief Set the label of a menu item
15580 * @param item The menu item object.
15581 * @param label The label to set for @p item
15583 * @warning Don't use this funcion on items created with
15584 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15586 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15588 * @brief Get the label of a menu item
15590 * @param item The menu item object.
15591 * @return The label of @p item
15593 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15594 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15595 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15596 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15599 * @brief Set the selected state of @p item.
15601 * @param item The menu item object.
15602 * @param selected The selected/unselected state of the item
15604 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15606 * @brief Get the selected state of @p item.
15608 * @param item The menu item object.
15609 * @return The selected/unselected state of the item
15611 * @see elm_menu_item_selected_set()
15613 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15615 * @brief Set the disabled state of @p item.
15617 * @param item The menu item object.
15618 * @param disabled The enabled/disabled state of the item
15620 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15622 * @brief Get the disabled state of @p item.
15624 * @param item The menu item object.
15625 * @return The enabled/disabled state of the item
15627 * @see elm_menu_item_disabled_set()
15629 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15631 * @brief Add a separator item to menu @p obj under @p parent.
15633 * @param obj The menu object
15634 * @param parent The item to add the separator under
15635 * @return The created item or NULL on failure
15637 * This is item is a @ref Separator.
15639 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15641 * @brief Returns whether @p item is a separator.
15643 * @param item The item to check
15644 * @return If true, @p item is a separator
15646 * @see elm_menu_item_separator_add()
15648 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15650 * @brief Deletes an item from the menu.
15652 * @param item The item to delete.
15654 * @see elm_menu_item_add()
15656 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15658 * @brief Set the function called when a menu item is deleted.
15660 * @param item The item to set the callback on
15661 * @param func The function called
15663 * @see elm_menu_item_add()
15664 * @see elm_menu_item_del()
15666 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15668 * @brief Returns the data associated with menu item @p item.
15670 * @param item The item
15671 * @return The data associated with @p item or NULL if none was set.
15673 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15675 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15677 * @brief Sets the data to be associated with menu item @p item.
15679 * @param item The item
15680 * @param data The data to be associated with @p item
15682 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15684 * @brief Returns a list of @p item's subitems.
15686 * @param item The item
15687 * @return An Eina_List* of @p item's subitems
15689 * @see elm_menu_add()
15691 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15692 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15693 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15694 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15695 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15696 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15703 * @defgroup List List
15704 * @ingroup Elementary
15706 * @image html img/widget/list/preview-00.png
15707 * @image latex img/widget/list/preview-00.eps width=\textwidth
15709 * @image html img/list.png
15710 * @image latex img/list.eps width=\textwidth
15712 * A list widget is a container whose children are displayed vertically or
15713 * horizontally, in order, and can be selected.
15714 * The list can accept only one or multiple items selection. Also has many
15715 * modes of items displaying.
15717 * A list is a very simple type of list widget. For more robust
15718 * lists, @ref Genlist should probably be used.
15720 * Smart callbacks one can listen to:
15721 * - @c "activated" - The user has double-clicked or pressed
15722 * (enter|return|spacebar) on an item. The @c event_info parameter
15723 * is the item that was activated.
15724 * - @c "clicked,double" - The user has double-clicked an item.
15725 * The @c event_info parameter is the item that was double-clicked.
15726 * - "selected" - when the user selected an item
15727 * - "unselected" - when the user unselected an item
15728 * - "longpressed" - an item in the list is long-pressed
15729 * - "edge,top" - the list is scrolled until the top edge
15730 * - "edge,bottom" - the list is scrolled until the bottom edge
15731 * - "edge,left" - the list is scrolled until the left edge
15732 * - "edge,right" - the list is scrolled until the right edge
15733 * - "language,changed" - the program's language changed
15735 * Available styles for it:
15738 * List of examples:
15739 * @li @ref list_example_01
15740 * @li @ref list_example_02
15741 * @li @ref list_example_03
15750 * @enum _Elm_List_Mode
15751 * @typedef Elm_List_Mode
15753 * Set list's resize behavior, transverse axis scroll and
15754 * items cropping. See each mode's description for more details.
15756 * @note Default value is #ELM_LIST_SCROLL.
15758 * Values <b> don't </b> work as bitmask, only one can be choosen.
15760 * @see elm_list_mode_set()
15761 * @see elm_list_mode_get()
15765 typedef enum _Elm_List_Mode
15767 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. */
15768 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). */
15769 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. */
15770 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. */
15771 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15774 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(). */
15777 * Add a new list widget to the given parent Elementary
15778 * (container) object.
15780 * @param parent The parent object.
15781 * @return a new list widget handle or @c NULL, on errors.
15783 * This function inserts a new list widget on the canvas.
15787 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15792 * @param obj The list object
15794 * @note Call before running show() on the list object.
15795 * @warning If not called, it won't display the list properly.
15798 * li = elm_list_add(win);
15799 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15800 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15802 * evas_object_show(li);
15807 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15810 * Enable or disable multiple items selection on the list object.
15812 * @param obj The list object
15813 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15816 * Disabled by default. If disabled, the user can select a single item of
15817 * the list each time. Selected items are highlighted on list.
15818 * If enabled, many items can be selected.
15820 * If a selected item is selected again, it will be unselected.
15822 * @see elm_list_multi_select_get()
15826 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15829 * Get a value whether multiple items selection is enabled or not.
15831 * @see elm_list_multi_select_set() for details.
15833 * @param obj The list object.
15834 * @return @c EINA_TRUE means multiple items selection is enabled.
15835 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15836 * @c EINA_FALSE is returned.
15840 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15843 * Set which mode to use for the list object.
15845 * @param obj The list object
15846 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15847 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15849 * Set list's resize behavior, transverse axis scroll and
15850 * items cropping. See each mode's description for more details.
15852 * @note Default value is #ELM_LIST_SCROLL.
15854 * Only one can be set, if a previous one was set, it will be changed
15855 * by the new mode set. Bitmask won't work as well.
15857 * @see elm_list_mode_get()
15861 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15864 * Get the mode the list is at.
15866 * @param obj The list object
15867 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15868 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15870 * @note see elm_list_mode_set() for more information.
15874 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15877 * Enable or disable horizontal mode on the list object.
15879 * @param obj The list object.
15880 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15881 * disable it, i.e., to enable vertical mode.
15883 * @note Vertical mode is set by default.
15885 * On horizontal mode items are displayed on list from left to right,
15886 * instead of from top to bottom. Also, the list will scroll horizontally.
15887 * Each item will presents left icon on top and right icon, or end, at
15890 * @see elm_list_horizontal_get()
15894 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15897 * Get a value whether horizontal mode is enabled or not.
15899 * @param obj The list object.
15900 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15901 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15902 * @c EINA_FALSE is returned.
15904 * @see elm_list_horizontal_set() for details.
15908 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15911 * Enable or disable always select mode on the list object.
15913 * @param obj The list object
15914 * @param always_select @c EINA_TRUE to enable always select mode or
15915 * @c EINA_FALSE to disable it.
15917 * @note Always select mode is disabled by default.
15919 * Default behavior of list items is to only call its callback function
15920 * the first time it's pressed, i.e., when it is selected. If a selected
15921 * item is pressed again, and multi-select is disabled, it won't call
15922 * this function (if multi-select is enabled it will unselect the item).
15924 * If always select is enabled, it will call the callback function
15925 * everytime a item is pressed, so it will call when the item is selected,
15926 * and again when a selected item is pressed.
15928 * @see elm_list_always_select_mode_get()
15929 * @see elm_list_multi_select_set()
15933 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15936 * Get a value whether always select mode is enabled or not, meaning that
15937 * an item will always call its callback function, even if already selected.
15939 * @param obj The list object
15940 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15941 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15942 * @c EINA_FALSE is returned.
15944 * @see elm_list_always_select_mode_set() for details.
15948 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15951 * Set bouncing behaviour when the scrolled content reaches an edge.
15953 * Tell the internal scroller object whether it should bounce or not
15954 * when it reaches the respective edges for each axis.
15956 * @param obj The list object
15957 * @param h_bounce Whether to bounce or not in the horizontal axis.
15958 * @param v_bounce Whether to bounce or not in the vertical axis.
15960 * @see elm_scroller_bounce_set()
15964 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15967 * Get the bouncing behaviour of the internal scroller.
15969 * Get whether the internal scroller should bounce when the edge of each
15970 * axis is reached scrolling.
15972 * @param obj The list object.
15973 * @param h_bounce Pointer where to store the bounce state of the horizontal
15975 * @param v_bounce Pointer where to store the bounce state of the vertical
15978 * @see elm_scroller_bounce_get()
15979 * @see elm_list_bounce_set()
15983 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15986 * Set the scrollbar policy.
15988 * @param obj The list object
15989 * @param policy_h Horizontal scrollbar policy.
15990 * @param policy_v Vertical scrollbar policy.
15992 * This sets the scrollbar visibility policy for the given scroller.
15993 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15994 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15995 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15996 * This applies respectively for the horizontal and vertical scrollbars.
15998 * The both are disabled by default, i.e., are set to
15999 * #ELM_SCROLLER_POLICY_OFF.
16003 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16006 * Get the scrollbar policy.
16008 * @see elm_list_scroller_policy_get() for details.
16010 * @param obj The list object.
16011 * @param policy_h Pointer where to store horizontal scrollbar policy.
16012 * @param policy_v Pointer where to store vertical scrollbar policy.
16016 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);
16019 * Append a new item to the list object.
16021 * @param obj The list object.
16022 * @param label The label of the list item.
16023 * @param icon The icon object to use for the left side of the item. An
16024 * icon can be any Evas object, but usually it is an icon created
16025 * with elm_icon_add().
16026 * @param end The icon object to use for the right side of the item. An
16027 * icon can be any Evas object.
16028 * @param func The function to call when the item is clicked.
16029 * @param data The data to associate with the item for related callbacks.
16031 * @return The created item or @c NULL upon failure.
16033 * A new item will be created and appended to the list, i.e., will
16034 * be set as @b last item.
16036 * Items created with this method can be deleted with
16037 * elm_list_item_del().
16039 * Associated @p data can be properly freed when item is deleted if a
16040 * callback function is set with elm_list_item_del_cb_set().
16042 * If a function is passed as argument, it will be called everytime this item
16043 * is selected, i.e., the user clicks over an unselected item.
16044 * If always select is enabled it will call this function every time
16045 * user clicks over an item (already selected or not).
16046 * If such function isn't needed, just passing
16047 * @c NULL as @p func is enough. The same should be done for @p data.
16049 * Simple example (with no function callback or data associated):
16051 * li = elm_list_add(win);
16052 * ic = elm_icon_add(win);
16053 * elm_icon_file_set(ic, "path/to/image", NULL);
16054 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16055 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16057 * evas_object_show(li);
16060 * @see elm_list_always_select_mode_set()
16061 * @see elm_list_item_del()
16062 * @see elm_list_item_del_cb_set()
16063 * @see elm_list_clear()
16064 * @see elm_icon_add()
16068 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);
16071 * Prepend a new item to the list object.
16073 * @param obj The list object.
16074 * @param label The label of the list item.
16075 * @param icon The icon object to use for the left side of the item. An
16076 * icon can be any Evas object, but usually it is an icon created
16077 * with elm_icon_add().
16078 * @param end The icon object to use for the right side of the item. An
16079 * icon can be any Evas object.
16080 * @param func The function to call when the item is clicked.
16081 * @param data The data to associate with the item for related callbacks.
16083 * @return The created item or @c NULL upon failure.
16085 * A new item will be created and prepended to the list, i.e., will
16086 * be set as @b first item.
16088 * Items created with this method can be deleted with
16089 * elm_list_item_del().
16091 * Associated @p data can be properly freed when item is deleted if a
16092 * callback function is set with elm_list_item_del_cb_set().
16094 * If a function is passed as argument, it will be called everytime this item
16095 * is selected, i.e., the user clicks over an unselected item.
16096 * If always select is enabled it will call this function every time
16097 * user clicks over an item (already selected or not).
16098 * If such function isn't needed, just passing
16099 * @c NULL as @p func is enough. The same should be done for @p data.
16101 * @see elm_list_item_append() for a simple code example.
16102 * @see elm_list_always_select_mode_set()
16103 * @see elm_list_item_del()
16104 * @see elm_list_item_del_cb_set()
16105 * @see elm_list_clear()
16106 * @see elm_icon_add()
16110 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);
16113 * Insert a new item into the list object before item @p before.
16115 * @param obj The list object.
16116 * @param before The list item to insert before.
16117 * @param label The label of the list item.
16118 * @param icon The icon object to use for the left side of the item. An
16119 * icon can be any Evas object, but usually it is an icon created
16120 * with elm_icon_add().
16121 * @param end The icon object to use for the right side of the item. An
16122 * icon can be any Evas object.
16123 * @param func The function to call when the item is clicked.
16124 * @param data The data to associate with the item for related callbacks.
16126 * @return The created item or @c NULL upon failure.
16128 * A new item will be created and added to the list. Its position in
16129 * this list will be just before item @p before.
16131 * Items created with this method can be deleted with
16132 * elm_list_item_del().
16134 * Associated @p data can be properly freed when item is deleted if a
16135 * callback function is set with elm_list_item_del_cb_set().
16137 * If a function is passed as argument, it will be called everytime this item
16138 * is selected, i.e., the user clicks over an unselected item.
16139 * If always select is enabled it will call this function every time
16140 * user clicks over an item (already selected or not).
16141 * If such function isn't needed, just passing
16142 * @c NULL as @p func is enough. The same should be done for @p data.
16144 * @see elm_list_item_append() for a simple code example.
16145 * @see elm_list_always_select_mode_set()
16146 * @see elm_list_item_del()
16147 * @see elm_list_item_del_cb_set()
16148 * @see elm_list_clear()
16149 * @see elm_icon_add()
16153 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);
16156 * Insert a new item into the list object after item @p after.
16158 * @param obj The list object.
16159 * @param after The list item to insert after.
16160 * @param label The label of the list item.
16161 * @param icon The icon object to use for the left side of the item. An
16162 * icon can be any Evas object, but usually it is an icon created
16163 * with elm_icon_add().
16164 * @param end The icon object to use for the right side of the item. An
16165 * icon can be any Evas object.
16166 * @param func The function to call when the item is clicked.
16167 * @param data The data to associate with the item for related callbacks.
16169 * @return The created item or @c NULL upon failure.
16171 * A new item will be created and added to the list. Its position in
16172 * this list will be just after item @p after.
16174 * Items created with this method can be deleted with
16175 * elm_list_item_del().
16177 * Associated @p data can be properly freed when item is deleted if a
16178 * callback function is set with elm_list_item_del_cb_set().
16180 * If a function is passed as argument, it will be called everytime this item
16181 * is selected, i.e., the user clicks over an unselected item.
16182 * If always select is enabled it will call this function every time
16183 * user clicks over an item (already selected or not).
16184 * If such function isn't needed, just passing
16185 * @c NULL as @p func is enough. The same should be done for @p data.
16187 * @see elm_list_item_append() for a simple code example.
16188 * @see elm_list_always_select_mode_set()
16189 * @see elm_list_item_del()
16190 * @see elm_list_item_del_cb_set()
16191 * @see elm_list_clear()
16192 * @see elm_icon_add()
16196 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);
16199 * Insert a new item into the sorted list object.
16201 * @param obj The list object.
16202 * @param label The label of the list item.
16203 * @param icon The icon object to use for the left side of the item. An
16204 * icon can be any Evas object, but usually it is an icon created
16205 * with elm_icon_add().
16206 * @param end The icon object to use for the right side of the item. An
16207 * icon can be any Evas object.
16208 * @param func The function to call when the item is clicked.
16209 * @param data The data to associate with the item for related callbacks.
16210 * @param cmp_func The comparing function to be used to sort list
16211 * items <b>by #Elm_List_Item item handles</b>. This function will
16212 * receive two items and compare them, returning a non-negative integer
16213 * if the second item should be place after the first, or negative value
16214 * if should be placed before.
16216 * @return The created item or @c NULL upon failure.
16218 * @note This function inserts values into a list object assuming it was
16219 * sorted and the result will be sorted.
16221 * A new item will be created and added to the list. Its position in
16222 * this list will be found comparing the new item with previously inserted
16223 * items using function @p cmp_func.
16225 * Items created with this method can be deleted with
16226 * elm_list_item_del().
16228 * Associated @p data can be properly freed when item is deleted if a
16229 * callback function is set with elm_list_item_del_cb_set().
16231 * If a function is passed as argument, it will be called everytime this item
16232 * is selected, i.e., the user clicks over an unselected item.
16233 * If always select is enabled it will call this function every time
16234 * user clicks over an item (already selected or not).
16235 * If such function isn't needed, just passing
16236 * @c NULL as @p func is enough. The same should be done for @p data.
16238 * @see elm_list_item_append() for a simple code example.
16239 * @see elm_list_always_select_mode_set()
16240 * @see elm_list_item_del()
16241 * @see elm_list_item_del_cb_set()
16242 * @see elm_list_clear()
16243 * @see elm_icon_add()
16247 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);
16250 * Remove all list's items.
16252 * @param obj The list object
16254 * @see elm_list_item_del()
16255 * @see elm_list_item_append()
16259 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16262 * Get a list of all the list items.
16264 * @param obj The list object
16265 * @return An @c Eina_List of list items, #Elm_List_Item,
16266 * or @c NULL on failure.
16268 * @see elm_list_item_append()
16269 * @see elm_list_item_del()
16270 * @see elm_list_clear()
16274 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16277 * Get the selected item.
16279 * @param obj The list object.
16280 * @return The selected list item.
16282 * The selected item can be unselected with function
16283 * elm_list_item_selected_set().
16285 * The selected item always will be highlighted on list.
16287 * @see elm_list_selected_items_get()
16291 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16294 * Return a list of the currently selected list items.
16296 * @param obj The list object.
16297 * @return An @c Eina_List of list items, #Elm_List_Item,
16298 * or @c NULL on failure.
16300 * Multiple items can be selected if multi select is enabled. It can be
16301 * done with elm_list_multi_select_set().
16303 * @see elm_list_selected_item_get()
16304 * @see elm_list_multi_select_set()
16308 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16311 * Set the selected state of an item.
16313 * @param item The list item
16314 * @param selected The selected state
16316 * This sets the selected state of the given item @p it.
16317 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16319 * If a new item is selected the previosly selected will be unselected,
16320 * unless multiple selection is enabled with elm_list_multi_select_set().
16321 * Previoulsy selected item can be get with function
16322 * elm_list_selected_item_get().
16324 * Selected items will be highlighted.
16326 * @see elm_list_item_selected_get()
16327 * @see elm_list_selected_item_get()
16328 * @see elm_list_multi_select_set()
16332 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16335 * Get whether the @p item is selected or not.
16337 * @param item The list item.
16338 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16339 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16341 * @see elm_list_selected_item_set() for details.
16342 * @see elm_list_item_selected_get()
16346 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16349 * Set or unset item as a separator.
16351 * @param it The list item.
16352 * @param setting @c EINA_TRUE to set item @p it as separator or
16353 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16355 * Items aren't set as separator by default.
16357 * If set as separator it will display separator theme, so won't display
16360 * @see elm_list_item_separator_get()
16364 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16367 * Get a value whether item is a separator or not.
16369 * @see elm_list_item_separator_set() for details.
16371 * @param it The list item.
16372 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16373 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16377 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16380 * Show @p item in the list view.
16382 * @param item The list item to be shown.
16384 * It won't animate list until item is visible. If such behavior is wanted,
16385 * use elm_list_bring_in() intead.
16389 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16392 * Bring in the given item to list view.
16394 * @param item The item.
16396 * This causes list to jump to the given item @p item and show it
16397 * (by scrolling), if it is not fully visible.
16399 * This may use animation to do so and take a period of time.
16401 * If animation isn't wanted, elm_list_item_show() can be used.
16405 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16408 * Delete them item from the list.
16410 * @param item The item of list to be deleted.
16412 * If deleting all list items is required, elm_list_clear()
16413 * should be used instead of getting items list and deleting each one.
16415 * @see elm_list_clear()
16416 * @see elm_list_item_append()
16417 * @see elm_list_item_del_cb_set()
16421 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16424 * Set the function called when a list item is freed.
16426 * @param item The item to set the callback on
16427 * @param func The function called
16429 * If there is a @p func, then it will be called prior item's memory release.
16430 * That will be called with the following arguments:
16432 * @li item's Evas object;
16435 * This way, a data associated to a list item could be properly freed.
16439 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16442 * Get the data associated to the item.
16444 * @param item The list item
16445 * @return The data associated to @p item
16447 * The return value is a pointer to data associated to @p item when it was
16448 * created, with function elm_list_item_append() or similar. If no data
16449 * was passed as argument, it will return @c NULL.
16451 * @see elm_list_item_append()
16455 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16458 * Get the left side icon associated to the item.
16460 * @param item The list item
16461 * @return The left side icon associated to @p item
16463 * The return value is a pointer to the icon associated to @p item when
16465 * created, with function elm_list_item_append() or similar, or later
16466 * with function elm_list_item_icon_set(). If no icon
16467 * was passed as argument, it will return @c NULL.
16469 * @see elm_list_item_append()
16470 * @see elm_list_item_icon_set()
16474 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16477 * Set the left side icon associated to the item.
16479 * @param item The list item
16480 * @param icon The left side icon object to associate with @p item
16482 * The icon object to use at left side of the item. An
16483 * icon can be any Evas object, but usually it is an icon created
16484 * with elm_icon_add().
16486 * Once the icon object is set, a previously set one will be deleted.
16487 * @warning Setting the same icon for two items will cause the icon to
16488 * dissapear from the first item.
16490 * If an icon was passed as argument on item creation, with function
16491 * elm_list_item_append() or similar, it will be already
16492 * associated to the item.
16494 * @see elm_list_item_append()
16495 * @see elm_list_item_icon_get()
16499 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16502 * Get the right side icon associated to the item.
16504 * @param item The list item
16505 * @return The right side icon associated to @p item
16507 * The return value is a pointer to the icon associated to @p item when
16509 * created, with function elm_list_item_append() or similar, or later
16510 * with function elm_list_item_icon_set(). If no icon
16511 * was passed as argument, it will return @c NULL.
16513 * @see elm_list_item_append()
16514 * @see elm_list_item_icon_set()
16518 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16521 * Set the right side icon associated to the item.
16523 * @param item The list item
16524 * @param end The right side icon object to associate with @p item
16526 * The icon object to use at right side of the item. An
16527 * icon can be any Evas object, but usually it is an icon created
16528 * with elm_icon_add().
16530 * Once the icon object is set, a previously set one will be deleted.
16531 * @warning Setting the same icon for two items will cause the icon to
16532 * dissapear from the first item.
16534 * If an icon was passed as argument on item creation, with function
16535 * elm_list_item_append() or similar, it will be already
16536 * associated to the item.
16538 * @see elm_list_item_append()
16539 * @see elm_list_item_end_get()
16543 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16544 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16547 * Gets the base object of the item.
16549 * @param item The list item
16550 * @return The base object associated with @p item
16552 * Base object is the @c Evas_Object that represents that item.
16556 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16559 * Get the label of item.
16561 * @param item The item of list.
16562 * @return The label of item.
16564 * The return value is a pointer to the label associated to @p item when
16565 * it was created, with function elm_list_item_append(), or later
16566 * with function elm_list_item_label_set. If no label
16567 * was passed as argument, it will return @c NULL.
16569 * @see elm_list_item_label_set() for more details.
16570 * @see elm_list_item_append()
16574 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16577 * Set the label of item.
16579 * @param item The item of list.
16580 * @param text The label of item.
16582 * The label to be displayed by the item.
16583 * Label will be placed between left and right side icons (if set).
16585 * If a label was passed as argument on item creation, with function
16586 * elm_list_item_append() or similar, it will be already
16587 * displayed by the item.
16589 * @see elm_list_item_label_get()
16590 * @see elm_list_item_append()
16594 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16598 * Get the item before @p it in list.
16600 * @param it The list item.
16601 * @return The item before @p it, or @c NULL if none or on failure.
16603 * @note If it is the first item, @c NULL will be returned.
16605 * @see elm_list_item_append()
16606 * @see elm_list_items_get()
16610 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16613 * Get the item after @p it in list.
16615 * @param it The list item.
16616 * @return The item after @p it, or @c NULL if none or on failure.
16618 * @note If it is the last item, @c NULL will be returned.
16620 * @see elm_list_item_append()
16621 * @see elm_list_items_get()
16625 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16628 * Sets the disabled/enabled state of a list item.
16630 * @param it The item.
16631 * @param disabled The disabled state.
16633 * A disabled item cannot be selected or unselected. It will also
16634 * change its appearance (generally greyed out). This sets the
16635 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16640 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16643 * Get a value whether list item is disabled or not.
16645 * @param it The item.
16646 * @return The disabled state.
16648 * @see elm_list_item_disabled_set() for more details.
16652 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16655 * Set the text to be shown in a given list item's tooltips.
16657 * @param item Target item.
16658 * @param text The text to set in the content.
16660 * Setup the text as tooltip to object. The item can have only one tooltip,
16661 * so any previous tooltip data - set with this function or
16662 * elm_list_item_tooltip_content_cb_set() - is removed.
16664 * @see elm_object_tooltip_text_set() for more details.
16668 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16672 * @brief Disable size restrictions on an object's tooltip
16673 * @param item The tooltip's anchor object
16674 * @param disable If EINA_TRUE, size restrictions are disabled
16675 * @return EINA_FALSE on failure, EINA_TRUE on success
16677 * This function allows a tooltip to expand beyond its parant window's canvas.
16678 * It will instead be limited only by the size of the display.
16680 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16682 * @brief Retrieve size restriction state of an object's tooltip
16683 * @param obj The tooltip's anchor object
16684 * @return If EINA_TRUE, size restrictions are disabled
16686 * This function returns whether a tooltip is allowed to expand beyond
16687 * its parant window's canvas.
16688 * It will instead be limited only by the size of the display.
16690 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16693 * Set the content to be shown in the tooltip item.
16695 * Setup the tooltip to item. The item can have only one tooltip,
16696 * so any previous tooltip data is removed. @p func(with @p data) will
16697 * be called every time that need show the tooltip and it should
16698 * return a valid Evas_Object. This object is then managed fully by
16699 * tooltip system and is deleted when the tooltip is gone.
16701 * @param item the list item being attached a tooltip.
16702 * @param func the function used to create the tooltip contents.
16703 * @param data what to provide to @a func as callback data/context.
16704 * @param del_cb called when data is not needed anymore, either when
16705 * another callback replaces @a func, the tooltip is unset with
16706 * elm_list_item_tooltip_unset() or the owner @a item
16707 * dies. This callback receives as the first parameter the
16708 * given @a data, and @c event_info is the item.
16710 * @see elm_object_tooltip_content_cb_set() for more details.
16714 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);
16717 * Unset tooltip from item.
16719 * @param item list item to remove previously set tooltip.
16721 * Remove tooltip from item. The callback provided as del_cb to
16722 * elm_list_item_tooltip_content_cb_set() will be called to notify
16723 * it is not used anymore.
16725 * @see elm_object_tooltip_unset() for more details.
16726 * @see elm_list_item_tooltip_content_cb_set()
16730 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16733 * Sets a different style for this item tooltip.
16735 * @note before you set a style you should define a tooltip with
16736 * elm_list_item_tooltip_content_cb_set() or
16737 * elm_list_item_tooltip_text_set()
16739 * @param item list item with tooltip already set.
16740 * @param style the theme style to use (default, transparent, ...)
16742 * @see elm_object_tooltip_style_set() for more details.
16746 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16749 * Get the style for this item tooltip.
16751 * @param item list item with tooltip already set.
16752 * @return style the theme style in use, defaults to "default". If the
16753 * object does not have a tooltip set, then NULL is returned.
16755 * @see elm_object_tooltip_style_get() for more details.
16756 * @see elm_list_item_tooltip_style_set()
16760 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16763 * Set the type of mouse pointer/cursor decoration to be shown,
16764 * when the mouse pointer is over the given list widget item
16766 * @param item list item to customize cursor on
16767 * @param cursor the cursor type's name
16769 * This function works analogously as elm_object_cursor_set(), but
16770 * here the cursor's changing area is restricted to the item's
16771 * area, and not the whole widget's. Note that that item cursors
16772 * have precedence over widget cursors, so that a mouse over an
16773 * item with custom cursor set will always show @b that cursor.
16775 * If this function is called twice for an object, a previously set
16776 * cursor will be unset on the second call.
16778 * @see elm_object_cursor_set()
16779 * @see elm_list_item_cursor_get()
16780 * @see elm_list_item_cursor_unset()
16784 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16787 * Get the type of mouse pointer/cursor decoration set to be shown,
16788 * when the mouse pointer is over the given list widget item
16790 * @param item list item with custom cursor set
16791 * @return the cursor type's name or @c NULL, if no custom cursors
16792 * were set to @p item (and on errors)
16794 * @see elm_object_cursor_get()
16795 * @see elm_list_item_cursor_set()
16796 * @see elm_list_item_cursor_unset()
16800 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16803 * Unset any custom mouse pointer/cursor decoration set to be
16804 * shown, when the mouse pointer is over the given list widget
16805 * item, thus making it show the @b default cursor again.
16807 * @param item a list item
16809 * Use this call to undo any custom settings on this item's cursor
16810 * decoration, bringing it back to defaults (no custom style set).
16812 * @see elm_object_cursor_unset()
16813 * @see elm_list_item_cursor_set()
16817 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16820 * Set a different @b style for a given custom cursor set for a
16823 * @param item list item with custom cursor set
16824 * @param style the <b>theme style</b> to use (e.g. @c "default",
16825 * @c "transparent", etc)
16827 * This function only makes sense when one is using custom mouse
16828 * cursor decorations <b>defined in a theme file</b>, which can have,
16829 * given a cursor name/type, <b>alternate styles</b> on it. It
16830 * works analogously as elm_object_cursor_style_set(), but here
16831 * applyed only to list item objects.
16833 * @warning Before you set a cursor style you should have definen a
16834 * custom cursor previously on the item, with
16835 * elm_list_item_cursor_set()
16837 * @see elm_list_item_cursor_engine_only_set()
16838 * @see elm_list_item_cursor_style_get()
16842 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16845 * Get the current @b style set for a given list item's custom
16848 * @param item list item with custom cursor set.
16849 * @return style the cursor style in use. If the object does not
16850 * have a cursor set, then @c NULL is returned.
16852 * @see elm_list_item_cursor_style_set() for more details
16856 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16859 * Set if the (custom)cursor for a given list item should be
16860 * searched in its theme, also, or should only rely on the
16861 * rendering engine.
16863 * @param item item with custom (custom) cursor already set on
16864 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16865 * only on those provided by the rendering engine, @c EINA_FALSE to
16866 * have them searched on the widget's theme, as well.
16868 * @note This call is of use only if you've set a custom cursor
16869 * for list items, with elm_list_item_cursor_set().
16871 * @note By default, cursors will only be looked for between those
16872 * provided by the rendering engine.
16876 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16879 * Get if the (custom) cursor for a given list item is being
16880 * searched in its theme, also, or is only relying on the rendering
16883 * @param item a list item
16884 * @return @c EINA_TRUE, if cursors are being looked for only on
16885 * those provided by the rendering engine, @c EINA_FALSE if they
16886 * are being searched on the widget's theme, as well.
16888 * @see elm_list_item_cursor_engine_only_set(), for more details
16892 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16899 * @defgroup Slider Slider
16900 * @ingroup Elementary
16902 * @image html img/widget/slider/preview-00.png
16903 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16905 * The slider adds a dragable “slider” widget for selecting the value of
16906 * something within a range.
16908 * A slider can be horizontal or vertical. It can contain an Icon and has a
16909 * primary label as well as a units label (that is formatted with floating
16910 * point values and thus accepts a printf-style format string, like
16911 * “%1.2f units”. There is also an indicator string that may be somewhere
16912 * else (like on the slider itself) that also accepts a format string like
16913 * units. Label, Icon Unit and Indicator strings/objects are optional.
16915 * A slider may be inverted which means values invert, with high vales being
16916 * on the left or top and low values on the right or bottom (as opposed to
16917 * normally being low on the left or top and high on the bottom and right).
16919 * The slider should have its minimum and maximum values set by the
16920 * application with elm_slider_min_max_set() and value should also be set by
16921 * the application before use with elm_slider_value_set(). The span of the
16922 * slider is its length (horizontally or vertically). This will be scaled by
16923 * the object or applications scaling factor. At any point code can query the
16924 * slider for its value with elm_slider_value_get().
16926 * Smart callbacks one can listen to:
16927 * - "changed" - Whenever the slider value is changed by the user.
16928 * - "slider,drag,start" - dragging the slider indicator around has started.
16929 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16930 * - "delay,changed" - A short time after the value is changed by the user.
16931 * This will be called only when the user stops dragging for
16932 * a very short period or when they release their
16933 * finger/mouse, so it avoids possibly expensive reactions to
16934 * the value change.
16936 * Available styles for it:
16939 * Default contents parts of the slider widget that you can use for are:
16940 * @li "elm.swallow.icon" - A icon of the slider
16941 * @li "elm.swallow.end" - A end part content of the slider
16943 * Here is an example on its usage:
16944 * @li @ref slider_example
16947 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
16948 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
16951 * @addtogroup Slider
16956 * Add a new slider widget to the given parent Elementary
16957 * (container) object.
16959 * @param parent The parent object.
16960 * @return a new slider widget handle or @c NULL, on errors.
16962 * This function inserts a new slider widget on the canvas.
16966 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16969 * Set the label of a given slider widget
16971 * @param obj The progress bar object
16972 * @param label The text label string, in UTF-8
16975 * @deprecated use elm_object_text_set() instead.
16977 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16980 * Get the label of a given slider widget
16982 * @param obj The progressbar object
16983 * @return The text label string, in UTF-8
16986 * @deprecated use elm_object_text_get() instead.
16988 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16991 * Set the icon object of the slider object.
16993 * @param obj The slider object.
16994 * @param icon The icon object.
16996 * On horizontal mode, icon is placed at left, and on vertical mode,
16999 * @note Once the icon object is set, a previously set one will be deleted.
17000 * If you want to keep that old content object, use the
17001 * elm_slider_icon_unset() function.
17003 * @warning If the object being set does not have minimum size hints set,
17004 * it won't get properly displayed.
17007 * @deprecated use elm_object_content_set() instead.
17009 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17012 * Unset an icon set on a given slider widget.
17014 * @param obj The slider object.
17015 * @return The icon object that was being used, if any was set, or
17016 * @c NULL, otherwise (and on errors).
17018 * On horizontal mode, icon is placed at left, and on vertical mode,
17021 * This call will unparent and return the icon object which was set
17022 * for this widget, previously, on success.
17024 * @see elm_slider_icon_set() for more details
17025 * @see elm_slider_icon_get()
17026 * @deprecated use elm_object_content_unset() instead.
17030 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17033 * Retrieve the icon object set for a given slider widget.
17035 * @param obj The slider object.
17036 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17037 * otherwise (and on errors).
17039 * On horizontal mode, icon is placed at left, and on vertical mode,
17042 * @see elm_slider_icon_set() for more details
17043 * @see elm_slider_icon_unset()
17047 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17050 * Set the end object of the slider object.
17052 * @param obj The slider object.
17053 * @param end The end object.
17055 * On horizontal mode, end is placed at left, and on vertical mode,
17056 * placed at bottom.
17058 * @note Once the icon object is set, a previously set one will be deleted.
17059 * If you want to keep that old content object, use the
17060 * elm_slider_end_unset() function.
17062 * @warning If the object being set does not have minimum size hints set,
17063 * it won't get properly displayed.
17067 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17070 * Unset an end object set on a given slider widget.
17072 * @param obj The slider object.
17073 * @return The end object that was being used, if any was set, or
17074 * @c NULL, otherwise (and on errors).
17076 * On horizontal mode, end is placed at left, and on vertical mode,
17077 * placed at bottom.
17079 * This call will unparent and return the icon object which was set
17080 * for this widget, previously, on success.
17082 * @see elm_slider_end_set() for more details.
17083 * @see elm_slider_end_get()
17087 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17090 * Retrieve the end object set for a given slider widget.
17092 * @param obj The slider object.
17093 * @return The end object's handle, if @p obj had one set, or @c NULL,
17094 * otherwise (and on errors).
17096 * On horizontal mode, icon is placed at right, and on vertical mode,
17097 * placed at bottom.
17099 * @see elm_slider_end_set() for more details.
17100 * @see elm_slider_end_unset()
17104 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17107 * Set the (exact) length of the bar region of a given slider widget.
17109 * @param obj The slider object.
17110 * @param size The length of the slider's bar region.
17112 * This sets the minimum width (when in horizontal mode) or height
17113 * (when in vertical mode) of the actual bar area of the slider
17114 * @p obj. This in turn affects the object's minimum size. Use
17115 * this when you're not setting other size hints expanding on the
17116 * given direction (like weight and alignment hints) and you would
17117 * like it to have a specific size.
17119 * @note Icon, end, label, indicator and unit text around @p obj
17120 * will require their
17121 * own space, which will make @p obj to require more the @p size,
17124 * @see elm_slider_span_size_get()
17128 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17131 * Get the length set for the bar region of a given slider widget
17133 * @param obj The slider object.
17134 * @return The length of the slider's bar region.
17136 * If that size was not set previously, with
17137 * elm_slider_span_size_set(), this call will return @c 0.
17141 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17144 * Set the format string for the unit label.
17146 * @param obj The slider object.
17147 * @param format The format string for the unit display.
17149 * Unit label is displayed all the time, if set, after slider's bar.
17150 * In horizontal mode, at right and in vertical mode, at bottom.
17152 * If @c NULL, unit label won't be visible. If not it sets the format
17153 * string for the label text. To the label text is provided a floating point
17154 * value, so the label text can display up to 1 floating point value.
17155 * Note that this is optional.
17157 * Use a format string such as "%1.2f meters" for example, and it will
17158 * display values like: "3.14 meters" for a value equal to 3.14159.
17160 * Default is unit label disabled.
17162 * @see elm_slider_indicator_format_get()
17166 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17169 * Get the unit label format of the slider.
17171 * @param obj The slider object.
17172 * @return The unit label format string in UTF-8.
17174 * Unit label is displayed all the time, if set, after slider's bar.
17175 * In horizontal mode, at right and in vertical mode, at bottom.
17177 * @see elm_slider_unit_format_set() for more
17178 * information on how this works.
17182 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17185 * Set the format string for the indicator label.
17187 * @param obj The slider object.
17188 * @param indicator The format string for the indicator display.
17190 * The slider may display its value somewhere else then unit label,
17191 * for example, above the slider knob that is dragged around. This function
17192 * sets the format string used for this.
17194 * If @c NULL, indicator label won't be visible. If not it sets the format
17195 * string for the label text. To the label text is provided a floating point
17196 * value, so the label text can display up to 1 floating point value.
17197 * Note that this is optional.
17199 * Use a format string such as "%1.2f meters" for example, and it will
17200 * display values like: "3.14 meters" for a value equal to 3.14159.
17202 * Default is indicator label disabled.
17204 * @see elm_slider_indicator_format_get()
17208 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17211 * Get the indicator label format of the slider.
17213 * @param obj The slider object.
17214 * @return The indicator label format string in UTF-8.
17216 * The slider may display its value somewhere else then unit label,
17217 * for example, above the slider knob that is dragged around. This function
17218 * gets the format string used for this.
17220 * @see elm_slider_indicator_format_set() for more
17221 * information on how this works.
17225 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17228 * Set the format function pointer for the indicator label
17230 * @param obj The slider object.
17231 * @param func The indicator format function.
17232 * @param free_func The freeing function for the format string.
17234 * Set the callback function to format the indicator string.
17236 * @see elm_slider_indicator_format_set() for more info on how this works.
17240 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);
17243 * Set the format function pointer for the units label
17245 * @param obj The slider object.
17246 * @param func The units format function.
17247 * @param free_func The freeing function for the format string.
17249 * Set the callback function to format the indicator string.
17251 * @see elm_slider_units_format_set() for more info on how this works.
17255 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);
17258 * Set the orientation of a given slider widget.
17260 * @param obj The slider object.
17261 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17262 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17264 * Use this function to change how your slider is to be
17265 * disposed: vertically or horizontally.
17267 * By default it's displayed horizontally.
17269 * @see elm_slider_horizontal_get()
17273 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17276 * Retrieve the orientation of a given slider widget
17278 * @param obj The slider object.
17279 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17280 * @c EINA_FALSE if it's @b vertical (and on errors).
17282 * @see elm_slider_horizontal_set() for more details.
17286 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17289 * Set the minimum and maximum values for the slider.
17291 * @param obj The slider object.
17292 * @param min The minimum value.
17293 * @param max The maximum value.
17295 * Define the allowed range of values to be selected by the user.
17297 * If actual value is less than @p min, it will be updated to @p min. If it
17298 * is bigger then @p max, will be updated to @p max. Actual value can be
17299 * get with elm_slider_value_get().
17301 * By default, min is equal to 0.0, and max is equal to 1.0.
17303 * @warning Maximum must be greater than minimum, otherwise behavior
17306 * @see elm_slider_min_max_get()
17310 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17313 * Get the minimum and maximum values of the slider.
17315 * @param obj The slider object.
17316 * @param min Pointer where to store the minimum value.
17317 * @param max Pointer where to store the maximum value.
17319 * @note If only one value is needed, the other pointer can be passed
17322 * @see elm_slider_min_max_set() for details.
17326 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17329 * Set the value the slider displays.
17331 * @param obj The slider object.
17332 * @param val The value to be displayed.
17334 * Value will be presented on the unit label following format specified with
17335 * elm_slider_unit_format_set() and on indicator with
17336 * elm_slider_indicator_format_set().
17338 * @warning The value must to be between min and max values. This values
17339 * are set by elm_slider_min_max_set().
17341 * @see elm_slider_value_get()
17342 * @see elm_slider_unit_format_set()
17343 * @see elm_slider_indicator_format_set()
17344 * @see elm_slider_min_max_set()
17348 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17351 * Get the value displayed by the spinner.
17353 * @param obj The spinner object.
17354 * @return The value displayed.
17356 * @see elm_spinner_value_set() for details.
17360 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17363 * Invert a given slider widget's displaying values order
17365 * @param obj The slider object.
17366 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17367 * @c EINA_FALSE to bring it back to default, non-inverted values.
17369 * A slider may be @b inverted, in which state it gets its
17370 * values inverted, with high vales being on the left or top and
17371 * low values on the right or bottom, as opposed to normally have
17372 * the low values on the former and high values on the latter,
17373 * respectively, for horizontal and vertical modes.
17375 * @see elm_slider_inverted_get()
17379 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17382 * Get whether a given slider widget's displaying values are
17385 * @param obj The slider object.
17386 * @return @c EINA_TRUE, if @p obj has inverted values,
17387 * @c EINA_FALSE otherwise (and on errors).
17389 * @see elm_slider_inverted_set() for more details.
17393 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17396 * Set whether to enlarge slider indicator (augmented knob) or not.
17398 * @param obj The slider object.
17399 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17400 * let the knob always at default size.
17402 * By default, indicator will be bigger while dragged by the user.
17404 * @warning It won't display values set with
17405 * elm_slider_indicator_format_set() if you disable indicator.
17409 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17412 * Get whether a given slider widget's enlarging indicator or not.
17414 * @param obj The slider object.
17415 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17416 * @c EINA_FALSE otherwise (and on errors).
17418 * @see elm_slider_indicator_show_set() for details.
17422 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17429 * @addtogroup Actionslider Actionslider
17431 * @image html img/widget/actionslider/preview-00.png
17432 * @image latex img/widget/actionslider/preview-00.eps
17434 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17435 * properties. The user drags and releases the indicator, to choose a label.
17437 * Labels occupy the following positions.
17442 * Positions can be enabled or disabled.
17444 * Magnets can be set on the above positions.
17446 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17448 * @note By default all positions are set as enabled.
17450 * Signals that you can add callbacks for are:
17452 * "selected" - when user selects an enabled position (the label is passed
17455 * "pos_changed" - when the indicator reaches any of the positions("left",
17456 * "right" or "center").
17458 * See an example of actionslider usage @ref actionslider_example_page "here"
17462 typedef enum _Elm_Actionslider_Indicator_Pos
17464 ELM_ACTIONSLIDER_INDICATOR_NONE,
17465 ELM_ACTIONSLIDER_INDICATOR_LEFT,
17466 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17467 ELM_ACTIONSLIDER_INDICATOR_CENTER
17468 } Elm_Actionslider_Indicator_Pos;
17470 typedef enum _Elm_Actionslider_Magnet_Pos
17472 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17473 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17474 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17475 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17476 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17477 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17478 } Elm_Actionslider_Magnet_Pos;
17480 typedef enum _Elm_Actionslider_Label_Pos
17482 ELM_ACTIONSLIDER_LABEL_LEFT,
17483 ELM_ACTIONSLIDER_LABEL_RIGHT,
17484 ELM_ACTIONSLIDER_LABEL_CENTER,
17485 ELM_ACTIONSLIDER_LABEL_BUTTON
17486 } Elm_Actionslider_Label_Pos;
17488 /* smart callbacks called:
17489 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17493 * Add a new actionslider to the parent.
17495 * @param parent The parent object
17496 * @return The new actionslider object or NULL if it cannot be created
17498 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17501 * Set actionslider label.
17503 * @param[in] obj The actionslider object
17504 * @param[in] pos The position of the label.
17505 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17506 * @param label The label which is going to be set.
17508 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17510 * Get actionslider labels.
17512 * @param obj The actionslider object
17513 * @param left_label A char** to place the left_label of @p obj into.
17514 * @param center_label A char** to place the center_label of @p obj into.
17515 * @param right_label A char** to place the right_label of @p obj into.
17517 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);
17519 * Get actionslider selected label.
17521 * @param obj The actionslider object
17522 * @return The selected label
17524 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17526 * Set actionslider indicator position.
17528 * @param obj The actionslider object.
17529 * @param pos The position of the indicator.
17531 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17533 * Get actionslider indicator position.
17535 * @param obj The actionslider object.
17536 * @return The position of the indicator.
17538 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17540 * Set actionslider magnet position. To make multiple positions magnets @c or
17541 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17543 * @param obj The actionslider object.
17544 * @param pos Bit mask indicating the magnet positions.
17546 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17548 * Get actionslider magnet position.
17550 * @param obj The actionslider object.
17551 * @return The positions with magnet property.
17553 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17555 * Set actionslider enabled position. To set multiple positions as enabled @c or
17556 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17558 * @note All the positions are enabled by default.
17560 * @param obj The actionslider object.
17561 * @param pos Bit mask indicating the enabled positions.
17563 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17565 * Get actionslider enabled position.
17567 * @param obj The actionslider object.
17568 * @return The enabled positions.
17570 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17572 * Set the label used on the indicator.
17574 * @param obj The actionslider object
17575 * @param label The label to be set on the indicator.
17576 * @deprecated use elm_object_text_set() instead.
17578 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17580 * Get the label used on the indicator object.
17582 * @param obj The actionslider object
17583 * @return The indicator label
17584 * @deprecated use elm_object_text_get() instead.
17586 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17589 * Hold actionslider object movement.
17591 * @param[in] obj The actionslider object
17592 * @param[in] flag Actionslider hold/release
17593 * (EINA_TURE = hold/EIN_FALSE = release)
17595 * @ingroup Actionslider
17597 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17605 * @defgroup Genlist Genlist
17607 * @image html img/widget/genlist/preview-00.png
17608 * @image latex img/widget/genlist/preview-00.eps
17609 * @image html img/genlist.png
17610 * @image latex img/genlist.eps
17612 * This widget aims to have more expansive list than the simple list in
17613 * Elementary that could have more flexible items and allow many more entries
17614 * while still being fast and low on memory usage. At the same time it was
17615 * also made to be able to do tree structures. But the price to pay is more
17616 * complexity when it comes to usage. If all you want is a simple list with
17617 * icons and a single label, use the normal @ref List object.
17619 * Genlist has a fairly large API, mostly because it's relatively complex,
17620 * trying to be both expansive, powerful and efficient. First we will begin
17621 * an overview on the theory behind genlist.
17623 * @section Genlist_Item_Class Genlist item classes - creating items
17625 * In order to have the ability to add and delete items on the fly, genlist
17626 * implements a class (callback) system where the application provides a
17627 * structure with information about that type of item (genlist may contain
17628 * multiple different items with different classes, states and styles).
17629 * Genlist will call the functions in this struct (methods) when an item is
17630 * "realized" (i.e., created dynamically, while the user is scrolling the
17631 * grid). All objects will simply be deleted when no longer needed with
17632 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17633 * following members:
17634 * - @c item_style - This is a constant string and simply defines the name
17635 * of the item style. It @b must be specified and the default should be @c
17638 * - @c func - A struct with pointers to functions that will be called when
17639 * an item is going to be actually created. All of them receive a @c data
17640 * parameter that will point to the same data passed to
17641 * elm_genlist_item_append() and related item creation functions, and a @c
17642 * obj parameter that points to the genlist object itself.
17644 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17645 * state_get and @c del. The 3 first functions also receive a @c part
17646 * parameter described below. A brief description of these functions follows:
17648 * - @c label_get - The @c part parameter is the name string of one of the
17649 * existing text parts in the Edje group implementing the item's theme.
17650 * This function @b must return a strdup'()ed string, as the caller will
17651 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17652 * - @c content_get - The @c part parameter is the name string of one of the
17653 * existing (content) swallow parts in the Edje group implementing the item's
17654 * theme. It must return @c NULL, when no content is desired, or a valid
17655 * object handle, otherwise. The object will be deleted by the genlist on
17656 * its deletion or when the item is "unrealized". See
17657 * #Elm_Genlist_Item_Icon_Get_Cb.
17658 * - @c func.state_get - The @c part parameter is the name string of one of
17659 * the state parts in the Edje group implementing the item's theme. Return
17660 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17661 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17662 * and @c "elm" as "emission" and "source" arguments, respectively, when
17663 * the state is true (the default is false), where @c XXX is the name of
17664 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17665 * - @c func.del - This is intended for use when genlist items are deleted,
17666 * so any data attached to the item (e.g. its data parameter on creation)
17667 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17669 * available item styles:
17671 * - default_style - The text part is a textblock
17673 * @image html img/widget/genlist/preview-04.png
17674 * @image latex img/widget/genlist/preview-04.eps
17678 * @image html img/widget/genlist/preview-01.png
17679 * @image latex img/widget/genlist/preview-01.eps
17681 * - icon_top_text_bottom
17683 * @image html img/widget/genlist/preview-02.png
17684 * @image latex img/widget/genlist/preview-02.eps
17688 * @image html img/widget/genlist/preview-03.png
17689 * @image latex img/widget/genlist/preview-03.eps
17691 * @section Genlist_Items Structure of items
17693 * An item in a genlist can have 0 or more text labels (they can be regular
17694 * text or textblock Evas objects - that's up to the style to determine), 0
17695 * or more contents (which are simply objects swallowed into the genlist item's
17696 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17697 * behavior left to the user to define. The Edje part names for each of
17698 * these properties will be looked up, in the theme file for the genlist,
17699 * under the Edje (string) data items named @c "labels", @c "contents" and @c
17700 * "states", respectively. For each of those properties, if more than one
17701 * part is provided, they must have names listed separated by spaces in the
17702 * data fields. For the default genlist item theme, we have @b one label
17703 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17704 * "elm.swallow.end") and @b no state parts.
17706 * A genlist item may be at one of several styles. Elementary provides one
17707 * by default - "default", but this can be extended by system or application
17708 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17711 * @section Genlist_Manipulation Editing and Navigating
17713 * Items can be added by several calls. All of them return a @ref
17714 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17715 * They all take a data parameter that is meant to be used for a handle to
17716 * the applications internal data (eg the struct with the original item
17717 * data). The parent parameter is the parent genlist item this belongs to if
17718 * it is a tree or an indexed group, and NULL if there is no parent. The
17719 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17720 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17721 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17722 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17723 * is set then this item is group index item that is displayed at the top
17724 * until the next group comes. The func parameter is a convenience callback
17725 * that is called when the item is selected and the data parameter will be
17726 * the func_data parameter, obj be the genlist object and event_info will be
17727 * the genlist item.
17729 * elm_genlist_item_append() adds an item to the end of the list, or if
17730 * there is a parent, to the end of all the child items of the parent.
17731 * elm_genlist_item_prepend() is the same but adds to the beginning of
17732 * the list or children list. elm_genlist_item_insert_before() inserts at
17733 * item before another item and elm_genlist_item_insert_after() inserts after
17734 * the indicated item.
17736 * The application can clear the list with elm_genlist_clear() which deletes
17737 * all the items in the list and elm_genlist_item_del() will delete a specific
17738 * item. elm_genlist_item_subitems_clear() will clear all items that are
17739 * children of the indicated parent item.
17741 * To help inspect list items you can jump to the item at the top of the list
17742 * with elm_genlist_first_item_get() which will return the item pointer, and
17743 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17744 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17745 * and previous items respectively relative to the indicated item. Using
17746 * these calls you can walk the entire item list/tree. Note that as a tree
17747 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17748 * let you know which item is the parent (and thus know how to skip them if
17751 * @section Genlist_Muti_Selection Multi-selection
17753 * If the application wants multiple items to be able to be selected,
17754 * elm_genlist_multi_select_set() can enable this. If the list is
17755 * single-selection only (the default), then elm_genlist_selected_item_get()
17756 * will return the selected item, if any, or NULL I none is selected. If the
17757 * list is multi-select then elm_genlist_selected_items_get() will return a
17758 * list (that is only valid as long as no items are modified (added, deleted,
17759 * selected or unselected)).
17761 * @section Genlist_Usage_Hints Usage hints
17763 * There are also convenience functions. elm_genlist_item_genlist_get() will
17764 * return the genlist object the item belongs to. elm_genlist_item_show()
17765 * will make the scroller scroll to show that specific item so its visible.
17766 * elm_genlist_item_data_get() returns the data pointer set by the item
17767 * creation functions.
17769 * If an item changes (state of boolean changes, label or contents change),
17770 * then use elm_genlist_item_update() to have genlist update the item with
17771 * the new state. Genlist will re-realize the item thus call the functions
17772 * in the _Elm_Genlist_Item_Class for that item.
17774 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17775 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17776 * to expand/contract an item and get its expanded state, use
17777 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17778 * again to make an item disabled (unable to be selected and appear
17779 * differently) use elm_genlist_item_disabled_set() to set this and
17780 * elm_genlist_item_disabled_get() to get the disabled state.
17782 * In general to indicate how the genlist should expand items horizontally to
17783 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17784 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17785 * mode means that if items are too wide to fit, the scroller will scroll
17786 * horizontally. Otherwise items are expanded to fill the width of the
17787 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17788 * to the viewport width and limited to that size. This can be combined with
17789 * a different style that uses edjes' ellipsis feature (cutting text off like
17792 * Items will only call their selection func and callback when first becoming
17793 * selected. Any further clicks will do nothing, unless you enable always
17794 * select with elm_genlist_always_select_mode_set(). This means even if
17795 * selected, every click will make the selected callbacks be called.
17796 * elm_genlist_no_select_mode_set() will turn off the ability to select
17797 * items entirely and they will neither appear selected nor call selected
17798 * callback functions.
17800 * Remember that you can create new styles and add your own theme augmentation
17801 * per application with elm_theme_extension_add(). If you absolutely must
17802 * have a specific style that overrides any theme the user or system sets up
17803 * you can use elm_theme_overlay_add() to add such a file.
17805 * @section Genlist_Implementation Implementation
17807 * Evas tracks every object you create. Every time it processes an event
17808 * (mouse move, down, up etc.) it needs to walk through objects and find out
17809 * what event that affects. Even worse every time it renders display updates,
17810 * in order to just calculate what to re-draw, it needs to walk through many
17811 * many many objects. Thus, the more objects you keep active, the more
17812 * overhead Evas has in just doing its work. It is advisable to keep your
17813 * active objects to the minimum working set you need. Also remember that
17814 * object creation and deletion carries an overhead, so there is a
17815 * middle-ground, which is not easily determined. But don't keep massive lists
17816 * of objects you can't see or use. Genlist does this with list objects. It
17817 * creates and destroys them dynamically as you scroll around. It groups them
17818 * into blocks so it can determine the visibility etc. of a whole block at
17819 * once as opposed to having to walk the whole list. This 2-level list allows
17820 * for very large numbers of items to be in the list (tests have used up to
17821 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17822 * may be different sizes, every item added needs to be calculated as to its
17823 * size and thus this presents a lot of overhead on populating the list, this
17824 * genlist employs a queue. Any item added is queued and spooled off over
17825 * time, actually appearing some time later, so if your list has many members
17826 * you may find it takes a while for them to all appear, with your process
17827 * consuming a lot of CPU while it is busy spooling.
17829 * Genlist also implements a tree structure, but it does so with callbacks to
17830 * the application, with the application filling in tree structures when
17831 * requested (allowing for efficient building of a very deep tree that could
17832 * even be used for file-management). See the above smart signal callbacks for
17835 * @section Genlist_Smart_Events Genlist smart events
17837 * Signals that you can add callbacks for are:
17838 * - @c "activated" - The user has double-clicked or pressed
17839 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17840 * item that was activated.
17841 * - @c "clicked,double" - The user has double-clicked an item. The @c
17842 * event_info parameter is the item that was double-clicked.
17843 * - @c "selected" - This is called when a user has made an item selected.
17844 * The event_info parameter is the genlist item that was selected.
17845 * - @c "unselected" - This is called when a user has made an item
17846 * unselected. The event_info parameter is the genlist item that was
17848 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17849 * called and the item is now meant to be expanded. The event_info
17850 * parameter is the genlist item that was indicated to expand. It is the
17851 * job of this callback to then fill in the child items.
17852 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17853 * called and the item is now meant to be contracted. The event_info
17854 * parameter is the genlist item that was indicated to contract. It is the
17855 * job of this callback to then delete the child items.
17856 * - @c "expand,request" - This is called when a user has indicated they want
17857 * to expand a tree branch item. The callback should decide if the item can
17858 * expand (has any children) and then call elm_genlist_item_expanded_set()
17859 * appropriately to set the state. The event_info parameter is the genlist
17860 * item that was indicated to expand.
17861 * - @c "contract,request" - This is called when a user has indicated they
17862 * want to contract a tree branch item. The callback should decide if the
17863 * item can contract (has any children) and then call
17864 * elm_genlist_item_expanded_set() appropriately to set the state. The
17865 * event_info parameter is the genlist item that was indicated to contract.
17866 * - @c "realized" - This is called when the item in the list is created as a
17867 * real evas object. event_info parameter is the genlist item that was
17868 * created. The object may be deleted at any time, so it is up to the
17869 * caller to not use the object pointer from elm_genlist_item_object_get()
17870 * in a way where it may point to freed objects.
17871 * - @c "unrealized" - This is called just before an item is unrealized.
17872 * After this call content objects provided will be deleted and the item
17873 * object itself delete or be put into a floating cache.
17874 * - @c "drag,start,up" - This is called when the item in the list has been
17875 * dragged (not scrolled) up.
17876 * - @c "drag,start,down" - This is called when the item in the list has been
17877 * dragged (not scrolled) down.
17878 * - @c "drag,start,left" - This is called when the item in the list has been
17879 * dragged (not scrolled) left.
17880 * - @c "drag,start,right" - This is called when the item in the list has
17881 * been dragged (not scrolled) right.
17882 * - @c "drag,stop" - This is called when the item in the list has stopped
17884 * - @c "drag" - This is called when the item in the list is being dragged.
17885 * - @c "longpressed" - This is called when the item is pressed for a certain
17886 * amount of time. By default it's 1 second.
17887 * - @c "scroll,anim,start" - This is called when scrolling animation has
17889 * - @c "scroll,anim,stop" - This is called when scrolling animation has
17891 * - @c "scroll,drag,start" - This is called when dragging the content has
17893 * - @c "scroll,drag,stop" - This is called when dragging the content has
17895 * - @c "edge,top" - This is called when the genlist is scrolled until
17897 * - @c "edge,bottom" - This is called when the genlist is scrolled
17898 * until the bottom edge.
17899 * - @c "edge,left" - This is called when the genlist is scrolled
17900 * until the left edge.
17901 * - @c "edge,right" - This is called when the genlist is scrolled
17902 * until the right edge.
17903 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17905 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17907 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17909 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17911 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17912 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
17913 * multi-touch pinched in.
17914 * - @c "swipe" - This is called when the genlist is swiped.
17915 * - @c "moved" - This is called when a genlist item is moved.
17916 * - @c "language,changed" - This is called when the program's language is
17919 * @section Genlist_Examples Examples
17921 * Here is a list of examples that use the genlist, trying to show some of
17922 * its capabilities:
17923 * - @ref genlist_example_01
17924 * - @ref genlist_example_02
17925 * - @ref genlist_example_03
17926 * - @ref genlist_example_04
17927 * - @ref genlist_example_05
17931 * @addtogroup Genlist
17936 * @enum _Elm_Genlist_Item_Flags
17937 * @typedef Elm_Genlist_Item_Flags
17939 * Defines if the item is of any special type (has subitems or it's the
17940 * index of a group), or is just a simple item.
17944 typedef enum _Elm_Genlist_Item_Flags
17946 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17947 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17948 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17949 } Elm_Genlist_Item_Flags;
17950 typedef enum _Elm_Genlist_Item_Field_Flags
17952 ELM_GENLIST_ITEM_FIELD_ALL = 0,
17953 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
17954 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
17955 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
17956 } Elm_Genlist_Item_Field_Flags;
17957 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17958 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17959 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
17960 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
17961 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
17962 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
17963 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
17964 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
17967 * @struct _Elm_Genlist_Item_Class
17969 * Genlist item class definition structs.
17971 * This struct contains the style and fetching functions that will define the
17972 * contents of each item.
17974 * @see @ref Genlist_Item_Class
17976 struct _Elm_Genlist_Item_Class
17978 const char *item_style;
17980 GenlistItemLabelGetFunc label_get;
17981 GenlistItemIconGetFunc icon_get;
17982 GenlistItemStateGetFunc state_get;
17983 GenlistItemDelFunc del;
17984 GenlistItemMovedFunc moved;
17986 const char *edit_item_style;
17987 const char *mode_item_style;
17989 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
17991 * Add a new genlist widget to the given parent Elementary
17992 * (container) object
17994 * @param parent The parent object
17995 * @return a new genlist widget handle or @c NULL, on errors
17997 * This function inserts a new genlist widget on the canvas.
17999 * @see elm_genlist_item_append()
18000 * @see elm_genlist_item_del()
18001 * @see elm_genlist_clear()
18005 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18007 * Remove all items from a given genlist widget.
18009 * @param obj The genlist object
18011 * This removes (and deletes) all items in @p obj, leaving it empty.
18013 * @see elm_genlist_item_del(), to remove just one item.
18017 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18019 * Enable or disable multi-selection in the genlist
18021 * @param obj The genlist object
18022 * @param multi Multi-select enable/disable. Default is disabled.
18024 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18025 * the list. This allows more than 1 item to be selected. To retrieve the list
18026 * of selected items, use elm_genlist_selected_items_get().
18028 * @see elm_genlist_selected_items_get()
18029 * @see elm_genlist_multi_select_get()
18033 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18035 * Gets if multi-selection in genlist is enabled or disabled.
18037 * @param obj The genlist object
18038 * @return Multi-select enabled/disabled
18039 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18041 * @see elm_genlist_multi_select_set()
18045 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18047 * This sets the horizontal stretching mode.
18049 * @param obj The genlist object
18050 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18052 * This sets the mode used for sizing items horizontally. Valid modes
18053 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18054 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18055 * the scroller will scroll horizontally. Otherwise items are expanded
18056 * to fill the width of the viewport of the scroller. If it is
18057 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18058 * limited to that size.
18060 * @see elm_genlist_horizontal_get()
18064 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18066 * Gets the horizontal stretching mode.
18068 * @param obj The genlist object
18069 * @return The mode to use
18070 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18072 * @see elm_genlist_horizontal_set()
18076 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18078 * Set the always select mode.
18080 * @param obj The genlist object
18081 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18082 * EINA_FALSE = off). Default is @c EINA_FALSE.
18084 * Items will only call their selection func and callback when first
18085 * becoming selected. Any further clicks will do nothing, unless you
18086 * enable always select with elm_genlist_always_select_mode_set().
18087 * This means that, even if selected, every click will make the selected
18088 * callbacks be called.
18090 * @see elm_genlist_always_select_mode_get()
18094 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18096 * Get the always select mode.
18098 * @param obj The genlist object
18099 * @return The always select mode
18100 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18102 * @see elm_genlist_always_select_mode_set()
18106 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18108 * Enable/disable the no select mode.
18110 * @param obj The genlist object
18111 * @param no_select The no select mode
18112 * (EINA_TRUE = on, EINA_FALSE = off)
18114 * This will turn off the ability to select items entirely and they
18115 * will neither appear selected nor call selected callback functions.
18117 * @see elm_genlist_no_select_mode_get()
18121 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18123 * Gets whether the no select mode is enabled.
18125 * @param obj The genlist object
18126 * @return The no select mode
18127 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18129 * @see elm_genlist_no_select_mode_set()
18133 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18135 * Enable/disable compress mode.
18137 * @param obj The genlist object
18138 * @param compress The compress mode
18139 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18141 * This will enable the compress mode where items are "compressed"
18142 * horizontally to fit the genlist scrollable viewport width. This is
18143 * special for genlist. Do not rely on
18144 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18145 * work as genlist needs to handle it specially.
18147 * @see elm_genlist_compress_mode_get()
18151 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18153 * Get whether the compress mode is enabled.
18155 * @param obj The genlist object
18156 * @return The compress mode
18157 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18159 * @see elm_genlist_compress_mode_set()
18163 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18165 * Enable/disable height-for-width mode.
18167 * @param obj The genlist object
18168 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18169 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18171 * With height-for-width mode the item width will be fixed (restricted
18172 * to a minimum of) to the list width when calculating its size in
18173 * order to allow the height to be calculated based on it. This allows,
18174 * for instance, text block to wrap lines if the Edje part is
18175 * configured with "text.min: 0 1".
18177 * @note This mode will make list resize slower as it will have to
18178 * recalculate every item height again whenever the list width
18181 * @note When height-for-width mode is enabled, it also enables
18182 * compress mode (see elm_genlist_compress_mode_set()) and
18183 * disables homogeneous (see elm_genlist_homogeneous_set()).
18187 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18189 * Get whether the height-for-width mode is enabled.
18191 * @param obj The genlist object
18192 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18197 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18199 * Enable/disable horizontal and vertical bouncing effect.
18201 * @param obj The genlist object
18202 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18203 * EINA_FALSE = off). Default is @c EINA_FALSE.
18204 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18205 * EINA_FALSE = off). Default is @c EINA_TRUE.
18207 * This will enable or disable the scroller bouncing effect for the
18208 * genlist. See elm_scroller_bounce_set() for details.
18210 * @see elm_scroller_bounce_set()
18211 * @see elm_genlist_bounce_get()
18215 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18217 * Get whether the horizontal and vertical bouncing effect is enabled.
18219 * @param obj The genlist object
18220 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18222 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18225 * @see elm_genlist_bounce_set()
18229 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18231 * Enable/disable homogenous mode.
18233 * @param obj The genlist object
18234 * @param homogeneous Assume the items within the genlist are of the
18235 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18238 * This will enable the homogeneous mode where items are of the same
18239 * height and width so that genlist may do the lazy-loading at its
18240 * maximum (which increases the performance for scrolling the list). This
18241 * implies 'compressed' mode.
18243 * @see elm_genlist_compress_mode_set()
18244 * @see elm_genlist_homogeneous_get()
18248 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18250 * Get whether the homogenous mode is enabled.
18252 * @param obj The genlist object
18253 * @return Assume the items within the genlist are of the same height
18254 * and width (EINA_TRUE = on, EINA_FALSE = off)
18256 * @see elm_genlist_homogeneous_set()
18260 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18262 * Set the maximum number of items within an item block
18264 * @param obj The genlist object
18265 * @param n Maximum number of items within an item block. Default is 32.
18267 * This will configure the block count to tune to the target with
18268 * particular performance matrix.
18270 * A block of objects will be used to reduce the number of operations due to
18271 * many objects in the screen. It can determine the visibility, or if the
18272 * object has changed, it theme needs to be updated, etc. doing this kind of
18273 * calculation to the entire block, instead of per object.
18275 * The default value for the block count is enough for most lists, so unless
18276 * you know you will have a lot of objects visible in the screen at the same
18277 * time, don't try to change this.
18279 * @see elm_genlist_block_count_get()
18280 * @see @ref Genlist_Implementation
18284 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18286 * Get the maximum number of items within an item block
18288 * @param obj The genlist object
18289 * @return Maximum number of items within an item block
18291 * @see elm_genlist_block_count_set()
18295 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18297 * Set the timeout in seconds for the longpress event.
18299 * @param obj The genlist object
18300 * @param timeout timeout in seconds. Default is 1.
18302 * This option will change how long it takes to send an event "longpressed"
18303 * after the mouse down signal is sent to the list. If this event occurs, no
18304 * "clicked" event will be sent.
18306 * @see elm_genlist_longpress_timeout_set()
18310 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18312 * Get the timeout in seconds for the longpress event.
18314 * @param obj The genlist object
18315 * @return timeout in seconds
18317 * @see elm_genlist_longpress_timeout_get()
18321 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18323 * Append a new item in a given genlist widget.
18325 * @param obj The genlist object
18326 * @param itc The item class for the item
18327 * @param data The item data
18328 * @param parent The parent item, or NULL if none
18329 * @param flags Item flags
18330 * @param func Convenience function called when the item is selected
18331 * @param func_data Data passed to @p func above.
18332 * @return A handle to the item added or @c NULL if not possible
18334 * This adds the given item to the end of the list or the end of
18335 * the children list if the @p parent is given.
18337 * @see elm_genlist_item_prepend()
18338 * @see elm_genlist_item_insert_before()
18339 * @see elm_genlist_item_insert_after()
18340 * @see elm_genlist_item_del()
18344 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);
18346 * Prepend a new item in a given genlist widget.
18348 * @param obj The genlist object
18349 * @param itc The item class for the item
18350 * @param data The item data
18351 * @param parent The parent item, or NULL if none
18352 * @param flags Item flags
18353 * @param func Convenience function called when the item is selected
18354 * @param func_data Data passed to @p func above.
18355 * @return A handle to the item added or NULL if not possible
18357 * This adds an item to the beginning of the list or beginning of the
18358 * children of the parent if given.
18360 * @see elm_genlist_item_append()
18361 * @see elm_genlist_item_insert_before()
18362 * @see elm_genlist_item_insert_after()
18363 * @see elm_genlist_item_del()
18367 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);
18369 * Insert an item before another in a genlist widget
18371 * @param obj The genlist object
18372 * @param itc The item class for the item
18373 * @param data The item data
18374 * @param before The item to place this new one before.
18375 * @param flags Item flags
18376 * @param func Convenience function called when the item is selected
18377 * @param func_data Data passed to @p func above.
18378 * @return A handle to the item added or @c NULL if not possible
18380 * This inserts an item before another in the list. It will be in the
18381 * same tree level or group as the item it is inserted before.
18383 * @see elm_genlist_item_append()
18384 * @see elm_genlist_item_prepend()
18385 * @see elm_genlist_item_insert_after()
18386 * @see elm_genlist_item_del()
18390 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);
18392 * Insert an item after another in a genlist widget
18394 * @param obj The genlist object
18395 * @param itc The item class for the item
18396 * @param data The item data
18397 * @param after The item to place this new one after.
18398 * @param flags Item flags
18399 * @param func Convenience function called when the item is selected
18400 * @param func_data Data passed to @p func above.
18401 * @return A handle to the item added or @c NULL if not possible
18403 * This inserts an item after another in the list. It will be in the
18404 * same tree level or group as the item it is inserted after.
18406 * @see elm_genlist_item_append()
18407 * @see elm_genlist_item_prepend()
18408 * @see elm_genlist_item_insert_before()
18409 * @see elm_genlist_item_del()
18413 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);
18415 * Insert a new item into the sorted genlist object
18417 * @param obj The genlist object
18418 * @param itc The item class for the item
18419 * @param data The item data
18420 * @param parent The parent item, or NULL if none
18421 * @param flags Item flags
18422 * @param comp The function called for the sort
18423 * @param func Convenience function called when item selected
18424 * @param func_data Data passed to @p func above.
18425 * @return A handle to the item added or NULL if not possible
18429 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);
18430 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);
18431 /* operations to retrieve existing items */
18433 * Get the selectd item in the genlist.
18435 * @param obj The genlist object
18436 * @return The selected item, or NULL if none is selected.
18438 * This gets the selected item in the list (if multi-selection is enabled, only
18439 * the item that was first selected in the list is returned - which is not very
18440 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18443 * If no item is selected, NULL is returned.
18445 * @see elm_genlist_selected_items_get()
18449 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18451 * Get a list of selected items in the genlist.
18453 * @param obj The genlist object
18454 * @return The list of selected items, or NULL if none are selected.
18456 * It returns a list of the selected items. This list pointer is only valid so
18457 * long as the selection doesn't change (no items are selected or unselected, or
18458 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18459 * pointers. The order of the items in this list is the order which they were
18460 * selected, i.e. the first item in this list is the first item that was
18461 * selected, and so on.
18463 * @note If not in multi-select mode, consider using function
18464 * elm_genlist_selected_item_get() instead.
18466 * @see elm_genlist_multi_select_set()
18467 * @see elm_genlist_selected_item_get()
18471 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18473 * Get the mode item style of items in the genlist
18474 * @param obj The genlist object
18475 * @return The mode item style string, or NULL if none is specified
18477 * This is a constant string and simply defines the name of the
18478 * style that will be used for mode animations. It can be
18479 * @c NULL if you don't plan to use Genlist mode. See
18480 * elm_genlist_item_mode_set() for more info.
18484 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18486 * Set the mode item style of items in the genlist
18487 * @param obj The genlist object
18488 * @param style The mode item style string, or NULL if none is desired
18490 * This is a constant string and simply defines the name of the
18491 * style that will be used for mode animations. It can be
18492 * @c NULL if you don't plan to use Genlist mode. See
18493 * elm_genlist_item_mode_set() for more info.
18497 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18499 * Get a list of realized items in genlist
18501 * @param obj The genlist object
18502 * @return The list of realized items, nor NULL if none are realized.
18504 * This returns a list of the realized items in the genlist. The list
18505 * contains Elm_Genlist_Item pointers. The list must be freed by the
18506 * caller when done with eina_list_free(). The item pointers in the
18507 * list are only valid so long as those items are not deleted or the
18508 * genlist is not deleted.
18510 * @see elm_genlist_realized_items_update()
18514 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18516 * Get the item that is at the x, y canvas coords.
18518 * @param obj The gelinst object.
18519 * @param x The input x coordinate
18520 * @param y The input y coordinate
18521 * @param posret The position relative to the item returned here
18522 * @return The item at the coordinates or NULL if none
18524 * This returns the item at the given coordinates (which are canvas
18525 * relative, not object-relative). If an item is at that coordinate,
18526 * that item handle is returned, and if @p posret is not NULL, the
18527 * integer pointed to is set to a value of -1, 0 or 1, depending if
18528 * the coordinate is on the upper portion of that item (-1), on the
18529 * middle section (0) or on the lower part (1). If NULL is returned as
18530 * an item (no item found there), then posret may indicate -1 or 1
18531 * based if the coordinate is above or below all items respectively in
18536 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);
18538 * Get the first item in the genlist
18540 * This returns the first item in the list.
18542 * @param obj The genlist object
18543 * @return The first item, or NULL if none
18547 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18549 * Get the last item in the genlist
18551 * This returns the last item in the list.
18553 * @return The last item, or NULL if none
18557 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18559 * Set the scrollbar policy
18561 * @param obj The genlist object
18562 * @param policy_h Horizontal scrollbar policy.
18563 * @param policy_v Vertical scrollbar policy.
18565 * This sets the scrollbar visibility policy for the given genlist
18566 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18567 * made visible if it is needed, and otherwise kept hidden.
18568 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18569 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18570 * respectively for the horizontal and vertical scrollbars. Default is
18571 * #ELM_SMART_SCROLLER_POLICY_AUTO
18573 * @see elm_genlist_scroller_policy_get()
18577 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18579 * Get the scrollbar policy
18581 * @param obj The genlist object
18582 * @param policy_h Pointer to store the horizontal scrollbar policy.
18583 * @param policy_v Pointer to store the vertical scrollbar policy.
18585 * @see elm_genlist_scroller_policy_set()
18589 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);
18591 * Get the @b next item in a genlist widget's internal list of items,
18592 * given a handle to one of those items.
18594 * @param item The genlist item to fetch next from
18595 * @return The item after @p item, or @c NULL if there's none (and
18598 * This returns the item placed after the @p item, on the container
18601 * @see elm_genlist_item_prev_get()
18605 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18607 * Get the @b previous item in a genlist widget's internal list of items,
18608 * given a handle to one of those items.
18610 * @param item The genlist item to fetch previous from
18611 * @return The item before @p item, or @c NULL if there's none (and
18614 * This returns the item placed before the @p item, on the container
18617 * @see elm_genlist_item_next_get()
18621 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18623 * Get the genlist object's handle which contains a given genlist
18626 * @param item The item to fetch the container from
18627 * @return The genlist (parent) object
18629 * This returns the genlist object itself that an item belongs to.
18633 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18635 * Get the parent item of the given item
18637 * @param it The item
18638 * @return The parent of the item or @c NULL if it has no parent.
18640 * This returns the item that was specified as parent of the item @p it on
18641 * elm_genlist_item_append() and insertion related functions.
18645 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18647 * Remove all sub-items (children) of the given item
18649 * @param it The item
18651 * This removes all items that are children (and their descendants) of the
18652 * given item @p it.
18654 * @see elm_genlist_clear()
18655 * @see elm_genlist_item_del()
18659 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18661 * Set whether a given genlist item is selected or not
18663 * @param it The item
18664 * @param selected Use @c EINA_TRUE, to make it selected, @c
18665 * EINA_FALSE to make it unselected
18667 * This sets the selected state of an item. If multi selection is
18668 * not enabled on the containing genlist and @p selected is @c
18669 * EINA_TRUE, any other previously selected items will get
18670 * unselected in favor of this new one.
18672 * @see elm_genlist_item_selected_get()
18676 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18678 * Get whether a given genlist item is selected or not
18680 * @param it The item
18681 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18683 * @see elm_genlist_item_selected_set() for more details
18687 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18689 * Sets the expanded state of an item.
18691 * @param it The item
18692 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18694 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18697 * The theme will respond to this change visually, and a signal "expanded" or
18698 * "contracted" will be sent from the genlist with a pointer to the item that
18699 * has been expanded/contracted.
18701 * Calling this function won't show or hide any child of this item (if it is
18702 * a parent). You must manually delete and create them on the callbacks fo
18703 * the "expanded" or "contracted" signals.
18705 * @see elm_genlist_item_expanded_get()
18709 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18711 * Get the expanded state of an item
18713 * @param it The item
18714 * @return The expanded state
18716 * This gets the expanded state of an item.
18718 * @see elm_genlist_item_expanded_set()
18722 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18724 * Get the depth of expanded item
18726 * @param it The genlist item object
18727 * @return The depth of expanded item
18731 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18733 * Set whether a given genlist item is disabled or not.
18735 * @param it The item
18736 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18737 * to enable it back.
18739 * A disabled item cannot be selected or unselected. It will also
18740 * change its appearance, to signal the user it's disabled.
18742 * @see elm_genlist_item_disabled_get()
18746 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18748 * Get whether a given genlist item is disabled or not.
18750 * @param it The item
18751 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18754 * @see elm_genlist_item_disabled_set() for more details
18758 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18760 * Sets the display only state of an item.
18762 * @param it The item
18763 * @param display_only @c EINA_TRUE if the item is display only, @c
18764 * EINA_FALSE otherwise.
18766 * A display only item cannot be selected or unselected. It is for
18767 * display only and not selecting or otherwise clicking, dragging
18768 * etc. by the user, thus finger size rules will not be applied to
18771 * It's good to set group index items to display only state.
18773 * @see elm_genlist_item_display_only_get()
18777 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18779 * Get the display only state of an item
18781 * @param it The item
18782 * @return @c EINA_TRUE if the item is display only, @c
18783 * EINA_FALSE otherwise.
18785 * @see elm_genlist_item_display_only_set()
18789 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18791 * Show the portion of a genlist's internal list containing a given
18792 * item, immediately.
18794 * @param it The item to display
18796 * This causes genlist to jump to the given item @p it and show it (by
18797 * immediately scrolling to that position), if it is not fully visible.
18799 * @see elm_genlist_item_bring_in()
18800 * @see elm_genlist_item_top_show()
18801 * @see elm_genlist_item_middle_show()
18805 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18807 * Animatedly bring in, to the visible are of a genlist, a given
18810 * @param it The item to display
18812 * This causes genlist to jump to the given item @p it and show it (by
18813 * animatedly scrolling), if it is not fully visible. This may use animation
18814 * to do so and take a period of time
18816 * @see elm_genlist_item_show()
18817 * @see elm_genlist_item_top_bring_in()
18818 * @see elm_genlist_item_middle_bring_in()
18822 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18824 * Show the portion of a genlist's internal list containing a given
18825 * item, immediately.
18827 * @param it The item to display
18829 * This causes genlist to jump to the given item @p it and show it (by
18830 * immediately scrolling to that position), if it is not fully visible.
18832 * The item will be positioned at the top of the genlist viewport.
18834 * @see elm_genlist_item_show()
18835 * @see elm_genlist_item_top_bring_in()
18839 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18841 * Animatedly bring in, to the visible are of a genlist, a given
18844 * @param it The item
18846 * This causes genlist to jump to the given item @p it and show it (by
18847 * animatedly scrolling), if it is not fully visible. This may use animation
18848 * to do so and take a period of time
18850 * The item will be positioned at the top of the genlist viewport.
18852 * @see elm_genlist_item_bring_in()
18853 * @see elm_genlist_item_top_show()
18857 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18859 * Show the portion of a genlist's internal list containing a given
18860 * item, immediately.
18862 * @param it The item to display
18864 * This causes genlist to jump to the given item @p it and show it (by
18865 * immediately scrolling to that position), if it is not fully visible.
18867 * The item will be positioned at the middle of the genlist viewport.
18869 * @see elm_genlist_item_show()
18870 * @see elm_genlist_item_middle_bring_in()
18874 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18876 * Animatedly bring in, to the visible are of a genlist, a given
18879 * @param it The item
18881 * This causes genlist to jump to the given item @p it and show it (by
18882 * animatedly scrolling), if it is not fully visible. This may use animation
18883 * to do so and take a period of time
18885 * The item will be positioned at the middle of the genlist viewport.
18887 * @see elm_genlist_item_bring_in()
18888 * @see elm_genlist_item_middle_show()
18892 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18894 * Remove a genlist item from the its parent, deleting it.
18896 * @param item The item to be removed.
18897 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18899 * @see elm_genlist_clear(), to remove all items in a genlist at
18904 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18906 * Return the data associated to a given genlist item
18908 * @param item The genlist item.
18909 * @return the data associated to this item.
18911 * This returns the @c data value passed on the
18912 * elm_genlist_item_append() and related item addition calls.
18914 * @see elm_genlist_item_append()
18915 * @see elm_genlist_item_data_set()
18919 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18921 * Set the data associated to a given genlist item
18923 * @param item The genlist item
18924 * @param data The new data pointer to set on it
18926 * This @b overrides the @c data value passed on the
18927 * elm_genlist_item_append() and related item addition calls. This
18928 * function @b won't call elm_genlist_item_update() automatically,
18929 * so you'd issue it afterwards if you want to hove the item
18930 * updated to reflect the that new data.
18932 * @see elm_genlist_item_data_get()
18936 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18938 * Tells genlist to "orphan" icons fetchs by the item class
18940 * @param it The item
18942 * This instructs genlist to release references to icons in the item,
18943 * meaning that they will no longer be managed by genlist and are
18944 * floating "orphans" that can be re-used elsewhere if the user wants
18949 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18950 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18952 * Get the real Evas object created to implement the view of a
18953 * given genlist item
18955 * @param item The genlist item.
18956 * @return the Evas object implementing this item's view.
18958 * This returns the actual Evas object used to implement the
18959 * specified genlist item's view. This may be @c NULL, as it may
18960 * not have been created or may have been deleted, at any time, by
18961 * the genlist. <b>Do not modify this object</b> (move, resize,
18962 * show, hide, etc.), as the genlist is controlling it. This
18963 * function is for querying, emitting custom signals or hooking
18964 * lower level callbacks for events on that object. Do not delete
18965 * this object under any circumstances.
18967 * @see elm_genlist_item_data_get()
18971 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18973 * Update the contents of an item
18975 * @param it The item
18977 * This updates an item by calling all the item class functions again
18978 * to get the icons, labels and states. Use this when the original
18979 * item data has changed and the changes are desired to be reflected.
18981 * Use elm_genlist_realized_items_update() to update all already realized
18984 * @see elm_genlist_realized_items_update()
18988 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18989 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
18991 * Update the item class of an item
18993 * @param it The item
18994 * @param itc The item class for the item
18996 * This sets another class fo the item, changing the way that it is
18997 * displayed. After changing the item class, elm_genlist_item_update() is
18998 * called on the item @p it.
19002 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19003 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19005 * Set the text to be shown in a given genlist item's tooltips.
19007 * @param item The genlist item
19008 * @param text The text to set in the content
19010 * This call will setup the text to be used as tooltip to that item
19011 * (analogous to elm_object_tooltip_text_set(), but being item
19012 * tooltips with higher precedence than object tooltips). It can
19013 * have only one tooltip at a time, so any previous tooltip data
19014 * will get removed.
19016 * In order to set an icon or something else as a tooltip, look at
19017 * elm_genlist_item_tooltip_content_cb_set().
19021 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19023 * Set the content to be shown in a given genlist item's tooltips
19025 * @param item The genlist item.
19026 * @param func The function returning the tooltip contents.
19027 * @param data What to provide to @a func as callback data/context.
19028 * @param del_cb Called when data is not needed anymore, either when
19029 * another callback replaces @p func, the tooltip is unset with
19030 * elm_genlist_item_tooltip_unset() or the owner @p item
19031 * dies. This callback receives as its first parameter the
19032 * given @p data, being @c event_info the item handle.
19034 * This call will setup the tooltip's contents to @p item
19035 * (analogous to elm_object_tooltip_content_cb_set(), but being
19036 * item tooltips with higher precedence than object tooltips). It
19037 * can have only one tooltip at a time, so any previous tooltip
19038 * content will get removed. @p func (with @p data) will be called
19039 * every time Elementary needs to show the tooltip and it should
19040 * return a valid Evas object, which will be fully managed by the
19041 * tooltip system, getting deleted when the tooltip is gone.
19043 * In order to set just a text as a tooltip, look at
19044 * elm_genlist_item_tooltip_text_set().
19048 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);
19050 * Unset a tooltip from a given genlist item
19052 * @param item genlist item to remove a previously set tooltip from.
19054 * This call removes any tooltip set on @p item. The callback
19055 * provided as @c del_cb to
19056 * elm_genlist_item_tooltip_content_cb_set() will be called to
19057 * notify it is not used anymore (and have resources cleaned, if
19060 * @see elm_genlist_item_tooltip_content_cb_set()
19064 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19066 * Set a different @b style for a given genlist item's tooltip.
19068 * @param item genlist item with tooltip set
19069 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19070 * "default", @c "transparent", etc)
19072 * Tooltips can have <b>alternate styles</b> to be displayed on,
19073 * which are defined by the theme set on Elementary. This function
19074 * works analogously as elm_object_tooltip_style_set(), but here
19075 * applied only to genlist item objects. The default style for
19076 * tooltips is @c "default".
19078 * @note before you set a style you should define a tooltip with
19079 * elm_genlist_item_tooltip_content_cb_set() or
19080 * elm_genlist_item_tooltip_text_set()
19082 * @see elm_genlist_item_tooltip_style_get()
19086 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19088 * Get the style set a given genlist item's tooltip.
19090 * @param item genlist item with tooltip already set on.
19091 * @return style the theme style in use, which defaults to
19092 * "default". If the object does not have a tooltip set,
19093 * then @c NULL is returned.
19095 * @see elm_genlist_item_tooltip_style_set() for more details
19099 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19101 * Set the type of mouse pointer/cursor decoration to be shown,
19102 * when the mouse pointer is over the given genlist widget item
19104 * @param item genlist item to customize cursor on
19105 * @param cursor the cursor type's name
19107 * This function works analogously as elm_object_cursor_set(), but
19108 * here the cursor's changing area is restricted to the item's
19109 * area, and not the whole widget's. Note that that item cursors
19110 * have precedence over widget cursors, so that a mouse over @p
19111 * item will always show cursor @p type.
19113 * If this function is called twice for an object, a previously set
19114 * cursor will be unset on the second call.
19116 * @see elm_object_cursor_set()
19117 * @see elm_genlist_item_cursor_get()
19118 * @see elm_genlist_item_cursor_unset()
19122 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19124 * Get the type of mouse pointer/cursor decoration set to be shown,
19125 * when the mouse pointer is over the given genlist widget item
19127 * @param item genlist item with custom cursor set
19128 * @return the cursor type's name or @c NULL, if no custom cursors
19129 * were set to @p item (and on errors)
19131 * @see elm_object_cursor_get()
19132 * @see elm_genlist_item_cursor_set() for more details
19133 * @see elm_genlist_item_cursor_unset()
19137 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19139 * Unset any custom mouse pointer/cursor decoration set to be
19140 * shown, when the mouse pointer is over the given genlist widget
19141 * item, thus making it show the @b default cursor again.
19143 * @param item a genlist item
19145 * Use this call to undo any custom settings on this item's cursor
19146 * decoration, bringing it back to defaults (no custom style set).
19148 * @see elm_object_cursor_unset()
19149 * @see elm_genlist_item_cursor_set() for more details
19153 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19155 * Set a different @b style for a given custom cursor set for a
19158 * @param item genlist item with custom cursor set
19159 * @param style the <b>theme style</b> to use (e.g. @c "default",
19160 * @c "transparent", etc)
19162 * This function only makes sense when one is using custom mouse
19163 * cursor decorations <b>defined in a theme file</b> , which can
19164 * have, given a cursor name/type, <b>alternate styles</b> on
19165 * it. It works analogously as elm_object_cursor_style_set(), but
19166 * here applied only to genlist item objects.
19168 * @warning Before you set a cursor style you should have defined a
19169 * custom cursor previously on the item, with
19170 * elm_genlist_item_cursor_set()
19172 * @see elm_genlist_item_cursor_engine_only_set()
19173 * @see elm_genlist_item_cursor_style_get()
19177 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19179 * Get the current @b style set for a given genlist item's custom
19182 * @param item genlist item with custom cursor set.
19183 * @return style the cursor style in use. If the object does not
19184 * have a cursor set, then @c NULL is returned.
19186 * @see elm_genlist_item_cursor_style_set() for more details
19190 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19192 * Set if the (custom) cursor for a given genlist item should be
19193 * searched in its theme, also, or should only rely on the
19194 * rendering engine.
19196 * @param item item with custom (custom) cursor already set on
19197 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19198 * only on those provided by the rendering engine, @c EINA_FALSE to
19199 * have them searched on the widget's theme, as well.
19201 * @note This call is of use only if you've set a custom cursor
19202 * for genlist items, with elm_genlist_item_cursor_set().
19204 * @note By default, cursors will only be looked for between those
19205 * provided by the rendering engine.
19209 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19211 * Get if the (custom) cursor for a given genlist item is being
19212 * searched in its theme, also, or is only relying on the rendering
19215 * @param item a genlist item
19216 * @return @c EINA_TRUE, if cursors are being looked for only on
19217 * those provided by the rendering engine, @c EINA_FALSE if they
19218 * are being searched on the widget's theme, as well.
19220 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19224 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19226 * Update the contents of all realized items.
19228 * @param obj The genlist object.
19230 * This updates all realized items by calling all the item class functions again
19231 * to get the icons, labels and states. Use this when the original
19232 * item data has changed and the changes are desired to be reflected.
19234 * To update just one item, use elm_genlist_item_update().
19236 * @see elm_genlist_realized_items_get()
19237 * @see elm_genlist_item_update()
19241 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19243 * Activate a genlist mode on an item
19245 * @param item The genlist item
19246 * @param mode Mode name
19247 * @param mode_set Boolean to define set or unset mode.
19249 * A genlist mode is a different way of selecting an item. Once a mode is
19250 * activated on an item, any other selected item is immediately unselected.
19251 * This feature provides an easy way of implementing a new kind of animation
19252 * for selecting an item, without having to entirely rewrite the item style
19253 * theme. However, the elm_genlist_selected_* API can't be used to get what
19254 * item is activate for a mode.
19256 * The current item style will still be used, but applying a genlist mode to
19257 * an item will select it using a different kind of animation.
19259 * The current active item for a mode can be found by
19260 * elm_genlist_mode_item_get().
19262 * The characteristics of genlist mode are:
19263 * - Only one mode can be active at any time, and for only one item.
19264 * - Genlist handles deactivating other items when one item is activated.
19265 * - A mode is defined in the genlist theme (edc), and more modes can easily
19267 * - A mode style and the genlist item style are different things. They
19268 * can be combined to provide a default style to the item, with some kind
19269 * of animation for that item when the mode is activated.
19271 * When a mode is activated on an item, a new view for that item is created.
19272 * The theme of this mode defines the animation that will be used to transit
19273 * the item from the old view to the new view. This second (new) view will be
19274 * active for that item while the mode is active on the item, and will be
19275 * destroyed after the mode is totally deactivated from that item.
19277 * @see elm_genlist_mode_get()
19278 * @see elm_genlist_mode_item_get()
19282 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19284 * Get the last (or current) genlist mode used.
19286 * @param obj The genlist object
19288 * This function just returns the name of the last used genlist mode. It will
19289 * be the current mode if it's still active.
19291 * @see elm_genlist_item_mode_set()
19292 * @see elm_genlist_mode_item_get()
19296 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19298 * Get active genlist mode item
19300 * @param obj The genlist object
19301 * @return The active item for that current mode. Or @c NULL if no item is
19302 * activated with any mode.
19304 * This function returns the item that was activated with a mode, by the
19305 * function elm_genlist_item_mode_set().
19307 * @see elm_genlist_item_mode_set()
19308 * @see elm_genlist_mode_get()
19312 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19317 * @param obj The genlist object
19318 * @param reorder_mode The reorder mode
19319 * (EINA_TRUE = on, EINA_FALSE = off)
19323 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19326 * Get the reorder mode
19328 * @param obj The genlist object
19329 * @return The reorder mode
19330 * (EINA_TRUE = on, EINA_FALSE = off)
19334 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19336 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19337 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19338 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19339 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19340 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19341 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19342 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19343 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19344 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19345 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19352 * @defgroup Check Check
19354 * @image html img/widget/check/preview-00.png
19355 * @image latex img/widget/check/preview-00.eps
19356 * @image html img/widget/check/preview-01.png
19357 * @image latex img/widget/check/preview-01.eps
19358 * @image html img/widget/check/preview-02.png
19359 * @image latex img/widget/check/preview-02.eps
19361 * @brief The check widget allows for toggling a value between true and
19364 * Check objects are a lot like radio objects in layout and functionality
19365 * except they do not work as a group, but independently and only toggle the
19366 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19367 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19368 * returns the current state. For convenience, like the radio objects, you
19369 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19370 * for it to modify.
19372 * Signals that you can add callbacks for are:
19373 * "changed" - This is called whenever the user changes the state of one of
19374 * the check object(event_info is NULL).
19376 * Default contents parts of the check widget that you can use for are:
19377 * @li "elm.swallow.content" - A icon of the check
19379 * Default text parts of the check widget that you can use for are:
19380 * @li "elm.text" - Label of the check
19382 * @ref tutorial_check should give you a firm grasp of how to use this widget
19387 * @brief Add a new Check object
19389 * @param parent The parent object
19390 * @return The new object or NULL if it cannot be created
19392 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19394 * @brief Set the text label of the check object
19396 * @param obj The check object
19397 * @param label The text label string in UTF-8
19399 * @deprecated use elm_object_text_set() instead.
19401 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19403 * @brief Get the text label of the check object
19405 * @param obj The check object
19406 * @return The text label string in UTF-8
19408 * @deprecated use elm_object_text_get() instead.
19410 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19412 * @brief Set the icon object of the check object
19414 * @param obj The check object
19415 * @param icon The icon object
19417 * Once the icon object is set, a previously set one will be deleted.
19418 * If you want to keep that old content object, use the
19419 * elm_check_icon_unset() function.
19421 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19423 * @brief Get the icon object of the check object
19425 * @param obj The check object
19426 * @return The icon object
19428 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19430 * @brief Unset the icon used for the check object
19432 * @param obj The check object
19433 * @return The icon object that was being used
19435 * Unparent and return the icon object which was set for this widget.
19437 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19439 * @brief Set the on/off state of the check object
19441 * @param obj The check object
19442 * @param state The state to use (1 == on, 0 == off)
19444 * This sets the state of the check. If set
19445 * with elm_check_state_pointer_set() the state of that variable is also
19446 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19448 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19450 * @brief Get the state of the check object
19452 * @param obj The check object
19453 * @return The boolean state
19455 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19457 * @brief Set a convenience pointer to a boolean to change
19459 * @param obj The check object
19460 * @param statep Pointer to the boolean to modify
19462 * This sets a pointer to a boolean, that, in addition to the check objects
19463 * state will also be modified directly. To stop setting the object pointed
19464 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19465 * then when this is called, the check objects state will also be modified to
19466 * reflect the value of the boolean @p statep points to, just like calling
19467 * elm_check_state_set().
19469 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19475 * @defgroup Radio Radio
19477 * @image html img/widget/radio/preview-00.png
19478 * @image latex img/widget/radio/preview-00.eps
19480 * @brief Radio is a widget that allows for 1 or more options to be displayed
19481 * and have the user choose only 1 of them.
19483 * A radio object contains an indicator, an optional Label and an optional
19484 * icon object. While it's possible to have a group of only one radio they,
19485 * are normally used in groups of 2 or more. To add a radio to a group use
19486 * elm_radio_group_add(). The radio object(s) will select from one of a set
19487 * of integer values, so any value they are configuring needs to be mapped to
19488 * a set of integers. To configure what value that radio object represents,
19489 * use elm_radio_state_value_set() to set the integer it represents. To set
19490 * the value the whole group(which one is currently selected) is to indicate
19491 * use elm_radio_value_set() on any group member, and to get the groups value
19492 * use elm_radio_value_get(). For convenience the radio objects are also able
19493 * to directly set an integer(int) to the value that is selected. To specify
19494 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19495 * The radio objects will modify this directly. That implies the pointer must
19496 * point to valid memory for as long as the radio objects exist.
19498 * Signals that you can add callbacks for are:
19499 * @li changed - This is called whenever the user changes the state of one of
19500 * the radio objects within the group of radio objects that work together.
19502 * Default contents parts of the radio widget that you can use for are:
19503 * @li "elm.swallow.content" - A icon of the radio
19505 * @ref tutorial_radio show most of this API in action.
19509 * @brief Add a new radio to the parent
19511 * @param parent The parent object
19512 * @return The new object or NULL if it cannot be created
19514 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19516 * @brief Set the text label of the radio object
19518 * @param obj The radio object
19519 * @param label The text label string in UTF-8
19521 * @deprecated use elm_object_text_set() instead.
19523 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19525 * @brief Get the text label of the radio object
19527 * @param obj The radio object
19528 * @return The text label string in UTF-8
19530 * @deprecated use elm_object_text_set() instead.
19532 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19534 * @brief Set the icon object of the radio object
19536 * @param obj The radio object
19537 * @param icon The icon object
19539 * Once the icon object is set, a previously set one will be deleted. If you
19540 * want to keep that old content object, use the elm_radio_icon_unset()
19543 * @deprecated use elm_object_content_set() instead.
19545 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19547 * @brief Get the icon object of the radio object
19549 * @param obj The radio object
19550 * @return The icon object
19552 * @see elm_radio_icon_set()
19554 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19556 * @brief Unset the icon used for the radio object
19558 * @param obj The radio object
19559 * @return The icon object that was being used
19561 * Unparent and return the icon object which was set for this widget.
19563 * @see elm_radio_icon_set()
19564 * @deprecated use elm_object_content_unset() instead.
19566 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19568 * @brief Add this radio to a group of other radio objects
19570 * @param obj The radio object
19571 * @param group Any object whose group the @p obj is to join.
19573 * Radio objects work in groups. Each member should have a different integer
19574 * value assigned. In order to have them work as a group, they need to know
19575 * about each other. This adds the given radio object to the group of which
19576 * the group object indicated is a member.
19578 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19580 * @brief Set the integer value that this radio object represents
19582 * @param obj The radio object
19583 * @param value The value to use if this radio object is selected
19585 * This sets the value of the radio.
19587 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19589 * @brief Get the integer value that this radio object represents
19591 * @param obj The radio object
19592 * @return The value used if this radio object is selected
19594 * This gets the value of the radio.
19596 * @see elm_radio_value_set()
19598 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19600 * @brief Set the value of the radio.
19602 * @param obj The radio object
19603 * @param value The value to use for the group
19605 * This sets the value of the radio group and will also set the value if
19606 * pointed to, to the value supplied, but will not call any callbacks.
19608 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19610 * @brief Get the state of the radio object
19612 * @param obj The radio object
19613 * @return The integer state
19615 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19617 * @brief Set a convenience pointer to a integer to change
19619 * @param obj The radio object
19620 * @param valuep Pointer to the integer to modify
19622 * This sets a pointer to a integer, that, in addition to the radio objects
19623 * state will also be modified directly. To stop setting the object pointed
19624 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19625 * when this is called, the radio objects state will also be modified to
19626 * reflect the value of the integer valuep points to, just like calling
19627 * elm_radio_value_set().
19629 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19635 * @defgroup Pager Pager
19637 * @image html img/widget/pager/preview-00.png
19638 * @image latex img/widget/pager/preview-00.eps
19640 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19642 * The flipping between “pages” of objects is animated. All content in pager
19643 * is kept in a stack, the last content to be added will be on the top of the
19644 * stack(be visible).
19646 * Objects can be pushed or popped from the stack or deleted as normal.
19647 * Pushes and pops will animate (and a pop will delete the object once the
19648 * animation is finished). Any object already in the pager can be promoted to
19649 * the top(from its current stacking position) through the use of
19650 * elm_pager_content_promote(). Objects are pushed to the top with
19651 * elm_pager_content_push() and when the top item is no longer wanted, simply
19652 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19653 * object is no longer needed and is not the top item, just delete it as
19654 * normal. You can query which objects are the top and bottom with
19655 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19657 * Signals that you can add callbacks for are:
19658 * "hide,finished" - when the previous page is hided
19660 * This widget has the following styles available:
19663 * @li fade_translucide
19664 * @li fade_invisible
19665 * @note This styles affect only the flipping animations, the appearance when
19666 * not animating is unaffected by styles.
19668 * @ref tutorial_pager gives a good overview of the usage of the API.
19672 * Add a new pager to the parent
19674 * @param parent The parent object
19675 * @return The new object or NULL if it cannot be created
19679 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19681 * @brief Push an object to the top of the pager stack (and show it).
19683 * @param obj The pager object
19684 * @param content The object to push
19686 * The object pushed becomes a child of the pager, it will be controlled and
19687 * deleted when the pager is deleted.
19689 * @note If the content is already in the stack use
19690 * elm_pager_content_promote().
19691 * @warning Using this function on @p content already in the stack results in
19692 * undefined behavior.
19694 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19696 * @brief Pop the object that is on top of the stack
19698 * @param obj The pager object
19700 * This pops the object that is on the top(visible) of the pager, makes it
19701 * disappear, then deletes the object. The object that was underneath it on
19702 * the stack will become visible.
19704 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19706 * @brief Moves an object already in the pager stack to the top of the stack.
19708 * @param obj The pager object
19709 * @param content The object to promote
19711 * This will take the @p content and move it to the top of the stack as
19712 * if it had been pushed there.
19714 * @note If the content isn't already in the stack use
19715 * elm_pager_content_push().
19716 * @warning Using this function on @p content not already in the stack
19717 * results in undefined behavior.
19719 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19721 * @brief Return the object at the bottom of the pager stack
19723 * @param obj The pager object
19724 * @return The bottom object or NULL if none
19726 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19728 * @brief Return the object at the top of the pager stack
19730 * @param obj The pager object
19731 * @return The top object or NULL if none
19733 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19735 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
19736 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
19743 * @defgroup Slideshow Slideshow
19745 * @image html img/widget/slideshow/preview-00.png
19746 * @image latex img/widget/slideshow/preview-00.eps
19748 * This widget, as the name indicates, is a pre-made image
19749 * slideshow panel, with API functions acting on (child) image
19750 * items presentation. Between those actions, are:
19751 * - advance to next/previous image
19752 * - select the style of image transition animation
19753 * - set the exhibition time for each image
19754 * - start/stop the slideshow
19756 * The transition animations are defined in the widget's theme,
19757 * consequently new animations can be added without having to
19758 * update the widget's code.
19760 * @section Slideshow_Items Slideshow items
19762 * For slideshow items, just like for @ref Genlist "genlist" ones,
19763 * the user defines a @b classes, specifying functions that will be
19764 * called on the item's creation and deletion times.
19766 * The #Elm_Slideshow_Item_Class structure contains the following
19769 * - @c func.get - When an item is displayed, this function is
19770 * called, and it's where one should create the item object, de
19771 * facto. For example, the object can be a pure Evas image object
19772 * or an Elementary @ref Photocam "photocam" widget. See
19773 * #SlideshowItemGetFunc.
19774 * - @c func.del - When an item is no more displayed, this function
19775 * is called, where the user must delete any data associated to
19776 * the item. See #SlideshowItemDelFunc.
19778 * @section Slideshow_Caching Slideshow caching
19780 * The slideshow provides facilities to have items adjacent to the
19781 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19782 * you, so that the system does not have to decode image data
19783 * anymore at the time it has to actually switch images on its
19784 * viewport. The user is able to set the numbers of items to be
19785 * cached @b before and @b after the current item, in the widget's
19788 * Smart events one can add callbacks for are:
19790 * - @c "changed" - when the slideshow switches its view to a new
19793 * List of examples for the slideshow widget:
19794 * @li @ref slideshow_example
19798 * @addtogroup Slideshow
19802 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19803 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19804 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19805 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19806 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19809 * @struct _Elm_Slideshow_Item_Class
19811 * Slideshow item class definition. See @ref Slideshow_Items for
19814 struct _Elm_Slideshow_Item_Class
19816 struct _Elm_Slideshow_Item_Class_Func
19818 SlideshowItemGetFunc get;
19819 SlideshowItemDelFunc del;
19821 }; /**< #Elm_Slideshow_Item_Class member definitions */
19824 * Add a new slideshow widget to the given parent Elementary
19825 * (container) object
19827 * @param parent The parent object
19828 * @return A new slideshow widget handle or @c NULL, on errors
19830 * This function inserts a new slideshow widget on the canvas.
19832 * @ingroup Slideshow
19834 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19837 * Add (append) a new item in a given slideshow widget.
19839 * @param obj The slideshow object
19840 * @param itc The item class for the item
19841 * @param data The item's data
19842 * @return A handle to the item added or @c NULL, on errors
19844 * Add a new item to @p obj's internal list of items, appending it.
19845 * The item's class must contain the function really fetching the
19846 * image object to show for this item, which could be an Evas image
19847 * object or an Elementary photo, for example. The @p data
19848 * parameter is going to be passed to both class functions of the
19851 * @see #Elm_Slideshow_Item_Class
19852 * @see elm_slideshow_item_sorted_insert()
19854 * @ingroup Slideshow
19856 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19859 * Insert a new item into the given slideshow widget, using the @p func
19860 * function to sort items (by item handles).
19862 * @param obj The slideshow object
19863 * @param itc The item class for the item
19864 * @param data The item's data
19865 * @param func The comparing function to be used to sort slideshow
19866 * items <b>by #Elm_Slideshow_Item item handles</b>
19867 * @return Returns The slideshow item handle, on success, or
19868 * @c NULL, on errors
19870 * Add a new item to @p obj's internal list of items, in a position
19871 * determined by the @p func comparing function. The item's class
19872 * must contain the function really fetching the image object to
19873 * show for this item, which could be an Evas image object or an
19874 * Elementary photo, for example. The @p data parameter is going to
19875 * be passed to both class functions of the item.
19877 * @see #Elm_Slideshow_Item_Class
19878 * @see elm_slideshow_item_add()
19880 * @ingroup Slideshow
19882 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);
19885 * Display a given slideshow widget's item, programmatically.
19887 * @param obj The slideshow object
19888 * @param item The item to display on @p obj's viewport
19890 * The change between the current item and @p item will use the
19891 * transition @p obj is set to use (@see
19892 * elm_slideshow_transition_set()).
19894 * @ingroup Slideshow
19896 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19899 * Slide to the @b next item, in a given slideshow widget
19901 * @param obj The slideshow object
19903 * The sliding animation @p obj is set to use will be the
19904 * transition effect used, after this call is issued.
19906 * @note If the end of the slideshow's internal list of items is
19907 * reached, it'll wrap around to the list's beginning, again.
19909 * @ingroup Slideshow
19911 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19914 * Slide to the @b previous item, in a given slideshow widget
19916 * @param obj The slideshow object
19918 * The sliding animation @p obj is set to use will be the
19919 * transition effect used, after this call is issued.
19921 * @note If the beginning of the slideshow's internal list of items
19922 * is reached, it'll wrap around to the list's end, again.
19924 * @ingroup Slideshow
19926 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19929 * Returns the list of sliding transition/effect names available, for a
19930 * given slideshow widget.
19932 * @param obj The slideshow object
19933 * @return The list of transitions (list of @b stringshared strings
19936 * The transitions, which come from @p obj's theme, must be an EDC
19937 * data item named @c "transitions" on the theme file, with (prefix)
19938 * names of EDC programs actually implementing them.
19940 * The available transitions for slideshows on the default theme are:
19941 * - @c "fade" - the current item fades out, while the new one
19942 * fades in to the slideshow's viewport.
19943 * - @c "black_fade" - the current item fades to black, and just
19944 * then, the new item will fade in.
19945 * - @c "horizontal" - the current item slides horizontally, until
19946 * it gets out of the slideshow's viewport, while the new item
19947 * comes from the left to take its place.
19948 * - @c "vertical" - the current item slides vertically, until it
19949 * gets out of the slideshow's viewport, while the new item comes
19950 * from the bottom to take its place.
19951 * - @c "square" - the new item starts to appear from the middle of
19952 * the current one, but with a tiny size, growing until its
19953 * target (full) size and covering the old one.
19955 * @warning The stringshared strings get no new references
19956 * exclusive to the user grabbing the list, here, so if you'd like
19957 * to use them out of this call's context, you'd better @c
19958 * eina_stringshare_ref() them.
19960 * @see elm_slideshow_transition_set()
19962 * @ingroup Slideshow
19964 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19967 * Set the current slide transition/effect in use for a given
19970 * @param obj The slideshow object
19971 * @param transition The new transition's name string
19973 * If @p transition is implemented in @p obj's theme (i.e., is
19974 * contained in the list returned by
19975 * elm_slideshow_transitions_get()), this new sliding effect will
19976 * be used on the widget.
19978 * @see elm_slideshow_transitions_get() for more details
19980 * @ingroup Slideshow
19982 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19985 * Get the current slide transition/effect in use for a given
19988 * @param obj The slideshow object
19989 * @return The current transition's name
19991 * @see elm_slideshow_transition_set() for more details
19993 * @ingroup Slideshow
19995 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19998 * Set the interval between each image transition on a given
19999 * slideshow widget, <b>and start the slideshow, itself</b>
20001 * @param obj The slideshow object
20002 * @param timeout The new displaying timeout for images
20004 * After this call, the slideshow widget will start cycling its
20005 * view, sequentially and automatically, with the images of the
20006 * items it has. The time between each new image displayed is going
20007 * to be @p timeout, in @b seconds. If a different timeout was set
20008 * previously and an slideshow was in progress, it will continue
20009 * with the new time between transitions, after this call.
20011 * @note A value less than or equal to 0 on @p timeout will disable
20012 * the widget's internal timer, thus halting any slideshow which
20013 * could be happening on @p obj.
20015 * @see elm_slideshow_timeout_get()
20017 * @ingroup Slideshow
20019 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20022 * Get the interval set for image transitions on a given slideshow
20025 * @param obj The slideshow object
20026 * @return Returns the timeout set on it
20028 * @see elm_slideshow_timeout_set() for more details
20030 * @ingroup Slideshow
20032 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20035 * Set if, after a slideshow is started, for a given slideshow
20036 * widget, its items should be displayed cyclically or not.
20038 * @param obj The slideshow object
20039 * @param loop Use @c EINA_TRUE to make it cycle through items or
20040 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20043 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20044 * ignore what is set by this functions, i.e., they'll @b always
20045 * cycle through items. This affects only the "automatic"
20046 * slideshow, as set by elm_slideshow_timeout_set().
20048 * @see elm_slideshow_loop_get()
20050 * @ingroup Slideshow
20052 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20055 * Get if, after a slideshow is started, for a given slideshow
20056 * widget, its items are to be displayed cyclically or not.
20058 * @param obj The slideshow object
20059 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20060 * through or @c EINA_FALSE, otherwise
20062 * @see elm_slideshow_loop_set() for more details
20064 * @ingroup Slideshow
20066 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20069 * Remove all items from a given slideshow widget
20071 * @param obj The slideshow object
20073 * This removes (and deletes) all items in @p obj, leaving it
20076 * @see elm_slideshow_item_del(), to remove just one item.
20078 * @ingroup Slideshow
20080 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20083 * Get the internal list of items in a given slideshow widget.
20085 * @param obj The slideshow object
20086 * @return The list of items (#Elm_Slideshow_Item as data) or
20087 * @c NULL on errors.
20089 * This list is @b not to be modified in any way and must not be
20090 * freed. Use the list members with functions like
20091 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20093 * @warning This list is only valid until @p obj object's internal
20094 * items list is changed. It should be fetched again with another
20095 * call to this function when changes happen.
20097 * @ingroup Slideshow
20099 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20102 * Delete a given item from a slideshow widget.
20104 * @param item The slideshow item
20106 * @ingroup Slideshow
20108 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20111 * Return the data associated with a given slideshow item
20113 * @param item The slideshow item
20114 * @return Returns the data associated to this item
20116 * @ingroup Slideshow
20118 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20121 * Returns the currently displayed item, in a given slideshow widget
20123 * @param obj The slideshow object
20124 * @return A handle to the item being displayed in @p obj or
20125 * @c NULL, if none is (and on errors)
20127 * @ingroup Slideshow
20129 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20132 * Get the real Evas object created to implement the view of a
20133 * given slideshow item
20135 * @param item The slideshow item.
20136 * @return the Evas object implementing this item's view.
20138 * This returns the actual Evas object used to implement the
20139 * specified slideshow item's view. This may be @c NULL, as it may
20140 * not have been created or may have been deleted, at any time, by
20141 * the slideshow. <b>Do not modify this object</b> (move, resize,
20142 * show, hide, etc.), as the slideshow is controlling it. This
20143 * function is for querying, emitting custom signals or hooking
20144 * lower level callbacks for events on that object. Do not delete
20145 * this object under any circumstances.
20147 * @see elm_slideshow_item_data_get()
20149 * @ingroup Slideshow
20151 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20154 * Get the the item, in a given slideshow widget, placed at
20155 * position @p nth, in its internal items list
20157 * @param obj The slideshow object
20158 * @param nth The number of the item to grab a handle to (0 being
20160 * @return The item stored in @p obj at position @p nth or @c NULL,
20161 * if there's no item with that index (and on errors)
20163 * @ingroup Slideshow
20165 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20168 * Set the current slide layout in use for a given slideshow widget
20170 * @param obj The slideshow object
20171 * @param layout The new layout's name string
20173 * If @p layout is implemented in @p obj's theme (i.e., is contained
20174 * in the list returned by elm_slideshow_layouts_get()), this new
20175 * images layout will be used on the widget.
20177 * @see elm_slideshow_layouts_get() for more details
20179 * @ingroup Slideshow
20181 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20184 * Get the current slide layout in use for a given slideshow widget
20186 * @param obj The slideshow object
20187 * @return The current layout's name
20189 * @see elm_slideshow_layout_set() for more details
20191 * @ingroup Slideshow
20193 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20196 * Returns the list of @b layout names available, for a given
20197 * slideshow widget.
20199 * @param obj The slideshow object
20200 * @return The list of layouts (list of @b stringshared strings
20203 * Slideshow layouts will change how the widget is to dispose each
20204 * image item in its viewport, with regard to cropping, scaling,
20207 * The layouts, which come from @p obj's theme, must be an EDC
20208 * data item name @c "layouts" on the theme file, with (prefix)
20209 * names of EDC programs actually implementing them.
20211 * The available layouts for slideshows on the default theme are:
20212 * - @c "fullscreen" - item images with original aspect, scaled to
20213 * touch top and down slideshow borders or, if the image's heigh
20214 * is not enough, left and right slideshow borders.
20215 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20216 * one, but always leaving 10% of the slideshow's dimensions of
20217 * distance between the item image's borders and the slideshow
20218 * borders, for each axis.
20220 * @warning The stringshared strings get no new references
20221 * exclusive to the user grabbing the list, here, so if you'd like
20222 * to use them out of this call's context, you'd better @c
20223 * eina_stringshare_ref() them.
20225 * @see elm_slideshow_layout_set()
20227 * @ingroup Slideshow
20229 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20232 * Set the number of items to cache, on a given slideshow widget,
20233 * <b>before the current item</b>
20235 * @param obj The slideshow object
20236 * @param count Number of items to cache before the current one
20238 * The default value for this property is @c 2. See
20239 * @ref Slideshow_Caching "slideshow caching" for more details.
20241 * @see elm_slideshow_cache_before_get()
20243 * @ingroup Slideshow
20245 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20248 * Retrieve the number of items to cache, on a given slideshow widget,
20249 * <b>before the current item</b>
20251 * @param obj The slideshow object
20252 * @return The number of items set to be cached before the current one
20254 * @see elm_slideshow_cache_before_set() for more details
20256 * @ingroup Slideshow
20258 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20261 * Set the number of items to cache, on a given slideshow widget,
20262 * <b>after the current item</b>
20264 * @param obj The slideshow object
20265 * @param count Number of items to cache after the current one
20267 * The default value for this property is @c 2. See
20268 * @ref Slideshow_Caching "slideshow caching" for more details.
20270 * @see elm_slideshow_cache_after_get()
20272 * @ingroup Slideshow
20274 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20277 * Retrieve the number of items to cache, on a given slideshow widget,
20278 * <b>after the current item</b>
20280 * @param obj The slideshow object
20281 * @return The number of items set to be cached after the current one
20283 * @see elm_slideshow_cache_after_set() for more details
20285 * @ingroup Slideshow
20287 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20290 * Get the number of items stored in a given slideshow widget
20292 * @param obj The slideshow object
20293 * @return The number of items on @p obj, at the moment of this call
20295 * @ingroup Slideshow
20297 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20304 * @defgroup Fileselector File Selector
20306 * @image html img/widget/fileselector/preview-00.png
20307 * @image latex img/widget/fileselector/preview-00.eps
20309 * A file selector is a widget that allows a user to navigate
20310 * through a file system, reporting file selections back via its
20313 * It contains shortcut buttons for home directory (@c ~) and to
20314 * jump one directory upwards (..), as well as cancel/ok buttons to
20315 * confirm/cancel a given selection. After either one of those two
20316 * former actions, the file selector will issue its @c "done" smart
20319 * There's a text entry on it, too, showing the name of the current
20320 * selection. There's the possibility of making it editable, so it
20321 * is useful on file saving dialogs on applications, where one
20322 * gives a file name to save contents to, in a given directory in
20323 * the system. This custom file name will be reported on the @c
20324 * "done" smart callback (explained in sequence).
20326 * Finally, it has a view to display file system items into in two
20331 * If Elementary is built with support of the Ethumb thumbnailing
20332 * library, the second form of view will display preview thumbnails
20333 * of files which it supports.
20335 * Smart callbacks one can register to:
20337 * - @c "selected" - the user has clicked on a file (when not in
20338 * folders-only mode) or directory (when in folders-only mode)
20339 * - @c "directory,open" - the list has been populated with new
20340 * content (@c event_info is a pointer to the directory's
20341 * path, a @b stringshared string)
20342 * - @c "done" - the user has clicked on the "ok" or "cancel"
20343 * buttons (@c event_info is a pointer to the selection's
20344 * path, a @b stringshared string)
20346 * Here is an example on its usage:
20347 * @li @ref fileselector_example
20351 * @addtogroup Fileselector
20356 * Defines how a file selector widget is to layout its contents
20357 * (file system entries).
20359 typedef enum _Elm_Fileselector_Mode
20361 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20362 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20363 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20364 } Elm_Fileselector_Mode;
20367 * Add a new file selector widget to the given parent Elementary
20368 * (container) object
20370 * @param parent The parent object
20371 * @return a new file selector widget handle or @c NULL, on errors
20373 * This function inserts a new file selector widget on the canvas.
20375 * @ingroup Fileselector
20377 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20380 * Enable/disable the file name entry box where the user can type
20381 * in a name for a file, in a given file selector widget
20383 * @param obj The file selector object
20384 * @param is_save @c EINA_TRUE to make the file selector a "saving
20385 * dialog", @c EINA_FALSE otherwise
20387 * Having the entry editable is useful on file saving dialogs on
20388 * applications, where one gives a file name to save contents to,
20389 * in a given directory in the system. This custom file name will
20390 * be reported on the @c "done" smart callback.
20392 * @see elm_fileselector_is_save_get()
20394 * @ingroup Fileselector
20396 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20399 * Get whether the given file selector is in "saving dialog" mode
20401 * @param obj The file selector object
20402 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20403 * mode, @c EINA_FALSE otherwise (and on errors)
20405 * @see elm_fileselector_is_save_set() for more details
20407 * @ingroup Fileselector
20409 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20412 * Enable/disable folder-only view for a given file selector widget
20414 * @param obj The file selector object
20415 * @param only @c EINA_TRUE to make @p obj only display
20416 * directories, @c EINA_FALSE to make files to be displayed in it
20419 * If enabled, the widget's view will only display folder items,
20422 * @see elm_fileselector_folder_only_get()
20424 * @ingroup Fileselector
20426 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20429 * Get whether folder-only view is set for a given file selector
20432 * @param obj The file selector object
20433 * @return only @c EINA_TRUE if @p obj is only displaying
20434 * directories, @c EINA_FALSE if files are being displayed in it
20435 * too (and on errors)
20437 * @see elm_fileselector_folder_only_get()
20439 * @ingroup Fileselector
20441 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20444 * Enable/disable the "ok" and "cancel" buttons on a given file
20447 * @param obj The file selector object
20448 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20450 * @note A file selector without those buttons will never emit the
20451 * @c "done" smart event, and is only usable if one is just hooking
20452 * to the other two events.
20454 * @see elm_fileselector_buttons_ok_cancel_get()
20456 * @ingroup Fileselector
20458 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20461 * Get whether the "ok" and "cancel" buttons on a given file
20462 * selector widget are being shown.
20464 * @param obj The file selector object
20465 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20466 * otherwise (and on errors)
20468 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20470 * @ingroup Fileselector
20472 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 * Enable/disable a tree view in the given file selector widget,
20476 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20478 * @param obj The file selector object
20479 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20482 * In a tree view, arrows are created on the sides of directories,
20483 * allowing them to expand in place.
20485 * @note If it's in other mode, the changes made by this function
20486 * will only be visible when one switches back to "list" mode.
20488 * @see elm_fileselector_expandable_get()
20490 * @ingroup Fileselector
20492 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20495 * Get whether tree view is enabled for the given file selector
20498 * @param obj The file selector object
20499 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20500 * otherwise (and or errors)
20502 * @see elm_fileselector_expandable_set() for more details
20504 * @ingroup Fileselector
20506 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20509 * Set, programmatically, the @b directory that a given file
20510 * selector widget will display contents from
20512 * @param obj The file selector object
20513 * @param path The path to display in @p obj
20515 * This will change the @b directory that @p obj is displaying. It
20516 * will also clear the text entry area on the @p obj object, which
20517 * displays select files' names.
20519 * @see elm_fileselector_path_get()
20521 * @ingroup Fileselector
20523 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20526 * Get the parent directory's path that a given file selector
20527 * widget is displaying
20529 * @param obj The file selector object
20530 * @return The (full) path of the directory the file selector is
20531 * displaying, a @b stringshared string
20533 * @see elm_fileselector_path_set()
20535 * @ingroup Fileselector
20537 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20540 * Set, programmatically, the currently selected file/directory in
20541 * the given file selector widget
20543 * @param obj The file selector object
20544 * @param path The (full) path to a file or directory
20545 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20546 * latter case occurs if the directory or file pointed to do not
20549 * @see elm_fileselector_selected_get()
20551 * @ingroup Fileselector
20553 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20556 * Get the currently selected item's (full) path, in the given file
20559 * @param obj The file selector object
20560 * @return The absolute path of the selected item, a @b
20561 * stringshared string
20563 * @note Custom editions on @p obj object's text entry, if made,
20564 * will appear on the return string of this function, naturally.
20566 * @see elm_fileselector_selected_set() for more details
20568 * @ingroup Fileselector
20570 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20573 * Set the mode in which a given file selector widget will display
20574 * (layout) file system entries in its view
20576 * @param obj The file selector object
20577 * @param mode The mode of the fileselector, being it one of
20578 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20579 * first one, naturally, will display the files in a list. The
20580 * latter will make the widget to display its entries in a grid
20583 * @note By using elm_fileselector_expandable_set(), the user may
20584 * trigger a tree view for that list.
20586 * @note If Elementary is built with support of the Ethumb
20587 * thumbnailing library, the second form of view will display
20588 * preview thumbnails of files which it supports. You must have
20589 * elm_need_ethumb() called in your Elementary for thumbnailing to
20592 * @see elm_fileselector_expandable_set().
20593 * @see elm_fileselector_mode_get().
20595 * @ingroup Fileselector
20597 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20600 * Get the mode in which a given file selector widget is displaying
20601 * (layouting) file system entries in its view
20603 * @param obj The fileselector object
20604 * @return The mode in which the fileselector is at
20606 * @see elm_fileselector_mode_set() for more details
20608 * @ingroup Fileselector
20610 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20617 * @defgroup Progressbar Progress bar
20619 * The progress bar is a widget for visually representing the
20620 * progress status of a given job/task.
20622 * A progress bar may be horizontal or vertical. It may display an
20623 * icon besides it, as well as primary and @b units labels. The
20624 * former is meant to label the widget as a whole, while the
20625 * latter, which is formatted with floating point values (and thus
20626 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20627 * units"</c>), is meant to label the widget's <b>progress
20628 * value</b>. Label, icon and unit strings/objects are @b optional
20629 * for progress bars.
20631 * A progress bar may be @b inverted, in which state it gets its
20632 * values inverted, with high values being on the left or top and
20633 * low values on the right or bottom, as opposed to normally have
20634 * the low values on the former and high values on the latter,
20635 * respectively, for horizontal and vertical modes.
20637 * The @b span of the progress, as set by
20638 * elm_progressbar_span_size_set(), is its length (horizontally or
20639 * vertically), unless one puts size hints on the widget to expand
20640 * on desired directions, by any container. That length will be
20641 * scaled by the object or applications scaling factor. At any
20642 * point code can query the progress bar for its value with
20643 * elm_progressbar_value_get().
20645 * Available widget styles for progress bars:
20647 * - @c "wheel" (simple style, no text, no progression, only
20648 * "pulse" effect is available)
20650 * Default contents parts of the progressbar widget that you can use for are:
20651 * @li "elm.swallow.content" - A icon of the progressbar
20653 * Here is an example on its usage:
20654 * @li @ref progressbar_example
20658 * Add a new progress bar widget to the given parent Elementary
20659 * (container) object
20661 * @param parent The parent object
20662 * @return a new progress bar widget handle or @c NULL, on errors
20664 * This function inserts a new progress bar widget on the canvas.
20666 * @ingroup Progressbar
20668 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20671 * Set whether a given progress bar widget is at "pulsing mode" or
20674 * @param obj The progress bar object
20675 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20676 * @c EINA_FALSE to put it back to its default one
20678 * By default, progress bars will display values from the low to
20679 * high value boundaries. There are, though, contexts in which the
20680 * state of progression of a given task is @b unknown. For those,
20681 * one can set a progress bar widget to a "pulsing state", to give
20682 * the user an idea that some computation is being held, but
20683 * without exact progress values. In the default theme it will
20684 * animate its bar with the contents filling in constantly and back
20685 * to non-filled, in a loop. To start and stop this pulsing
20686 * animation, one has to explicitly call elm_progressbar_pulse().
20688 * @see elm_progressbar_pulse_get()
20689 * @see elm_progressbar_pulse()
20691 * @ingroup Progressbar
20693 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20696 * Get whether a given progress bar widget is at "pulsing mode" or
20699 * @param obj The progress bar object
20700 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20701 * if it's in the default one (and on errors)
20703 * @ingroup Progressbar
20705 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20708 * Start/stop a given progress bar "pulsing" animation, if its
20711 * @param obj The progress bar object
20712 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20713 * @c EINA_FALSE to @b stop it
20715 * @note This call won't do anything if @p obj is not under "pulsing mode".
20717 * @see elm_progressbar_pulse_set() for more details.
20719 * @ingroup Progressbar
20721 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20724 * Set the progress value (in percentage) on a given progress bar
20727 * @param obj The progress bar object
20728 * @param val The progress value (@b must be between @c 0.0 and @c
20731 * Use this call to set progress bar levels.
20733 * @note If you passes a value out of the specified range for @p
20734 * val, it will be interpreted as the @b closest of the @b boundary
20735 * values in the range.
20737 * @ingroup Progressbar
20739 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20742 * Get the progress value (in percentage) on a given progress bar
20745 * @param obj The progress bar object
20746 * @return The value of the progressbar
20748 * @see elm_progressbar_value_set() for more details
20750 * @ingroup Progressbar
20752 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20755 * Set the label of a given progress bar widget
20757 * @param obj The progress bar object
20758 * @param label The text label string, in UTF-8
20760 * @ingroup Progressbar
20761 * @deprecated use elm_object_text_set() instead.
20763 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20766 * Get the label of a given progress bar widget
20768 * @param obj The progressbar object
20769 * @return The text label string, in UTF-8
20771 * @ingroup Progressbar
20772 * @deprecated use elm_object_text_set() instead.
20774 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20777 * Set the icon object of a given progress bar widget
20779 * @param obj The progress bar object
20780 * @param icon The icon object
20782 * Use this call to decorate @p obj with an icon next to it.
20784 * @note Once the icon object is set, a previously set one will be
20785 * deleted. If you want to keep that old content object, use the
20786 * elm_progressbar_icon_unset() function.
20788 * @see elm_progressbar_icon_get()
20789 * @deprecated use elm_object_content_set() instead.
20791 * @ingroup Progressbar
20793 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20796 * Retrieve the icon object set for a given progress bar widget
20798 * @param obj The progress bar object
20799 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20800 * otherwise (and on errors)
20802 * @see elm_progressbar_icon_set() for more details
20803 * @deprecated use elm_object_content_set() instead.
20805 * @ingroup Progressbar
20807 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20810 * Unset an icon set on a given progress bar widget
20812 * @param obj The progress bar object
20813 * @return The icon object that was being used, if any was set, or
20814 * @c NULL, otherwise (and on errors)
20816 * This call will unparent and return the icon object which was set
20817 * for this widget, previously, on success.
20819 * @see elm_progressbar_icon_set() for more details
20820 * @deprecated use elm_object_content_unset() instead.
20822 * @ingroup Progressbar
20824 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20827 * Set the (exact) length of the bar region of a given progress bar
20830 * @param obj The progress bar object
20831 * @param size The length of the progress bar's bar region
20833 * This sets the minimum width (when in horizontal mode) or height
20834 * (when in vertical mode) of the actual bar area of the progress
20835 * bar @p obj. This in turn affects the object's minimum size. Use
20836 * this when you're not setting other size hints expanding on the
20837 * given direction (like weight and alignment hints) and you would
20838 * like it to have a specific size.
20840 * @note Icon, label and unit text around @p obj will require their
20841 * own space, which will make @p obj to require more the @p size,
20844 * @see elm_progressbar_span_size_get()
20846 * @ingroup Progressbar
20848 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20851 * Get the length set for the bar region of a given progress bar
20854 * @param obj The progress bar object
20855 * @return The length of the progress bar's bar region
20857 * If that size was not set previously, with
20858 * elm_progressbar_span_size_set(), this call will return @c 0.
20860 * @ingroup Progressbar
20862 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20865 * Set the format string for a given progress bar widget's units
20868 * @param obj The progress bar object
20869 * @param format The format string for @p obj's units label
20871 * If @c NULL is passed on @p format, it will make @p obj's units
20872 * area to be hidden completely. If not, it'll set the <b>format
20873 * string</b> for the units label's @b text. The units label is
20874 * provided a floating point value, so the units text is up display
20875 * at most one floating point falue. Note that the units label is
20876 * optional. Use a format string such as "%1.2f meters" for
20879 * @note The default format string for a progress bar is an integer
20880 * percentage, as in @c "%.0f %%".
20882 * @see elm_progressbar_unit_format_get()
20884 * @ingroup Progressbar
20886 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20889 * Retrieve the format string set for a given progress bar widget's
20892 * @param obj The progress bar object
20893 * @return The format set string for @p obj's units label or
20894 * @c NULL, if none was set (and on errors)
20896 * @see elm_progressbar_unit_format_set() for more details
20898 * @ingroup Progressbar
20900 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20903 * Set the orientation of a given progress bar widget
20905 * @param obj The progress bar object
20906 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20907 * @b horizontal, @c EINA_FALSE to make it @b vertical
20909 * Use this function to change how your progress bar is to be
20910 * disposed: vertically or horizontally.
20912 * @see elm_progressbar_horizontal_get()
20914 * @ingroup Progressbar
20916 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20919 * Retrieve the orientation of a given progress bar widget
20921 * @param obj The progress bar object
20922 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20923 * @c EINA_FALSE if it's @b vertical (and on errors)
20925 * @see elm_progressbar_horizontal_set() for more details
20927 * @ingroup Progressbar
20929 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20932 * Invert a given progress bar widget's displaying values order
20934 * @param obj The progress bar object
20935 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20936 * @c EINA_FALSE to bring it back to default, non-inverted values.
20938 * A progress bar may be @b inverted, in which state it gets its
20939 * values inverted, with high values being on the left or top and
20940 * low values on the right or bottom, as opposed to normally have
20941 * the low values on the former and high values on the latter,
20942 * respectively, for horizontal and vertical modes.
20944 * @see elm_progressbar_inverted_get()
20946 * @ingroup Progressbar
20948 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20951 * Get whether a given progress bar widget's displaying values are
20954 * @param obj The progress bar object
20955 * @return @c EINA_TRUE, if @p obj has inverted values,
20956 * @c EINA_FALSE otherwise (and on errors)
20958 * @see elm_progressbar_inverted_set() for more details
20960 * @ingroup Progressbar
20962 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20965 * @defgroup Separator Separator
20967 * @brief Separator is a very thin object used to separate other objects.
20969 * A separator can be vertical or horizontal.
20971 * @ref tutorial_separator is a good example of how to use a separator.
20975 * @brief Add a separator object to @p parent
20977 * @param parent The parent object
20979 * @return The separator object, or NULL upon failure
20981 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20983 * @brief Set the horizontal mode of a separator object
20985 * @param obj The separator object
20986 * @param horizontal If true, the separator is horizontal
20988 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20990 * @brief Get the horizontal mode of a separator object
20992 * @param obj The separator object
20993 * @return If true, the separator is horizontal
20995 * @see elm_separator_horizontal_set()
20997 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21003 * @defgroup Spinner Spinner
21004 * @ingroup Elementary
21006 * @image html img/widget/spinner/preview-00.png
21007 * @image latex img/widget/spinner/preview-00.eps
21009 * A spinner is a widget which allows the user to increase or decrease
21010 * numeric values using arrow buttons, or edit values directly, clicking
21011 * over it and typing the new value.
21013 * By default the spinner will not wrap and has a label
21014 * of "%.0f" (just showing the integer value of the double).
21016 * A spinner has a label that is formatted with floating
21017 * point values and thus accepts a printf-style format string, like
21020 * It also allows specific values to be replaced by pre-defined labels.
21022 * Smart callbacks one can register to:
21024 * - "changed" - Whenever the spinner value is changed.
21025 * - "delay,changed" - A short time after the value is changed by the user.
21026 * This will be called only when the user stops dragging for a very short
21027 * period or when they release their finger/mouse, so it avoids possibly
21028 * expensive reactions to the value change.
21030 * Available styles for it:
21032 * - @c "vertical": up/down buttons at the right side and text left aligned.
21034 * Here is an example on its usage:
21035 * @ref spinner_example
21039 * @addtogroup Spinner
21044 * Add a new spinner widget to the given parent Elementary
21045 * (container) object.
21047 * @param parent The parent object.
21048 * @return a new spinner widget handle or @c NULL, on errors.
21050 * This function inserts a new spinner widget on the canvas.
21055 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21058 * Set the format string of the displayed label.
21060 * @param obj The spinner object.
21061 * @param fmt The format string for the label display.
21063 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21064 * string for the label text. The label text is provided a floating point
21065 * value, so the label text can display up to 1 floating point value.
21066 * Note that this is optional.
21068 * Use a format string such as "%1.2f meters" for example, and it will
21069 * display values like: "3.14 meters" for a value equal to 3.14159.
21071 * Default is "%0.f".
21073 * @see elm_spinner_label_format_get()
21077 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21080 * Get the label format of the spinner.
21082 * @param obj The spinner object.
21083 * @return The text label format string in UTF-8.
21085 * @see elm_spinner_label_format_set() for details.
21089 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21092 * Set the minimum and maximum values for the spinner.
21094 * @param obj The spinner object.
21095 * @param min The minimum value.
21096 * @param max The maximum value.
21098 * Define the allowed range of values to be selected by the user.
21100 * If actual value is less than @p min, it will be updated to @p min. If it
21101 * is bigger then @p max, will be updated to @p max. Actual value can be
21102 * get with elm_spinner_value_get().
21104 * By default, min is equal to 0, and max is equal to 100.
21106 * @warning Maximum must be greater than minimum.
21108 * @see elm_spinner_min_max_get()
21112 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21115 * Get the minimum and maximum values of the spinner.
21117 * @param obj The spinner object.
21118 * @param min Pointer where to store the minimum value.
21119 * @param max Pointer where to store the maximum value.
21121 * @note If only one value is needed, the other pointer can be passed
21124 * @see elm_spinner_min_max_set() for details.
21128 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21131 * Set the step used to increment or decrement the spinner value.
21133 * @param obj The spinner object.
21134 * @param step The step value.
21136 * This value will be incremented or decremented to the displayed value.
21137 * It will be incremented while the user keep right or top arrow pressed,
21138 * and will be decremented while the user keep left or bottom arrow pressed.
21140 * The interval to increment / decrement can be set with
21141 * elm_spinner_interval_set().
21143 * By default step value is equal to 1.
21145 * @see elm_spinner_step_get()
21149 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21152 * Get the step used to increment or decrement the spinner value.
21154 * @param obj The spinner object.
21155 * @return The step value.
21157 * @see elm_spinner_step_get() for more details.
21161 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21164 * Set the value the spinner displays.
21166 * @param obj The spinner object.
21167 * @param val The value to be displayed.
21169 * Value will be presented on the label following format specified with
21170 * elm_spinner_format_set().
21172 * @warning The value must to be between min and max values. This values
21173 * are set by elm_spinner_min_max_set().
21175 * @see elm_spinner_value_get().
21176 * @see elm_spinner_format_set().
21177 * @see elm_spinner_min_max_set().
21181 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21184 * Get the value displayed by the spinner.
21186 * @param obj The spinner object.
21187 * @return The value displayed.
21189 * @see elm_spinner_value_set() for details.
21193 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21196 * Set whether the spinner should wrap when it reaches its
21197 * minimum or maximum value.
21199 * @param obj The spinner object.
21200 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21203 * Disabled by default. If disabled, when the user tries to increment the
21205 * but displayed value plus step value is bigger than maximum value,
21207 * won't allow it. The same happens when the user tries to decrement it,
21208 * but the value less step is less than minimum value.
21210 * When wrap is enabled, in such situations it will allow these changes,
21211 * but will get the value that would be less than minimum and subtracts
21212 * from maximum. Or add the value that would be more than maximum to
21216 * @li min value = 10
21217 * @li max value = 50
21218 * @li step value = 20
21219 * @li displayed value = 20
21221 * When the user decrement value (using left or bottom arrow), it will
21222 * displays @c 40, because max - (min - (displayed - step)) is
21223 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21225 * @see elm_spinner_wrap_get().
21229 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21232 * Get whether the spinner should wrap when it reaches its
21233 * minimum or maximum value.
21235 * @param obj The spinner object
21236 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21237 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21239 * @see elm_spinner_wrap_set() for details.
21243 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21246 * Set whether the spinner can be directly edited by the user or not.
21248 * @param obj The spinner object.
21249 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21250 * don't allow users to edit it directly.
21252 * Spinner objects can have edition @b disabled, in which state they will
21253 * be changed only by arrows.
21254 * Useful for contexts
21255 * where you don't want your users to interact with it writting the value.
21257 * when using special values, the user can see real value instead
21258 * of special label on edition.
21260 * It's enabled by default.
21262 * @see elm_spinner_editable_get()
21266 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21269 * Get whether the spinner can be directly edited by the user or not.
21271 * @param obj The spinner object.
21272 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21273 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21275 * @see elm_spinner_editable_set() for details.
21279 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21282 * Set a special string to display in the place of the numerical value.
21284 * @param obj The spinner object.
21285 * @param value The value to be replaced.
21286 * @param label The label to be used.
21288 * It's useful for cases when a user should select an item that is
21289 * better indicated by a label than a value. For example, weekdays or months.
21293 * sp = elm_spinner_add(win);
21294 * elm_spinner_min_max_set(sp, 1, 3);
21295 * elm_spinner_special_value_add(sp, 1, "January");
21296 * elm_spinner_special_value_add(sp, 2, "February");
21297 * elm_spinner_special_value_add(sp, 3, "March");
21298 * evas_object_show(sp);
21303 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21306 * Set the interval on time updates for an user mouse button hold
21307 * on spinner widgets' arrows.
21309 * @param obj The spinner object.
21310 * @param interval The (first) interval value in seconds.
21312 * This interval value is @b decreased while the user holds the
21313 * mouse pointer either incrementing or decrementing spinner's value.
21315 * This helps the user to get to a given value distant from the
21316 * current one easier/faster, as it will start to change quicker and
21317 * quicker on mouse button holds.
21319 * The calculation for the next change interval value, starting from
21320 * the one set with this call, is the previous interval divided by
21321 * @c 1.05, so it decreases a little bit.
21323 * The default starting interval value for automatic changes is
21326 * @see elm_spinner_interval_get()
21330 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21333 * Get the interval on time updates for an user mouse button hold
21334 * on spinner widgets' arrows.
21336 * @param obj The spinner object.
21337 * @return The (first) interval value, in seconds, set on it.
21339 * @see elm_spinner_interval_set() for more details.
21343 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21350 * @defgroup Index Index
21352 * @image html img/widget/index/preview-00.png
21353 * @image latex img/widget/index/preview-00.eps
21355 * An index widget gives you an index for fast access to whichever
21356 * group of other UI items one might have. It's a list of text
21357 * items (usually letters, for alphabetically ordered access).
21359 * Index widgets are by default hidden and just appear when the
21360 * user clicks over it's reserved area in the canvas. In its
21361 * default theme, it's an area one @ref Fingers "finger" wide on
21362 * the right side of the index widget's container.
21364 * When items on the index are selected, smart callbacks get
21365 * called, so that its user can make other container objects to
21366 * show a given area or child object depending on the index item
21367 * selected. You'd probably be using an index together with @ref
21368 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21371 * Smart events one can add callbacks for are:
21372 * - @c "changed" - When the selected index item changes. @c
21373 * event_info is the selected item's data pointer.
21374 * - @c "delay,changed" - When the selected index item changes, but
21375 * after a small idling period. @c event_info is the selected
21376 * item's data pointer.
21377 * - @c "selected" - When the user releases a mouse button and
21378 * selects an item. @c event_info is the selected item's data
21380 * - @c "level,up" - when the user moves a finger from the first
21381 * level to the second level
21382 * - @c "level,down" - when the user moves a finger from the second
21383 * level to the first level
21385 * The @c "delay,changed" event is so that it'll wait a small time
21386 * before actually reporting those events and, moreover, just the
21387 * last event happening on those time frames will actually be
21390 * Here are some examples on its usage:
21391 * @li @ref index_example_01
21392 * @li @ref index_example_02
21396 * @addtogroup Index
21400 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21403 * Add a new index widget to the given parent Elementary
21404 * (container) object
21406 * @param parent The parent object
21407 * @return a new index widget handle or @c NULL, on errors
21409 * This function inserts a new index widget on the canvas.
21413 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21416 * Set whether a given index widget is or not visible,
21419 * @param obj The index object
21420 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21422 * Not to be confused with visible as in @c evas_object_show() --
21423 * visible with regard to the widget's auto hiding feature.
21425 * @see elm_index_active_get()
21429 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21432 * Get whether a given index widget is currently visible or not.
21434 * @param obj The index object
21435 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21437 * @see elm_index_active_set() for more details
21441 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21444 * Set the items level for a given index widget.
21446 * @param obj The index object.
21447 * @param level @c 0 or @c 1, the currently implemented levels.
21449 * @see elm_index_item_level_get()
21453 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21456 * Get the items level set for a given index widget.
21458 * @param obj The index object.
21459 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21461 * @see elm_index_item_level_set() for more information
21465 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21468 * Returns the last selected item's data, for a given index widget.
21470 * @param obj The index object.
21471 * @return The item @b data associated to the last selected item on
21472 * @p obj (or @c NULL, on errors).
21474 * @warning The returned value is @b not an #Elm_Index_Item item
21475 * handle, but the data associated to it (see the @c item parameter
21476 * in elm_index_item_append(), as an example).
21480 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21483 * Append a new item on a given index widget.
21485 * @param obj The index object.
21486 * @param letter Letter under which the item should be indexed
21487 * @param item The item data to set for the index's item
21489 * Despite the most common usage of the @p letter argument is for
21490 * single char strings, one could use arbitrary strings as index
21493 * @c item will be the pointer returned back on @c "changed", @c
21494 * "delay,changed" and @c "selected" smart events.
21498 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21501 * Prepend a new item on a given index widget.
21503 * @param obj The index object.
21504 * @param letter Letter under which the item should be indexed
21505 * @param item The item data to set for the index's item
21507 * Despite the most common usage of the @p letter argument is for
21508 * single char strings, one could use arbitrary strings as index
21511 * @c item will be the pointer returned back on @c "changed", @c
21512 * "delay,changed" and @c "selected" smart events.
21516 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21519 * Append a new item, on a given index widget, <b>after the item
21520 * having @p relative as data</b>.
21522 * @param obj The index object.
21523 * @param letter Letter under which the item should be indexed
21524 * @param item The item data to set for the index's item
21525 * @param relative The item data of the index item to be the
21526 * predecessor of this new one
21528 * Despite the most common usage of the @p letter argument is for
21529 * single char strings, one could use arbitrary strings as index
21532 * @c item will be the pointer returned back on @c "changed", @c
21533 * "delay,changed" and @c "selected" smart events.
21535 * @note If @p relative is @c NULL or if it's not found to be data
21536 * set on any previous item on @p obj, this function will behave as
21537 * elm_index_item_append().
21541 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21544 * Prepend a new item, on a given index widget, <b>after the item
21545 * having @p relative as data</b>.
21547 * @param obj The index object.
21548 * @param letter Letter under which the item should be indexed
21549 * @param item The item data to set for the index's item
21550 * @param relative The item data of the index item to be the
21551 * successor of this new one
21553 * Despite the most common usage of the @p letter argument is for
21554 * single char strings, one could use arbitrary strings as index
21557 * @c item will be the pointer returned back on @c "changed", @c
21558 * "delay,changed" and @c "selected" smart events.
21560 * @note If @p relative is @c NULL or if it's not found to be data
21561 * set on any previous item on @p obj, this function will behave as
21562 * elm_index_item_prepend().
21566 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21569 * Insert a new item into the given index widget, using @p cmp_func
21570 * function to sort items (by item handles).
21572 * @param obj The index object.
21573 * @param letter Letter under which the item should be indexed
21574 * @param item The item data to set for the index's item
21575 * @param cmp_func The comparing function to be used to sort index
21576 * items <b>by #Elm_Index_Item item handles</b>
21577 * @param cmp_data_func A @b fallback function to be called for the
21578 * sorting of index items <b>by item data</b>). It will be used
21579 * when @p cmp_func returns @c 0 (equality), which means an index
21580 * item with provided item data already exists. To decide which
21581 * data item should be pointed to by the index item in question, @p
21582 * cmp_data_func will be used. If @p cmp_data_func returns a
21583 * non-negative value, the previous index item data will be
21584 * replaced by the given @p item pointer. If the previous data need
21585 * to be freed, it should be done by the @p cmp_data_func function,
21586 * because all references to it will be lost. If this function is
21587 * not provided (@c NULL is given), index items will be @b
21588 * duplicated, if @p cmp_func returns @c 0.
21590 * Despite the most common usage of the @p letter argument is for
21591 * single char strings, one could use arbitrary strings as index
21594 * @c item will be the pointer returned back on @c "changed", @c
21595 * "delay,changed" and @c "selected" smart events.
21599 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);
21602 * Remove an item from a given index widget, <b>to be referenced by
21603 * it's data value</b>.
21605 * @param obj The index object
21606 * @param item The item's data pointer for the item to be removed
21609 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21610 * that callback function will be called by this one.
21612 * @warning The item to be removed from @p obj will be found via
21613 * its item data pointer, and not by an #Elm_Index_Item handle.
21617 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21620 * Find a given index widget's item, <b>using item data</b>.
21622 * @param obj The index object
21623 * @param item The item data pointed to by the desired index item
21624 * @return The index item handle, if found, or @c NULL otherwise
21628 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21631 * Removes @b all items from a given index widget.
21633 * @param obj The index object.
21635 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21636 * that callback function will be called for each item in @p obj.
21640 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21643 * Go to a given items level on a index widget
21645 * @param obj The index object
21646 * @param level The index level (one of @c 0 or @c 1)
21650 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21653 * Return the data associated with a given index widget item
21655 * @param it The index widget item handle
21656 * @return The data associated with @p it
21658 * @see elm_index_item_data_set()
21662 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21665 * Set the data associated with a given index widget item
21667 * @param it The index widget item handle
21668 * @param data The new data pointer to set to @p it
21670 * This sets new item data on @p it.
21672 * @warning The old data pointer won't be touched by this function, so
21673 * the user had better to free that old data himself/herself.
21677 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21680 * Set the function to be called when a given index widget item is freed.
21682 * @param it The item to set the callback on
21683 * @param func The function to call on the item's deletion
21685 * When called, @p func will have both @c data and @c event_info
21686 * arguments with the @p it item's data value and, naturally, the
21687 * @c obj argument with a handle to the parent index widget.
21691 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21694 * Get the letter (string) set on a given index widget item.
21696 * @param it The index item handle
21697 * @return The letter string set on @p it
21701 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21705 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
21712 * @defgroup Photocam Photocam
21714 * @image html img/widget/photocam/preview-00.png
21715 * @image latex img/widget/photocam/preview-00.eps
21717 * This is a widget specifically for displaying high-resolution digital
21718 * camera photos giving speedy feedback (fast load), low memory footprint
21719 * and zooming and panning as well as fitting logic. It is entirely focused
21720 * on jpeg images, and takes advantage of properties of the jpeg format (via
21721 * evas loader features in the jpeg loader).
21723 * Signals that you can add callbacks for are:
21724 * @li "clicked" - This is called when a user has clicked the photo without
21726 * @li "press" - This is called when a user has pressed down on the photo.
21727 * @li "longpressed" - This is called when a user has pressed down on the
21728 * photo for a long time without dragging around.
21729 * @li "clicked,double" - This is called when a user has double-clicked the
21731 * @li "load" - Photo load begins.
21732 * @li "loaded" - This is called when the image file load is complete for the
21733 * first view (low resolution blurry version).
21734 * @li "load,detail" - Photo detailed data load begins.
21735 * @li "loaded,detail" - This is called when the image file load is complete
21736 * for the detailed image data (full resolution needed).
21737 * @li "zoom,start" - Zoom animation started.
21738 * @li "zoom,stop" - Zoom animation stopped.
21739 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21740 * @li "scroll" - the content has been scrolled (moved)
21741 * @li "scroll,anim,start" - scrolling animation has started
21742 * @li "scroll,anim,stop" - scrolling animation has stopped
21743 * @li "scroll,drag,start" - dragging the contents around has started
21744 * @li "scroll,drag,stop" - dragging the contents around has stopped
21746 * @ref tutorial_photocam shows the API in action.
21750 * @brief Types of zoom available.
21752 typedef enum _Elm_Photocam_Zoom_Mode
21754 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21755 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21756 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21757 ELM_PHOTOCAM_ZOOM_MODE_LAST
21758 } Elm_Photocam_Zoom_Mode;
21760 * @brief Add a new Photocam object
21762 * @param parent The parent object
21763 * @return The new object or NULL if it cannot be created
21765 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21767 * @brief Set the photo file to be shown
21769 * @param obj The photocam object
21770 * @param file The photo file
21771 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21773 * This sets (and shows) the specified file (with a relative or absolute
21774 * path) and will return a load error (same error that
21775 * evas_object_image_load_error_get() will return). The image will change and
21776 * adjust its size at this point and begin a background load process for this
21777 * photo that at some time in the future will be displayed at the full
21780 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21782 * @brief Returns the path of the current image file
21784 * @param obj The photocam object
21785 * @return Returns the path
21787 * @see elm_photocam_file_set()
21789 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21791 * @brief Set the zoom level of the photo
21793 * @param obj The photocam object
21794 * @param zoom The zoom level to set
21796 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21797 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21798 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21799 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21802 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21804 * @brief Get the zoom level of the photo
21806 * @param obj The photocam object
21807 * @return The current zoom level
21809 * This returns the current zoom level of the photocam object. Note that if
21810 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21811 * (which is the default), the zoom level may be changed at any time by the
21812 * photocam object itself to account for photo size and photocam viewpoer
21815 * @see elm_photocam_zoom_set()
21816 * @see elm_photocam_zoom_mode_set()
21818 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21820 * @brief Set the zoom mode
21822 * @param obj The photocam object
21823 * @param mode The desired mode
21825 * This sets the zoom mode to manual or one of several automatic levels.
21826 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21827 * elm_photocam_zoom_set() and will stay at that level until changed by code
21828 * or until zoom mode is changed. This is the default mode. The Automatic
21829 * modes will allow the photocam object to automatically adjust zoom mode
21830 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21831 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21832 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21833 * pixels within the frame are left unfilled.
21835 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21837 * @brief Get the zoom mode
21839 * @param obj The photocam object
21840 * @return The current zoom mode
21842 * This gets the current zoom mode of the photocam object.
21844 * @see elm_photocam_zoom_mode_set()
21846 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21848 * @brief Get the current image pixel width and height
21850 * @param obj The photocam object
21851 * @param w A pointer to the width return
21852 * @param h A pointer to the height return
21854 * This gets the current photo pixel width and height (for the original).
21855 * The size will be returned in the integers @p w and @p h that are pointed
21858 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21860 * @brief Get the area of the image that is currently shown
21863 * @param x A pointer to the X-coordinate of region
21864 * @param y A pointer to the Y-coordinate of region
21865 * @param w A pointer to the width
21866 * @param h A pointer to the height
21868 * @see elm_photocam_image_region_show()
21869 * @see elm_photocam_image_region_bring_in()
21871 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21873 * @brief Set the viewed portion of the image
21875 * @param obj The photocam object
21876 * @param x X-coordinate of region in image original pixels
21877 * @param y Y-coordinate of region in image original pixels
21878 * @param w Width of region in image original pixels
21879 * @param h Height of region in image original pixels
21881 * This shows the region of the image without using animation.
21883 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21885 * @brief Bring in the viewed portion of the image
21887 * @param obj The photocam object
21888 * @param x X-coordinate of region in image original pixels
21889 * @param y Y-coordinate of region in image original pixels
21890 * @param w Width of region in image original pixels
21891 * @param h Height of region in image original pixels
21893 * This shows the region of the image using animation.
21895 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21897 * @brief Set the paused state for photocam
21899 * @param obj The photocam object
21900 * @param paused The pause state to set
21902 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21903 * photocam. The default is off. This will stop zooming using animation on
21904 * zoom levels changes and change instantly. This will stop any existing
21905 * animations that are running.
21907 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21909 * @brief Get the paused state for photocam
21911 * @param obj The photocam object
21912 * @return The current paused state
21914 * This gets the current paused state for the photocam object.
21916 * @see elm_photocam_paused_set()
21918 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21920 * @brief Get the internal low-res image used for photocam
21922 * @param obj The photocam object
21923 * @return The internal image object handle, or NULL if none exists
21925 * This gets the internal image object inside photocam. Do not modify it. It
21926 * is for inspection only, and hooking callbacks to. Nothing else. It may be
21927 * deleted at any time as well.
21929 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21931 * @brief Set the photocam scrolling bouncing.
21933 * @param obj The photocam object
21934 * @param h_bounce bouncing for horizontal
21935 * @param v_bounce bouncing for vertical
21937 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21939 * @brief Get the photocam scrolling bouncing.
21941 * @param obj The photocam object
21942 * @param h_bounce bouncing for horizontal
21943 * @param v_bounce bouncing for vertical
21945 * @see elm_photocam_bounce_set()
21947 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21953 * @defgroup Map Map
21954 * @ingroup Elementary
21956 * @image html img/widget/map/preview-00.png
21957 * @image latex img/widget/map/preview-00.eps
21959 * This is a widget specifically for displaying a map. It uses basically
21960 * OpenStreetMap provider http://www.openstreetmap.org/,
21961 * but custom providers can be added.
21963 * It supports some basic but yet nice features:
21964 * @li zoom and scroll
21965 * @li markers with content to be displayed when user clicks over it
21966 * @li group of markers
21969 * Smart callbacks one can listen to:
21971 * - "clicked" - This is called when a user has clicked the map without
21973 * - "press" - This is called when a user has pressed down on the map.
21974 * - "longpressed" - This is called when a user has pressed down on the map
21975 * for a long time without dragging around.
21976 * - "clicked,double" - This is called when a user has double-clicked
21978 * - "load,detail" - Map detailed data load begins.
21979 * - "loaded,detail" - This is called when all currently visible parts of
21980 * the map are loaded.
21981 * - "zoom,start" - Zoom animation started.
21982 * - "zoom,stop" - Zoom animation stopped.
21983 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21984 * - "scroll" - the content has been scrolled (moved).
21985 * - "scroll,anim,start" - scrolling animation has started.
21986 * - "scroll,anim,stop" - scrolling animation has stopped.
21987 * - "scroll,drag,start" - dragging the contents around has started.
21988 * - "scroll,drag,stop" - dragging the contents around has stopped.
21989 * - "downloaded" - This is called when all currently required map images
21991 * - "route,load" - This is called when route request begins.
21992 * - "route,loaded" - This is called when route request ends.
21993 * - "name,load" - This is called when name request begins.
21994 * - "name,loaded- This is called when name request ends.
21996 * Available style for map widget:
21999 * Available style for markers:
22004 * Available style for marker bubble:
22007 * List of examples:
22008 * @li @ref map_example_01
22009 * @li @ref map_example_02
22010 * @li @ref map_example_03
22019 * @enum _Elm_Map_Zoom_Mode
22020 * @typedef Elm_Map_Zoom_Mode
22022 * Set map's zoom behavior. It can be set to manual or automatic.
22024 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22026 * Values <b> don't </b> work as bitmask, only one can be choosen.
22028 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22029 * than the scroller view.
22031 * @see elm_map_zoom_mode_set()
22032 * @see elm_map_zoom_mode_get()
22036 typedef enum _Elm_Map_Zoom_Mode
22038 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22039 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22040 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22041 ELM_MAP_ZOOM_MODE_LAST
22042 } Elm_Map_Zoom_Mode;
22045 * @enum _Elm_Map_Route_Sources
22046 * @typedef Elm_Map_Route_Sources
22048 * Set route service to be used. By default used source is
22049 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22051 * @see elm_map_route_source_set()
22052 * @see elm_map_route_source_get()
22056 typedef enum _Elm_Map_Route_Sources
22058 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22059 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. */
22060 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22061 ELM_MAP_ROUTE_SOURCE_LAST
22062 } Elm_Map_Route_Sources;
22064 typedef enum _Elm_Map_Name_Sources
22066 ELM_MAP_NAME_SOURCE_NOMINATIM,
22067 ELM_MAP_NAME_SOURCE_LAST
22068 } Elm_Map_Name_Sources;
22071 * @enum _Elm_Map_Route_Type
22072 * @typedef Elm_Map_Route_Type
22074 * Set type of transport used on route.
22076 * @see elm_map_route_add()
22080 typedef enum _Elm_Map_Route_Type
22082 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22083 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22084 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22085 ELM_MAP_ROUTE_TYPE_LAST
22086 } Elm_Map_Route_Type;
22089 * @enum _Elm_Map_Route_Method
22090 * @typedef Elm_Map_Route_Method
22092 * Set the routing method, what should be priorized, time or distance.
22094 * @see elm_map_route_add()
22098 typedef enum _Elm_Map_Route_Method
22100 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22101 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22102 ELM_MAP_ROUTE_METHOD_LAST
22103 } Elm_Map_Route_Method;
22105 typedef enum _Elm_Map_Name_Method
22107 ELM_MAP_NAME_METHOD_SEARCH,
22108 ELM_MAP_NAME_METHOD_REVERSE,
22109 ELM_MAP_NAME_METHOD_LAST
22110 } Elm_Map_Name_Method;
22112 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(). */
22113 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(). */
22114 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(). */
22115 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(). */
22116 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22117 typedef struct _Elm_Map_Track Elm_Map_Track;
22119 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. */
22120 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22121 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22122 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22124 typedef char *(*ElmMapModuleSourceFunc) (void);
22125 typedef int (*ElmMapModuleZoomMinFunc) (void);
22126 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22127 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22128 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22129 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22130 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22131 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22132 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22135 * Add a new map widget to the given parent Elementary (container) object.
22137 * @param parent The parent object.
22138 * @return a new map widget handle or @c NULL, on errors.
22140 * This function inserts a new map widget on the canvas.
22144 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22147 * Set the zoom level of the map.
22149 * @param obj The map object.
22150 * @param zoom The zoom level to set.
22152 * This sets the zoom level.
22154 * It will respect limits defined by elm_map_source_zoom_min_set() and
22155 * elm_map_source_zoom_max_set().
22157 * By default these values are 0 (world map) and 18 (maximum zoom).
22159 * This function should be used when zoom mode is set to
22160 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22161 * with elm_map_zoom_mode_set().
22163 * @see elm_map_zoom_mode_set().
22164 * @see elm_map_zoom_get().
22168 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22171 * Get the zoom level of the map.
22173 * @param obj The map object.
22174 * @return The current zoom level.
22176 * This returns the current zoom level of the map object.
22178 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22179 * (which is the default), the zoom level may be changed at any time by the
22180 * map object itself to account for map size and map viewport size.
22182 * @see elm_map_zoom_set() for details.
22186 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22189 * Set the zoom mode used by the map object.
22191 * @param obj The map object.
22192 * @param mode The zoom mode of the map, being it one of
22193 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22194 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22196 * This sets the zoom mode to manual or one of the automatic levels.
22197 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22198 * elm_map_zoom_set() and will stay at that level until changed by code
22199 * or until zoom mode is changed. This is the default mode.
22201 * The Automatic modes will allow the map object to automatically
22202 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22203 * adjust zoom so the map fits inside the scroll frame with no pixels
22204 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22205 * ensure no pixels within the frame are left unfilled. Do not forget that
22206 * the valid sizes are 2^zoom, consequently the map may be smaller than
22207 * the scroller view.
22209 * @see elm_map_zoom_set()
22213 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22216 * Get the zoom mode used by the map object.
22218 * @param obj The map object.
22219 * @return The zoom mode of the map, being it one of
22220 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22221 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22223 * This function returns the current zoom mode used by the map object.
22225 * @see elm_map_zoom_mode_set() for more details.
22229 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22232 * Get the current coordinates of the map.
22234 * @param obj The map object.
22235 * @param lon Pointer where to store longitude.
22236 * @param lat Pointer where to store latitude.
22238 * This gets the current center coordinates of the map object. It can be
22239 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22241 * @see elm_map_geo_region_bring_in()
22242 * @see elm_map_geo_region_show()
22246 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22249 * Animatedly bring in given coordinates to the center of the map.
22251 * @param obj The map object.
22252 * @param lon Longitude to center at.
22253 * @param lat Latitude to center at.
22255 * This causes map to jump to the given @p lat and @p lon coordinates
22256 * and show it (by scrolling) in the center of the viewport, if it is not
22257 * already centered. This will use animation to do so and take a period
22258 * of time to complete.
22260 * @see elm_map_geo_region_show() for a function to avoid animation.
22261 * @see elm_map_geo_region_get()
22265 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22268 * Show the given coordinates at the center of the map, @b immediately.
22270 * @param obj The map object.
22271 * @param lon Longitude to center at.
22272 * @param lat Latitude to center at.
22274 * This causes map to @b redraw its viewport's contents to the
22275 * region contining the given @p lat and @p lon, that will be moved to the
22276 * center of the map.
22278 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22279 * @see elm_map_geo_region_get()
22283 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22286 * Pause or unpause the map.
22288 * @param obj The map object.
22289 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22292 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22295 * The default is off.
22297 * This will stop zooming using animation, changing zoom levels will
22298 * change instantly. This will stop any existing animations that are running.
22300 * @see elm_map_paused_get()
22304 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22307 * Get a value whether map is paused or not.
22309 * @param obj The map object.
22310 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22311 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22313 * This gets the current paused state for the map object.
22315 * @see elm_map_paused_set() for details.
22319 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22322 * Set to show markers during zoom level changes or not.
22324 * @param obj The map object.
22325 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22328 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22331 * The default is off.
22333 * This will stop zooming using animation, changing zoom levels will
22334 * change instantly. This will stop any existing animations that are running.
22336 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22339 * The default is off.
22341 * Enabling it will force the map to stop displaying the markers during
22342 * zoom level changes. Set to on if you have a large number of markers.
22344 * @see elm_map_paused_markers_get()
22348 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22351 * Get a value whether markers will be displayed on zoom level changes or not
22353 * @param obj The map object.
22354 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22355 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22357 * This gets the current markers paused state for the map object.
22359 * @see elm_map_paused_markers_set() for details.
22363 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22366 * Get the information of downloading status.
22368 * @param obj The map object.
22369 * @param try_num Pointer where to store number of tiles being downloaded.
22370 * @param finish_num Pointer where to store number of tiles successfully
22373 * This gets the current downloading status for the map object, the number
22374 * of tiles being downloaded and the number of tiles already downloaded.
22378 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22381 * Convert a pixel coordinate (x,y) into a geographic coordinate
22382 * (longitude, latitude).
22384 * @param obj The map object.
22385 * @param x the coordinate.
22386 * @param y the coordinate.
22387 * @param size the size in pixels of the map.
22388 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22389 * @param lon Pointer where to store the longitude that correspond to x.
22390 * @param lat Pointer where to store the latitude that correspond to y.
22392 * @note Origin pixel point is the top left corner of the viewport.
22393 * Map zoom and size are taken on account.
22395 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22399 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);
22402 * Convert a geographic coordinate (longitude, latitude) into a pixel
22403 * coordinate (x, y).
22405 * @param obj The map object.
22406 * @param lon the longitude.
22407 * @param lat the latitude.
22408 * @param size the size in pixels of the map. The map is a square
22409 * and generally his size is : pow(2.0, zoom)*256.
22410 * @param x Pointer where to store the horizontal pixel coordinate that
22411 * correspond to the longitude.
22412 * @param y Pointer where to store the vertical pixel coordinate that
22413 * correspond to the latitude.
22415 * @note Origin pixel point is the top left corner of the viewport.
22416 * Map zoom and size are taken on account.
22418 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22422 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);
22425 * Convert a geographic coordinate (longitude, latitude) into a name
22428 * @param obj The map object.
22429 * @param lon the longitude.
22430 * @param lat the latitude.
22431 * @return name A #Elm_Map_Name handle for this coordinate.
22433 * To get the string for this address, elm_map_name_address_get()
22436 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22440 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22443 * Convert a name (address) into a geographic coordinate
22444 * (longitude, latitude).
22446 * @param obj The map object.
22447 * @param name The address.
22448 * @return name A #Elm_Map_Name handle for this address.
22450 * To get the longitude and latitude, elm_map_name_region_get()
22453 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22457 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22460 * Convert a pixel coordinate into a rotated pixel coordinate.
22462 * @param obj The map object.
22463 * @param x horizontal coordinate of the point to rotate.
22464 * @param y vertical coordinate of the point to rotate.
22465 * @param cx rotation's center horizontal position.
22466 * @param cy rotation's center vertical position.
22467 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22468 * @param xx Pointer where to store rotated x.
22469 * @param yy Pointer where to store rotated y.
22473 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);
22476 * Add a new marker to the map object.
22478 * @param obj The map object.
22479 * @param lon The longitude of the marker.
22480 * @param lat The latitude of the marker.
22481 * @param clas The class, to use when marker @b isn't grouped to others.
22482 * @param clas_group The class group, to use when marker is grouped to others
22483 * @param data The data passed to the callbacks.
22485 * @return The created marker or @c NULL upon failure.
22487 * A marker will be created and shown in a specific point of the map, defined
22488 * by @p lon and @p lat.
22490 * It will be displayed using style defined by @p class when this marker
22491 * is displayed alone (not grouped). A new class can be created with
22492 * elm_map_marker_class_new().
22494 * If the marker is grouped to other markers, it will be displayed with
22495 * style defined by @p class_group. Markers with the same group are grouped
22496 * if they are close. A new group class can be created with
22497 * elm_map_marker_group_class_new().
22499 * Markers created with this method can be deleted with
22500 * elm_map_marker_remove().
22502 * A marker can have associated content to be displayed by a bubble,
22503 * when a user click over it, as well as an icon. These objects will
22504 * be fetch using class' callback functions.
22506 * @see elm_map_marker_class_new()
22507 * @see elm_map_marker_group_class_new()
22508 * @see elm_map_marker_remove()
22512 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);
22515 * Set the maximum numbers of markers' content to be displayed in a group.
22517 * @param obj The map object.
22518 * @param max The maximum numbers of items displayed in a bubble.
22520 * A bubble will be displayed when the user clicks over the group,
22521 * and will place the content of markers that belong to this group
22524 * A group can have a long list of markers, consequently the creation
22525 * of the content of the bubble can be very slow.
22527 * In order to avoid this, a maximum number of items is displayed
22530 * By default this number is 30.
22532 * Marker with the same group class are grouped if they are close.
22534 * @see elm_map_marker_add()
22538 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22541 * Remove a marker from the map.
22543 * @param marker The marker to remove.
22545 * @see elm_map_marker_add()
22549 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22552 * Get the current coordinates of the marker.
22554 * @param marker marker.
22555 * @param lat Pointer where to store the marker's latitude.
22556 * @param lon Pointer where to store the marker's longitude.
22558 * These values are set when adding markers, with function
22559 * elm_map_marker_add().
22561 * @see elm_map_marker_add()
22565 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22568 * Animatedly bring in given marker to the center of the map.
22570 * @param marker The marker to center at.
22572 * This causes map to jump to the given @p marker's coordinates
22573 * and show it (by scrolling) in the center of the viewport, if it is not
22574 * already centered. This will use animation to do so and take a period
22575 * of time to complete.
22577 * @see elm_map_marker_show() for a function to avoid animation.
22578 * @see elm_map_marker_region_get()
22582 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22585 * Show the given marker at the center of the map, @b immediately.
22587 * @param marker The marker to center at.
22589 * This causes map to @b redraw its viewport's contents to the
22590 * region contining the given @p marker's coordinates, that will be
22591 * moved to the center of the map.
22593 * @see elm_map_marker_bring_in() for a function to move with animation.
22594 * @see elm_map_markers_list_show() if more than one marker need to be
22596 * @see elm_map_marker_region_get()
22600 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22603 * Move and zoom the map to display a list of markers.
22605 * @param markers A list of #Elm_Map_Marker handles.
22607 * The map will be centered on the center point of the markers in the list.
22608 * Then the map will be zoomed in order to fit the markers using the maximum
22609 * zoom which allows display of all the markers.
22611 * @warning All the markers should belong to the same map object.
22613 * @see elm_map_marker_show() to show a single marker.
22614 * @see elm_map_marker_bring_in()
22618 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22621 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22623 * @param marker The marker wich content should be returned.
22624 * @return Return the evas object if it exists, else @c NULL.
22626 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22627 * elm_map_marker_class_get_cb_set() should be used.
22629 * This content is what will be inside the bubble that will be displayed
22630 * when an user clicks over the marker.
22632 * This returns the actual Evas object used to be placed inside
22633 * the bubble. This may be @c NULL, as it may
22634 * not have been created or may have been deleted, at any time, by
22635 * the map. <b>Do not modify this object</b> (move, resize,
22636 * show, hide, etc.), as the map is controlling it. This
22637 * function is for querying, emitting custom signals or hooking
22638 * lower level callbacks for events on that object. Do not delete
22639 * this object under any circumstances.
22643 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22646 * Update the marker
22648 * @param marker The marker to be updated.
22650 * If a content is set to this marker, it will call function to delete it,
22651 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22652 * #ElmMapMarkerGetFunc.
22654 * These functions are set for the marker class with
22655 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22659 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22662 * Close all the bubbles opened by the user.
22664 * @param obj The map object.
22666 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22667 * when the user clicks on a marker.
22669 * This functions is set for the marker class with
22670 * elm_map_marker_class_get_cb_set().
22674 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22677 * Create a new group class.
22679 * @param obj The map object.
22680 * @return Returns the new group class.
22682 * Each marker must be associated to a group class. Markers in the same
22683 * group are grouped if they are close.
22685 * The group class defines the style of the marker when a marker is grouped
22686 * to others markers. When it is alone, another class will be used.
22688 * A group class will need to be provided when creating a marker with
22689 * elm_map_marker_add().
22691 * Some properties and functions can be set by class, as:
22692 * - style, with elm_map_group_class_style_set()
22693 * - data - to be associated to the group class. It can be set using
22694 * elm_map_group_class_data_set().
22695 * - min zoom to display markers, set with
22696 * elm_map_group_class_zoom_displayed_set().
22697 * - max zoom to group markers, set using
22698 * elm_map_group_class_zoom_grouped_set().
22699 * - visibility - set if markers will be visible or not, set with
22700 * elm_map_group_class_hide_set().
22701 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22702 * It can be set using elm_map_group_class_icon_cb_set().
22704 * @see elm_map_marker_add()
22705 * @see elm_map_group_class_style_set()
22706 * @see elm_map_group_class_data_set()
22707 * @see elm_map_group_class_zoom_displayed_set()
22708 * @see elm_map_group_class_zoom_grouped_set()
22709 * @see elm_map_group_class_hide_set()
22710 * @see elm_map_group_class_icon_cb_set()
22714 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22717 * Set the marker's style of a group class.
22719 * @param clas The group class.
22720 * @param style The style to be used by markers.
22722 * Each marker must be associated to a group class, and will use the style
22723 * defined by such class when grouped to other markers.
22725 * The following styles are provided by default theme:
22726 * @li @c radio - blue circle
22727 * @li @c radio2 - green circle
22730 * @see elm_map_group_class_new() for more details.
22731 * @see elm_map_marker_add()
22735 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22738 * Set the icon callback function of a group class.
22740 * @param clas The group class.
22741 * @param icon_get The callback function that will return the icon.
22743 * Each marker must be associated to a group class, and it can display a
22744 * custom icon. The function @p icon_get must return this icon.
22746 * @see elm_map_group_class_new() for more details.
22747 * @see elm_map_marker_add()
22751 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22754 * Set the data associated to the group class.
22756 * @param clas The group class.
22757 * @param data The new user data.
22759 * This data will be passed for callback functions, like icon get callback,
22760 * that can be set with elm_map_group_class_icon_cb_set().
22762 * If a data was previously set, the object will lose the pointer for it,
22763 * so if needs to be freed, you must do it yourself.
22765 * @see elm_map_group_class_new() for more details.
22766 * @see elm_map_group_class_icon_cb_set()
22767 * @see elm_map_marker_add()
22771 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22774 * Set the minimum zoom from where the markers are displayed.
22776 * @param clas The group class.
22777 * @param zoom The minimum zoom.
22779 * Markers only will be displayed when the map is displayed at @p zoom
22782 * @see elm_map_group_class_new() for more details.
22783 * @see elm_map_marker_add()
22787 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22790 * Set the zoom from where the markers are no more grouped.
22792 * @param clas The group class.
22793 * @param zoom The maximum zoom.
22795 * Markers only will be grouped when the map is displayed at
22796 * less than @p zoom.
22798 * @see elm_map_group_class_new() for more details.
22799 * @see elm_map_marker_add()
22803 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22806 * Set if the markers associated to the group class @clas are hidden or not.
22808 * @param clas The group class.
22809 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22812 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22817 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22820 * Create a new marker class.
22822 * @param obj The map object.
22823 * @return Returns the new group class.
22825 * Each marker must be associated to a class.
22827 * The marker class defines the style of the marker when a marker is
22828 * displayed alone, i.e., not grouped to to others markers. When grouped
22829 * it will use group class style.
22831 * A marker class will need to be provided when creating a marker with
22832 * elm_map_marker_add().
22834 * Some properties and functions can be set by class, as:
22835 * - style, with elm_map_marker_class_style_set()
22836 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22837 * It can be set using elm_map_marker_class_icon_cb_set().
22838 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22839 * Set using elm_map_marker_class_get_cb_set().
22840 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22841 * Set using elm_map_marker_class_del_cb_set().
22843 * @see elm_map_marker_add()
22844 * @see elm_map_marker_class_style_set()
22845 * @see elm_map_marker_class_icon_cb_set()
22846 * @see elm_map_marker_class_get_cb_set()
22847 * @see elm_map_marker_class_del_cb_set()
22851 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22854 * Set the marker's style of a marker class.
22856 * @param clas The marker class.
22857 * @param style The style to be used by markers.
22859 * Each marker must be associated to a marker class, and will use the style
22860 * defined by such class when alone, i.e., @b not grouped to other markers.
22862 * The following styles are provided by default theme:
22867 * @see elm_map_marker_class_new() for more details.
22868 * @see elm_map_marker_add()
22872 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22875 * Set the icon callback function of a marker class.
22877 * @param clas The marker class.
22878 * @param icon_get The callback function that will return the icon.
22880 * Each marker must be associated to a marker class, and it can display a
22881 * custom icon. The function @p icon_get must return this icon.
22883 * @see elm_map_marker_class_new() for more details.
22884 * @see elm_map_marker_add()
22888 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22891 * Set the bubble content callback function of a marker class.
22893 * @param clas The marker class.
22894 * @param get The callback function that will return the content.
22896 * Each marker must be associated to a marker class, and it can display a
22897 * a content on a bubble that opens when the user click over the marker.
22898 * The function @p get must return this content object.
22900 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22903 * @see elm_map_marker_class_new() for more details.
22904 * @see elm_map_marker_class_del_cb_set()
22905 * @see elm_map_marker_add()
22909 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22912 * Set the callback function used to delete bubble content of a marker class.
22914 * @param clas The marker class.
22915 * @param del The callback function that will delete the content.
22917 * Each marker must be associated to a marker class, and it can display a
22918 * a content on a bubble that opens when the user click over the marker.
22919 * The function to return such content can be set with
22920 * elm_map_marker_class_get_cb_set().
22922 * If this content must be freed, a callback function need to be
22923 * set for that task with this function.
22925 * If this callback is defined it will have to delete (or not) the
22926 * object inside, but if the callback is not defined the object will be
22927 * destroyed with evas_object_del().
22929 * @see elm_map_marker_class_new() for more details.
22930 * @see elm_map_marker_class_get_cb_set()
22931 * @see elm_map_marker_add()
22935 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22938 * Get the list of available sources.
22940 * @param obj The map object.
22941 * @return The source names list.
22943 * It will provide a list with all available sources, that can be set as
22944 * current source with elm_map_source_name_set(), or get with
22945 * elm_map_source_name_get().
22947 * Available sources:
22953 * @see elm_map_source_name_set() for more details.
22954 * @see elm_map_source_name_get()
22958 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22961 * Set the source of the map.
22963 * @param obj The map object.
22964 * @param source The source to be used.
22966 * Map widget retrieves images that composes the map from a web service.
22967 * This web service can be set with this method.
22969 * A different service can return a different maps with different
22970 * information and it can use different zoom values.
22972 * The @p source_name need to match one of the names provided by
22973 * elm_map_source_names_get().
22975 * The current source can be get using elm_map_source_name_get().
22977 * @see elm_map_source_names_get()
22978 * @see elm_map_source_name_get()
22983 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22986 * Get the name of currently used source.
22988 * @param obj The map object.
22989 * @return Returns the name of the source in use.
22991 * @see elm_map_source_name_set() for more details.
22995 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22998 * Set the source of the route service to be used by the map.
23000 * @param obj The map object.
23001 * @param source The route service to be used, being it one of
23002 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23003 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23005 * Each one has its own algorithm, so the route retrieved may
23006 * differ depending on the source route. Now, only the default is working.
23008 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23009 * http://www.yournavigation.org/.
23011 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23012 * assumptions. Its routing core is based on Contraction Hierarchies.
23014 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23016 * @see elm_map_route_source_get().
23020 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23023 * Get the current route source.
23025 * @param obj The map object.
23026 * @return The source of the route service used by the map.
23028 * @see elm_map_route_source_set() for details.
23032 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23035 * Set the minimum zoom of the source.
23037 * @param obj The map object.
23038 * @param zoom New minimum zoom value to be used.
23040 * By default, it's 0.
23044 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23047 * Get the minimum zoom of the source.
23049 * @param obj The map object.
23050 * @return Returns the minimum zoom of the source.
23052 * @see elm_map_source_zoom_min_set() for details.
23056 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23059 * Set the maximum zoom of the source.
23061 * @param obj The map object.
23062 * @param zoom New maximum zoom value to be used.
23064 * By default, it's 18.
23068 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23071 * Get the maximum zoom of the source.
23073 * @param obj The map object.
23074 * @return Returns the maximum zoom of the source.
23076 * @see elm_map_source_zoom_min_set() for details.
23080 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23083 * Set the user agent used by the map object to access routing services.
23085 * @param obj The map object.
23086 * @param user_agent The user agent to be used by the map.
23088 * User agent is a client application implementing a network protocol used
23089 * in communications within a client–server distributed computing system
23091 * The @p user_agent identification string will transmitted in a header
23092 * field @c User-Agent.
23094 * @see elm_map_user_agent_get()
23098 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23101 * Get the user agent used by the map object.
23103 * @param obj The map object.
23104 * @return The user agent identification string used by the map.
23106 * @see elm_map_user_agent_set() for details.
23110 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23113 * Add a new route to the map object.
23115 * @param obj The map object.
23116 * @param type The type of transport to be considered when tracing a route.
23117 * @param method The routing method, what should be priorized.
23118 * @param flon The start longitude.
23119 * @param flat The start latitude.
23120 * @param tlon The destination longitude.
23121 * @param tlat The destination latitude.
23123 * @return The created route or @c NULL upon failure.
23125 * A route will be traced by point on coordinates (@p flat, @p flon)
23126 * to point on coordinates (@p tlat, @p tlon), using the route service
23127 * set with elm_map_route_source_set().
23129 * It will take @p type on consideration to define the route,
23130 * depending if the user will be walking or driving, the route may vary.
23131 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23132 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23134 * Another parameter is what the route should priorize, the minor distance
23135 * or the less time to be spend on the route. So @p method should be one
23136 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23138 * Routes created with this method can be deleted with
23139 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23140 * and distance can be get with elm_map_route_distance_get().
23142 * @see elm_map_route_remove()
23143 * @see elm_map_route_color_set()
23144 * @see elm_map_route_distance_get()
23145 * @see elm_map_route_source_set()
23149 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);
23152 * Remove a route from the map.
23154 * @param route The route to remove.
23156 * @see elm_map_route_add()
23160 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23163 * Set the route color.
23165 * @param route The route object.
23166 * @param r Red channel value, from 0 to 255.
23167 * @param g Green channel value, from 0 to 255.
23168 * @param b Blue channel value, from 0 to 255.
23169 * @param a Alpha channel value, from 0 to 255.
23171 * It uses an additive color model, so each color channel represents
23172 * how much of each primary colors must to be used. 0 represents
23173 * ausence of this color, so if all of the three are set to 0,
23174 * the color will be black.
23176 * These component values should be integers in the range 0 to 255,
23177 * (single 8-bit byte).
23179 * This sets the color used for the route. By default, it is set to
23180 * solid red (r = 255, g = 0, b = 0, a = 255).
23182 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23184 * @see elm_map_route_color_get()
23188 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23191 * Get the route color.
23193 * @param route The route object.
23194 * @param r Pointer where to store the red channel value.
23195 * @param g Pointer where to store the green channel value.
23196 * @param b Pointer where to store the blue channel value.
23197 * @param a Pointer where to store the alpha channel value.
23199 * @see elm_map_route_color_set() for details.
23203 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23206 * Get the route distance in kilometers.
23208 * @param route The route object.
23209 * @return The distance of route (unit : km).
23213 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23216 * Get the information of route nodes.
23218 * @param route The route object.
23219 * @return Returns a string with the nodes of route.
23223 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23226 * Get the information of route waypoint.
23228 * @param route the route object.
23229 * @return Returns a string with information about waypoint of route.
23233 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23236 * Get the address of the name.
23238 * @param name The name handle.
23239 * @return Returns the address string of @p name.
23241 * This gets the coordinates of the @p name, created with one of the
23242 * conversion functions.
23244 * @see elm_map_utils_convert_name_into_coord()
23245 * @see elm_map_utils_convert_coord_into_name()
23249 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23252 * Get the current coordinates of the name.
23254 * @param name The name handle.
23255 * @param lat Pointer where to store the latitude.
23256 * @param lon Pointer where to store The longitude.
23258 * This gets the coordinates of the @p name, created with one of the
23259 * conversion functions.
23261 * @see elm_map_utils_convert_name_into_coord()
23262 * @see elm_map_utils_convert_coord_into_name()
23266 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23269 * Remove a name from the map.
23271 * @param name The name to remove.
23273 * Basically the struct handled by @p name will be freed, so convertions
23274 * between address and coordinates will be lost.
23276 * @see elm_map_utils_convert_name_into_coord()
23277 * @see elm_map_utils_convert_coord_into_name()
23281 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23286 * @param obj The map object.
23287 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23288 * @param cx Rotation's center horizontal position.
23289 * @param cy Rotation's center vertical position.
23291 * @see elm_map_rotate_get()
23295 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23298 * Get the rotate degree of the map
23300 * @param obj The map object
23301 * @param degree Pointer where to store degrees from 0.0 to 360.0
23302 * to rotate arount Z axis.
23303 * @param cx Pointer where to store rotation's center horizontal position.
23304 * @param cy Pointer where to store rotation's center vertical position.
23306 * @see elm_map_rotate_set() to set map rotation.
23310 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);
23313 * Enable or disable mouse wheel to be used to zoom in / out the map.
23315 * @param obj The map object.
23316 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23319 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23321 * It's disabled by default.
23323 * @see elm_map_wheel_disabled_get()
23327 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23330 * Get a value whether mouse wheel is enabled or not.
23332 * @param obj The map object.
23333 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23334 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23336 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23338 * @see elm_map_wheel_disabled_set() for details.
23342 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23346 * Add a track on the map
23348 * @param obj The map object.
23349 * @param emap The emap route object.
23350 * @return The route object. This is an elm object of type Route.
23352 * @see elm_route_add() for details.
23356 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23360 * Remove a track from the map
23362 * @param obj The map object.
23363 * @param route The track to remove.
23367 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23374 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23376 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23378 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23379 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23380 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23381 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23385 * @defgroup Panel Panel
23387 * @image html img/widget/panel/preview-00.png
23388 * @image latex img/widget/panel/preview-00.eps
23390 * @brief A panel is a type of animated container that contains subobjects.
23391 * It can be expanded or contracted by clicking the button on it's edge.
23393 * Orientations are as follows:
23394 * @li ELM_PANEL_ORIENT_TOP
23395 * @li ELM_PANEL_ORIENT_LEFT
23396 * @li ELM_PANEL_ORIENT_RIGHT
23398 * To set/get/unset the content of the panel, you can use
23399 * elm_object_content_set/get/unset APIs.
23400 * Once the content object is set, a previously set one will be deleted.
23401 * If you want to keep that old content object, use the
23402 * elm_object_content_unset() function
23404 * @ref tutorial_panel shows one way to use this widget.
23407 typedef enum _Elm_Panel_Orient
23409 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23410 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23411 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23412 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23413 } Elm_Panel_Orient;
23415 * @brief Adds a panel object
23417 * @param parent The parent object
23419 * @return The panel object, or NULL on failure
23421 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23423 * @brief Sets the orientation of the panel
23425 * @param parent The parent object
23426 * @param orient The panel orientation. Can be one of the following:
23427 * @li ELM_PANEL_ORIENT_TOP
23428 * @li ELM_PANEL_ORIENT_LEFT
23429 * @li ELM_PANEL_ORIENT_RIGHT
23431 * Sets from where the panel will (dis)appear.
23433 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23435 * @brief Get the orientation of the panel.
23437 * @param obj The panel object
23438 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23440 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23442 * @brief Set the content of the panel.
23444 * @param obj The panel object
23445 * @param content The panel content
23447 * Once the content object is set, a previously set one will be deleted.
23448 * If you want to keep that old content object, use the
23449 * elm_panel_content_unset() function.
23451 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23453 * @brief Get the content of the panel.
23455 * @param obj The panel object
23456 * @return The content that is being used
23458 * Return the content object which is set for this widget.
23460 * @see elm_panel_content_set()
23462 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23464 * @brief Unset the content of the panel.
23466 * @param obj The panel object
23467 * @return The content that was being used
23469 * Unparent and return the content object which was set for this widget.
23471 * @see elm_panel_content_set()
23473 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23475 * @brief Set the state of the panel.
23477 * @param obj The panel object
23478 * @param hidden If true, the panel will run the animation to contract
23480 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23482 * @brief Get the state of the panel.
23484 * @param obj The panel object
23485 * @param hidden If true, the panel is in the "hide" state
23487 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23489 * @brief Toggle the hidden state of the panel from code
23491 * @param obj The panel object
23493 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23499 * @defgroup Panes Panes
23500 * @ingroup Elementary
23502 * @image html img/widget/panes/preview-00.png
23503 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23505 * @image html img/panes.png
23506 * @image latex img/panes.eps width=\textwidth
23508 * The panes adds a dragable bar between two contents. When dragged
23509 * this bar will resize contents size.
23511 * Panes can be displayed vertically or horizontally, and contents
23512 * size proportion can be customized (homogeneous by default).
23514 * Smart callbacks one can listen to:
23515 * - "press" - The panes has been pressed (button wasn't released yet).
23516 * - "unpressed" - The panes was released after being pressed.
23517 * - "clicked" - The panes has been clicked>
23518 * - "clicked,double" - The panes has been double clicked
23520 * Available styles for it:
23523 * Default contents parts of the panes widget that you can use for are:
23524 * @li "elm.swallow.left" - A leftside content of the panes
23525 * @li "elm.swallow.right" - A rightside content of the panes
23527 * If panes is displayed vertically, left content will be displayed at
23530 * Here is an example on its usage:
23531 * @li @ref panes_example
23534 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23535 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23538 * @addtogroup Panes
23543 * Add a new panes widget to the given parent Elementary
23544 * (container) object.
23546 * @param parent The parent object.
23547 * @return a new panes widget handle or @c NULL, on errors.
23549 * This function inserts a new panes widget on the canvas.
23553 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23556 * Set the left content of the panes widget.
23558 * @param obj The panes object.
23559 * @param content The new left content object.
23561 * Once the content object is set, a previously set one will be deleted.
23562 * If you want to keep that old content object, use the
23563 * elm_panes_content_left_unset() function.
23565 * If panes is displayed vertically, left content will be displayed at
23568 * @see elm_panes_content_left_get()
23569 * @see elm_panes_content_right_set() to set content on the other side.
23573 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23576 * Set the right content of the panes widget.
23578 * @param obj The panes object.
23579 * @param content The new right content object.
23581 * Once the content object is set, a previously set one will be deleted.
23582 * If you want to keep that old content object, use the
23583 * elm_panes_content_right_unset() function.
23585 * If panes is displayed vertically, left content will be displayed at
23588 * @see elm_panes_content_right_get()
23589 * @see elm_panes_content_left_set() to set content on the other side.
23593 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23596 * Get the left content of the panes.
23598 * @param obj The panes object.
23599 * @return The left content object that is being used.
23601 * Return the left content object which is set for this widget.
23603 * @see elm_panes_content_left_set() for details.
23607 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23610 * Get the right content of the panes.
23612 * @param obj The panes object
23613 * @return The right content object that is being used
23615 * Return the right content object which is set for this widget.
23617 * @see elm_panes_content_right_set() for details.
23621 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23624 * Unset the left content used for the panes.
23626 * @param obj The panes object.
23627 * @return The left content object that was being used.
23629 * Unparent and return the left content object which was set for this widget.
23631 * @see elm_panes_content_left_set() for details.
23632 * @see elm_panes_content_left_get().
23636 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23639 * Unset the right content used for the panes.
23641 * @param obj The panes object.
23642 * @return The right content object that was being used.
23644 * Unparent and return the right content object which was set for this
23647 * @see elm_panes_content_right_set() for details.
23648 * @see elm_panes_content_right_get().
23652 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23655 * Get the size proportion of panes widget's left side.
23657 * @param obj The panes object.
23658 * @return float value between 0.0 and 1.0 representing size proportion
23661 * @see elm_panes_content_left_size_set() for more details.
23665 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23668 * Set the size proportion of panes widget's left side.
23670 * @param obj The panes object.
23671 * @param size Value between 0.0 and 1.0 representing size proportion
23674 * By default it's homogeneous, i.e., both sides have the same size.
23676 * If something different is required, it can be set with this function.
23677 * For example, if the left content should be displayed over
23678 * 75% of the panes size, @p size should be passed as @c 0.75.
23679 * This way, right content will be resized to 25% of panes size.
23681 * If displayed vertically, left content is displayed at top, and
23682 * right content at bottom.
23684 * @note This proportion will change when user drags the panes bar.
23686 * @see elm_panes_content_left_size_get()
23690 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23693 * Set the orientation of a given panes widget.
23695 * @param obj The panes object.
23696 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23697 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23699 * Use this function to change how your panes is to be
23700 * disposed: vertically or horizontally.
23702 * By default it's displayed horizontally.
23704 * @see elm_panes_horizontal_get()
23708 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23711 * Retrieve the orientation of a given panes widget.
23713 * @param obj The panes object.
23714 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23715 * @c EINA_FALSE if it's @b vertical (and on errors).
23717 * @see elm_panes_horizontal_set() for more details.
23721 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23722 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23723 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23730 * @defgroup Flip Flip
23732 * @image html img/widget/flip/preview-00.png
23733 * @image latex img/widget/flip/preview-00.eps
23735 * This widget holds 2 content objects(Evas_Object): one on the front and one
23736 * on the back. It allows you to flip from front to back and vice-versa using
23737 * various animations.
23739 * If either the front or back contents are not set the flip will treat that
23740 * as transparent. So if you wore to set the front content but not the back,
23741 * and then call elm_flip_go() you would see whatever is below the flip.
23743 * For a list of supported animations see elm_flip_go().
23745 * Signals that you can add callbacks for are:
23746 * "animate,begin" - when a flip animation was started
23747 * "animate,done" - when a flip animation is finished
23749 * @ref tutorial_flip show how to use most of the API.
23753 typedef enum _Elm_Flip_Mode
23755 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23756 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23757 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23758 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23759 ELM_FLIP_CUBE_LEFT,
23760 ELM_FLIP_CUBE_RIGHT,
23762 ELM_FLIP_CUBE_DOWN,
23763 ELM_FLIP_PAGE_LEFT,
23764 ELM_FLIP_PAGE_RIGHT,
23768 typedef enum _Elm_Flip_Interaction
23770 ELM_FLIP_INTERACTION_NONE,
23771 ELM_FLIP_INTERACTION_ROTATE,
23772 ELM_FLIP_INTERACTION_CUBE,
23773 ELM_FLIP_INTERACTION_PAGE
23774 } Elm_Flip_Interaction;
23775 typedef enum _Elm_Flip_Direction
23777 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23778 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23779 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23780 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23781 } Elm_Flip_Direction;
23783 * @brief Add a new flip to the parent
23785 * @param parent The parent object
23786 * @return The new object or NULL if it cannot be created
23788 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23790 * @brief Set the front content of the flip widget.
23792 * @param obj The flip object
23793 * @param content The new front content object
23795 * Once the content object is set, a previously set one will be deleted.
23796 * If you want to keep that old content object, use the
23797 * elm_flip_content_front_unset() function.
23799 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23801 * @brief Set the back content of the flip widget.
23803 * @param obj The flip object
23804 * @param content The new back content object
23806 * Once the content object is set, a previously set one will be deleted.
23807 * If you want to keep that old content object, use the
23808 * elm_flip_content_back_unset() function.
23810 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23812 * @brief Get the front content used for the flip
23814 * @param obj The flip object
23815 * @return The front content object that is being used
23817 * Return the front content object which is set for this widget.
23819 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23821 * @brief Get the back content used for the flip
23823 * @param obj The flip object
23824 * @return The back content object that is being used
23826 * Return the back content object which is set for this widget.
23828 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23830 * @brief Unset the front content used for the flip
23832 * @param obj The flip object
23833 * @return The front content object that was being used
23835 * Unparent and return the front content object which was set for this widget.
23837 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23839 * @brief Unset the back content used for the flip
23841 * @param obj The flip object
23842 * @return The back content object that was being used
23844 * Unparent and return the back content object which was set for this widget.
23846 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23848 * @brief Get flip front visibility state
23850 * @param obj The flip objct
23851 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23854 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23856 * @brief Set flip perspective
23858 * @param obj The flip object
23859 * @param foc The coordinate to set the focus on
23860 * @param x The X coordinate
23861 * @param y The Y coordinate
23863 * @warning This function currently does nothing.
23865 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23867 * @brief Runs the flip animation
23869 * @param obj The flip object
23870 * @param mode The mode type
23872 * Flips the front and back contents using the @p mode animation. This
23873 * efectively hides the currently visible content and shows the hidden one.
23875 * There a number of possible animations to use for the flipping:
23876 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23877 * around a horizontal axis in the middle of its height, the other content
23878 * is shown as the other side of the flip.
23879 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23880 * around a vertical axis in the middle of its width, the other content is
23881 * shown as the other side of the flip.
23882 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23883 * around a diagonal axis in the middle of its width, the other content is
23884 * shown as the other side of the flip.
23885 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23886 * around a diagonal axis in the middle of its height, the other content is
23887 * shown as the other side of the flip.
23888 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23889 * as if the flip was a cube, the other content is show as the right face of
23891 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23892 * right as if the flip was a cube, the other content is show as the left
23893 * face of the cube.
23894 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23895 * flip was a cube, the other content is show as the bottom face of the cube.
23896 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23897 * the flip was a cube, the other content is show as the upper face of the
23899 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23900 * if the flip was a book, the other content is shown as the page below that.
23901 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23902 * as if the flip was a book, the other content is shown as the page below
23904 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23905 * flip was a book, the other content is shown as the page below that.
23906 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23907 * flip was a book, the other content is shown as the page below that.
23909 * @image html elm_flip.png
23910 * @image latex elm_flip.eps width=\textwidth
23912 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23914 * @brief Set the interactive flip mode
23916 * @param obj The flip object
23917 * @param mode The interactive flip mode to use
23919 * This sets if the flip should be interactive (allow user to click and
23920 * drag a side of the flip to reveal the back page and cause it to flip).
23921 * By default a flip is not interactive. You may also need to set which
23922 * sides of the flip are "active" for flipping and how much space they use
23923 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23924 * and elm_flip_interacton_direction_hitsize_set()
23926 * The four avilable mode of interaction are:
23927 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23928 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23929 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23930 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23932 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23933 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23934 * happen, those can only be acheived with elm_flip_go();
23936 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23938 * @brief Get the interactive flip mode
23940 * @param obj The flip object
23941 * @return The interactive flip mode
23943 * Returns the interactive flip mode set by elm_flip_interaction_set()
23945 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23947 * @brief Set which directions of the flip respond to interactive flip
23949 * @param obj The flip object
23950 * @param dir The direction to change
23951 * @param enabled If that direction is enabled or not
23953 * By default all directions are disabled, so you may want to enable the
23954 * desired directions for flipping if you need interactive flipping. You must
23955 * call this function once for each direction that should be enabled.
23957 * @see elm_flip_interaction_set()
23959 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23961 * @brief Get the enabled state of that flip direction
23963 * @param obj The flip object
23964 * @param dir The direction to check
23965 * @return If that direction is enabled or not
23967 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23969 * @see elm_flip_interaction_set()
23971 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23973 * @brief Set the amount of the flip that is sensitive to interactive flip
23975 * @param obj The flip object
23976 * @param dir The direction to modify
23977 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23979 * Set the amount of the flip that is sensitive to interactive flip, with 0
23980 * representing no area in the flip and 1 representing the entire flip. There
23981 * is however a consideration to be made in that the area will never be
23982 * smaller than the finger size set(as set in your Elementary configuration).
23984 * @see elm_flip_interaction_set()
23986 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23988 * @brief Get the amount of the flip that is sensitive to interactive flip
23990 * @param obj The flip object
23991 * @param dir The direction to check
23992 * @return The size set for that direction
23994 * Returns the amount os sensitive area set by
23995 * elm_flip_interacton_direction_hitsize_set().
23997 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24002 /* scrolledentry */
24003 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24004 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24005 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24006 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24007 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24008 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24009 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24010 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24011 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24012 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24013 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24014 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24015 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24016 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24017 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24018 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24019 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24020 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24021 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24022 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24023 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24024 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24025 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24026 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24027 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24028 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24029 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24030 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24031 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24032 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24033 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24034 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24035 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24036 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24037 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24038 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);
24039 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24040 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24041 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);
24042 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24043 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);
24044 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24045 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24046 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24047 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24048 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24049 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24051 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24052 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);
24053 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);
24054 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);
24055 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);
24056 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);
24057 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);
24058 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24059 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24060 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24061 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24062 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24063 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24064 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24065 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24066 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24067 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24068 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24069 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24070 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24073 * @defgroup Conformant Conformant
24074 * @ingroup Elementary
24076 * @image html img/widget/conformant/preview-00.png
24077 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24079 * @image html img/conformant.png
24080 * @image latex img/conformant.eps width=\textwidth
24082 * The aim is to provide a widget that can be used in elementary apps to
24083 * account for space taken up by the indicator, virtual keypad & softkey
24084 * windows when running the illume2 module of E17.
24086 * So conformant content will be sized and positioned considering the
24087 * space required for such stuff, and when they popup, as a keyboard
24088 * shows when an entry is selected, conformant content won't change.
24090 * Available styles for it:
24093 * Default contents parts of the conformant widget that you can use for are:
24094 * @li "elm.swallow.content" - A content of the conformant
24096 * See how to use this widget in this example:
24097 * @ref conformant_example
24101 * @addtogroup Conformant
24106 * Add a new conformant widget to the given parent Elementary
24107 * (container) object.
24109 * @param parent The parent object.
24110 * @return A new conformant widget handle or @c NULL, on errors.
24112 * This function inserts a new conformant widget on the canvas.
24114 * @ingroup Conformant
24116 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24119 * Set the content of the conformant widget.
24121 * @param obj The conformant object.
24122 * @param content The content to be displayed by the conformant.
24124 * Content will be sized and positioned considering the space required
24125 * to display a virtual keyboard. So it won't fill all the conformant
24126 * size. This way is possible to be sure that content won't resize
24127 * or be re-positioned after the keyboard is displayed.
24129 * Once the content object is set, a previously set one will be deleted.
24130 * If you want to keep that old content object, use the
24131 * elm_object_content_unset() function.
24133 * @see elm_object_content_unset()
24134 * @see elm_object_content_get()
24136 * @ingroup Conformant
24138 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24141 * Get the content of the conformant widget.
24143 * @param obj The conformant object.
24144 * @return The content that is being used.
24146 * Return the content object which is set for this widget.
24147 * It won't be unparent from conformant. For that, use
24148 * elm_object_content_unset().
24150 * @see elm_object_content_set().
24151 * @see elm_object_content_unset()
24153 * @ingroup Conformant
24155 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 * Unset the content of the conformant widget.
24160 * @param obj The conformant object.
24161 * @return The content that was being used.
24163 * Unparent and return the content object which was set for this widget.
24165 * @see elm_object_content_set().
24167 * @ingroup Conformant
24169 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24172 * Returns the Evas_Object that represents the content area.
24174 * @param obj The conformant object.
24175 * @return The content area of the widget.
24177 * @ingroup Conformant
24179 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24186 * @defgroup Mapbuf Mapbuf
24187 * @ingroup Elementary
24189 * @image html img/widget/mapbuf/preview-00.png
24190 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24192 * This holds one content object and uses an Evas Map of transformation
24193 * points to be later used with this content. So the content will be
24194 * moved, resized, etc as a single image. So it will improve performance
24195 * when you have a complex interafce, with a lot of elements, and will
24196 * need to resize or move it frequently (the content object and its
24199 * To set/get/unset the content of the mapbuf, you can use
24200 * elm_object_content_set/get/unset APIs.
24201 * Once the content object is set, a previously set one will be deleted.
24202 * If you want to keep that old content object, use the
24203 * elm_object_content_unset() function.
24205 * To enable map, elm_mapbuf_enabled_set() should be used.
24207 * See how to use this widget in this example:
24208 * @ref mapbuf_example
24212 * @addtogroup Mapbuf
24217 * Add a new mapbuf widget to the given parent Elementary
24218 * (container) object.
24220 * @param parent The parent object.
24221 * @return A new mapbuf widget handle or @c NULL, on errors.
24223 * This function inserts a new mapbuf widget on the canvas.
24227 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24230 * Set the content of the mapbuf.
24232 * @param obj The mapbuf object.
24233 * @param content The content that will be filled in this mapbuf object.
24235 * Once the content object is set, a previously set one will be deleted.
24236 * If you want to keep that old content object, use the
24237 * elm_mapbuf_content_unset() function.
24239 * To enable map, elm_mapbuf_enabled_set() should be used.
24243 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24246 * Get the content of the mapbuf.
24248 * @param obj The mapbuf object.
24249 * @return The content that is being used.
24251 * Return the content object which is set for this widget.
24253 * @see elm_mapbuf_content_set() for details.
24257 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24260 * Unset the content of the mapbuf.
24262 * @param obj The mapbuf object.
24263 * @return The content that was being used.
24265 * Unparent and return the content object which was set for this widget.
24267 * @see elm_mapbuf_content_set() for details.
24271 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24274 * Enable or disable the map.
24276 * @param obj The mapbuf object.
24277 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24279 * This enables the map that is set or disables it. On enable, the object
24280 * geometry will be saved, and the new geometry will change (position and
24281 * size) to reflect the map geometry set.
24283 * Also, when enabled, alpha and smooth states will be used, so if the
24284 * content isn't solid, alpha should be enabled, for example, otherwise
24285 * a black retangle will fill the content.
24287 * When disabled, the stored map will be freed and geometry prior to
24288 * enabling the map will be restored.
24290 * It's disabled by default.
24292 * @see elm_mapbuf_alpha_set()
24293 * @see elm_mapbuf_smooth_set()
24297 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24300 * Get a value whether map is enabled or not.
24302 * @param obj The mapbuf object.
24303 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24304 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24306 * @see elm_mapbuf_enabled_set() for details.
24310 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24313 * Enable or disable smooth map rendering.
24315 * @param obj The mapbuf object.
24316 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24319 * This sets smoothing for map rendering. If the object is a type that has
24320 * its own smoothing settings, then both the smooth settings for this object
24321 * and the map must be turned off.
24323 * By default smooth maps are enabled.
24327 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24330 * Get a value whether smooth map rendering is enabled or not.
24332 * @param obj The mapbuf object.
24333 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24334 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24336 * @see elm_mapbuf_smooth_set() for details.
24340 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24343 * Set or unset alpha flag for map rendering.
24345 * @param obj The mapbuf object.
24346 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24349 * This sets alpha flag for map rendering. If the object is a type that has
24350 * its own alpha settings, then this will take precedence. Only image objects
24351 * have this currently. It stops alpha blending of the map area, and is
24352 * useful if you know the object and/or all sub-objects is 100% solid.
24354 * Alpha is enabled by default.
24358 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24361 * Get a value whether alpha blending is enabled or not.
24363 * @param obj The mapbuf object.
24364 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24365 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24367 * @see elm_mapbuf_alpha_set() for details.
24371 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24378 * @defgroup Flipselector Flip Selector
24380 * A flip selector is a widget to show a set of @b text items, one
24381 * at a time, with the same sheet switching style as the @ref Clock
24382 * "clock" widget, when one changes the current displaying sheet
24383 * (thus, the "flip" in the name).
24385 * User clicks to flip sheets which are @b held for some time will
24386 * make the flip selector to flip continuosly and automatically for
24387 * the user. The interval between flips will keep growing in time,
24388 * so that it helps the user to reach an item which is distant from
24389 * the current selection.
24391 * Smart callbacks one can register to:
24392 * - @c "selected" - when the widget's selected text item is changed
24393 * - @c "overflowed" - when the widget's current selection is changed
24394 * from the first item in its list to the last
24395 * - @c "underflowed" - when the widget's current selection is changed
24396 * from the last item in its list to the first
24398 * Available styles for it:
24401 * Here is an example on its usage:
24402 * @li @ref flipselector_example
24406 * @addtogroup Flipselector
24410 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24413 * Add a new flip selector widget to the given parent Elementary
24414 * (container) widget
24416 * @param parent The parent object
24417 * @return a new flip selector widget handle or @c NULL, on errors
24419 * This function inserts a new flip selector widget on the canvas.
24421 * @ingroup Flipselector
24423 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24426 * Programmatically select the next item of a flip selector widget
24428 * @param obj The flipselector object
24430 * @note The selection will be animated. Also, if it reaches the
24431 * end of its list of member items, it will continue with the first
24434 * @ingroup Flipselector
24436 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24439 * Programmatically select the previous item of a flip selector
24442 * @param obj The flipselector object
24444 * @note The selection will be animated. Also, if it reaches the
24445 * beginning of its list of member items, it will continue with the
24446 * last one backwards.
24448 * @ingroup Flipselector
24450 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 * Append a (text) item to a flip selector widget
24455 * @param obj The flipselector object
24456 * @param label The (text) label of the new item
24457 * @param func Convenience callback function to take place when
24459 * @param data Data passed to @p func, above
24460 * @return A handle to the item added or @c NULL, on errors
24462 * The widget's list of labels to show will be appended with the
24463 * given value. If the user wishes so, a callback function pointer
24464 * can be passed, which will get called when this same item is
24467 * @note The current selection @b won't be modified by appending an
24468 * element to the list.
24470 * @note The maximum length of the text label is going to be
24471 * determined <b>by the widget's theme</b>. Strings larger than
24472 * that value are going to be @b truncated.
24474 * @ingroup Flipselector
24476 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24479 * Prepend a (text) item to a flip selector widget
24481 * @param obj The flipselector object
24482 * @param label The (text) label of the new item
24483 * @param func Convenience callback function to take place when
24485 * @param data Data passed to @p func, above
24486 * @return A handle to the item added or @c NULL, on errors
24488 * The widget's list of labels to show will be prepended with the
24489 * given value. If the user wishes so, a callback function pointer
24490 * can be passed, which will get called when this same item is
24493 * @note The current selection @b won't be modified by prepending
24494 * an element to the list.
24496 * @note The maximum length of the text label is going to be
24497 * determined <b>by the widget's theme</b>. Strings larger than
24498 * that value are going to be @b truncated.
24500 * @ingroup Flipselector
24502 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24505 * Get the internal list of items in a given flip selector widget.
24507 * @param obj The flipselector object
24508 * @return The list of items (#Elm_Flipselector_Item as data) or @c
24511 * This list is @b not to be modified in any way and must not be
24512 * freed. Use the list members with functions like
24513 * elm_flipselector_item_label_set(),
24514 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24515 * elm_flipselector_item_del(),
24516 * elm_flipselector_item_selected_get(),
24517 * elm_flipselector_item_selected_set().
24519 * @warning This list is only valid until @p obj object's internal
24520 * items list is changed. It should be fetched again with another
24521 * call to this function when changes happen.
24523 * @ingroup Flipselector
24525 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24528 * Get the first item in the given flip selector widget's list of
24531 * @param obj The flipselector object
24532 * @return The first item or @c NULL, if it has no items (and on
24535 * @see elm_flipselector_item_append()
24536 * @see elm_flipselector_last_item_get()
24538 * @ingroup Flipselector
24540 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24543 * Get the last item in the given flip selector widget's list of
24546 * @param obj The flipselector object
24547 * @return The last item or @c NULL, if it has no items (and on
24550 * @see elm_flipselector_item_prepend()
24551 * @see elm_flipselector_first_item_get()
24553 * @ingroup Flipselector
24555 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24558 * Get the currently selected item in a flip selector widget.
24560 * @param obj The flipselector object
24561 * @return The selected item or @c NULL, if the widget has no items
24564 * @ingroup Flipselector
24566 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24569 * Set whether a given flip selector widget's item should be the
24570 * currently selected one.
24572 * @param item The flip selector item
24573 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24575 * This sets whether @p item is or not the selected (thus, under
24576 * display) one. If @p item is different than one under display,
24577 * the latter will be unselected. If the @p item is set to be
24578 * unselected, on the other hand, the @b first item in the widget's
24579 * internal members list will be the new selected one.
24581 * @see elm_flipselector_item_selected_get()
24583 * @ingroup Flipselector
24585 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24588 * Get whether a given flip selector widget's item is the currently
24591 * @param item The flip selector item
24592 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24595 * @see elm_flipselector_item_selected_set()
24597 * @ingroup Flipselector
24599 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24602 * Delete a given item from a flip selector widget.
24604 * @param item The item to delete
24606 * @ingroup Flipselector
24608 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24611 * Get the label of a given flip selector widget's item.
24613 * @param item The item to get label from
24614 * @return The text label of @p item or @c NULL, on errors
24616 * @see elm_flipselector_item_label_set()
24618 * @ingroup Flipselector
24620 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24623 * Set the label of a given flip selector widget's item.
24625 * @param item The item to set label on
24626 * @param label The text label string, in UTF-8 encoding
24628 * @see elm_flipselector_item_label_get()
24630 * @ingroup Flipselector
24632 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24635 * Gets the item before @p item in a flip selector widget's
24636 * internal list of items.
24638 * @param item The item to fetch previous from
24639 * @return The item before the @p item, in its parent's list. If
24640 * there is no previous item for @p item or there's an
24641 * error, @c NULL is returned.
24643 * @see elm_flipselector_item_next_get()
24645 * @ingroup Flipselector
24647 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24650 * Gets the item after @p item in a flip selector widget's
24651 * internal list of items.
24653 * @param item The item to fetch next from
24654 * @return The item after the @p item, in its parent's list. If
24655 * there is no next item for @p item or there's an
24656 * error, @c NULL is returned.
24658 * @see elm_flipselector_item_next_get()
24660 * @ingroup Flipselector
24662 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24665 * Set the interval on time updates for an user mouse button hold
24666 * on a flip selector widget.
24668 * @param obj The flip selector object
24669 * @param interval The (first) interval value in seconds
24671 * This interval value is @b decreased while the user holds the
24672 * mouse pointer either flipping up or flipping doww a given flip
24675 * This helps the user to get to a given item distant from the
24676 * current one easier/faster, as it will start to flip quicker and
24677 * quicker on mouse button holds.
24679 * The calculation for the next flip interval value, starting from
24680 * the one set with this call, is the previous interval divided by
24681 * 1.05, so it decreases a little bit.
24683 * The default starting interval value for automatic flips is
24686 * @see elm_flipselector_interval_get()
24688 * @ingroup Flipselector
24690 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24693 * Get the interval on time updates for an user mouse button hold
24694 * on a flip selector widget.
24696 * @param obj The flip selector object
24697 * @return The (first) interval value, in seconds, set on it
24699 * @see elm_flipselector_interval_set() for more details
24701 * @ingroup Flipselector
24703 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24710 * @addtogroup Animator Animator
24711 * @ingroup Elementary
24713 * @brief Functions to ease creation of animations.
24715 * elm_animator is designed to provide an easy way to create animations.
24716 * Creating an animation with elm_animator is as simple as setting a
24717 * duration, an operating callback and telling it to run the animation.
24718 * However that is not the full extent of elm_animator's ability, animations
24719 * can be paused and resumed, reversed and the animation need not be linear.
24721 * To run an animation you must specify at least a duration and operation
24722 * callback, not setting any other properties will create a linear animation
24723 * that runs once and is not reversed.
24725 * @ref elm_animator_example_page_01 "This" example should make all of that
24728 * @warning elm_animator is @b not a widget.
24732 * @brief Type of curve desired for animation.
24734 * The speed in which an animation happens doesn't have to be linear, some
24735 * animations will look better if they're accelerating or decelerating, so
24736 * elm_animator provides four options in this regard:
24737 * @image html elm_animator_curve_style.png
24738 * @image latex elm_animator_curve_style.eps width=\textwidth
24739 * As can be seen in the image the speed of the animation will be:
24740 * @li ELM_ANIMATOR_CURVE_LINEAR constant
24741 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
24742 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
24743 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
24747 ELM_ANIMATOR_CURVE_LINEAR,
24748 ELM_ANIMATOR_CURVE_IN_OUT,
24749 ELM_ANIMATOR_CURVE_IN,
24750 ELM_ANIMATOR_CURVE_OUT
24751 } Elm_Animator_Curve_Style;
24752 typedef struct _Elm_Animator Elm_Animator;
24754 * Called back per loop of an elementary animators cycle
24755 * @param data user-data given to elm_animator_operation_callback_set()
24756 * @param animator the animator being run
24757 * @param double the position in the animation
24759 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
24761 * Called back when an elementary animator finishes
24762 * @param data user-data given to elm_animator_completion_callback_set()
24764 typedef void (*Elm_Animator_Completion_Cb) (void *data);
24767 * @brief Create a new animator.
24769 * @param[in] parent Parent object
24771 * The @a parent argument can be set to NULL for no parent. If a parent is set
24772 * there is no need to call elm_animator_del(), when the parent is deleted it
24773 * will delete the animator.
24774 * @deprecated Use @ref Transit instead.
24777 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
24779 * Deletes the animator freeing any resources it used. If the animator was
24780 * created with a NULL parent this must be called, otherwise it will be
24781 * automatically called when the parent is deleted.
24783 * @param[in] animator Animator object
24784 * @deprecated Use @ref Transit instead.
24786 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24788 * Set the duration of the animation.
24790 * @param[in] animator Animator object
24791 * @param[in] duration Duration in second
24792 * @deprecated Use @ref Transit instead.
24794 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
24796 * @brief Set the callback function for animator operation.
24798 * @param[in] animator Animator object
24799 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
24800 * @param[in] data Callback function user argument
24802 * The @p func callback will be called with a frame value in range [0, 1] which
24803 * indicates how far along the animation should be. It is the job of @p func to
24804 * actually change the state of any object(or objects) that are being animated.
24805 * @deprecated Use @ref Transit instead.
24807 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
24809 * Set the callback function for the when the animation ends.
24811 * @param[in] animator Animator object
24812 * @param[in] func Callback function pointe
24813 * @param[in] data Callback function user argument
24815 * @warning @a func will not be executed if elm_animator_stop() is called.
24816 * @deprecated Use @ref Transit instead.
24818 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
24820 * @brief Stop animator.
24822 * @param[in] animator Animator object
24824 * If called before elm_animator_animate() it does nothing. If there is an
24825 * animation in progress the animation will be stopped(the operation callback
24826 * will not be executed again) and it can't be restarted using
24827 * elm_animator_resume().
24828 * @deprecated Use @ref Transit instead.
24830 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24832 * Set the animator repeat count.
24834 * @param[in] animator Animator object
24835 * @param[in] repeat_cnt Repeat count
24836 * @deprecated Use @ref Transit instead.
24838 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
24840 * @brief Start animation.
24842 * @param[in] animator Animator object
24844 * This function starts the animation if the nescessary properties(duration
24845 * and operation callback) have been set. Once started the animation will
24846 * run until complete or elm_animator_stop() is called.
24847 * @deprecated Use @ref Transit instead.
24849 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24851 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24853 * @param[in] animator Animator object
24854 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24855 * @deprecated Use @ref Transit instead.
24857 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
24859 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24861 * @param[in] animator Animator object
24862 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24863 * @deprecated Use @ref Transit instead.
24865 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24867 * @brief Sets wether the animation should be automatically reversed.
24869 * @param[in] animator Animator object
24870 * @param[in] reverse Reverse or not
24872 * This controls wether the animation will be run on reverse imediately after
24873 * running forward. When this is set together with repetition the animation
24874 * will run in reverse once for each time it ran forward.@n
24875 * Runnin an animation in reverse is accomplished by calling the operation
24876 * callback with a frame value starting at 1 and diminshing until 0.
24877 * @deprecated Use @ref Transit instead.
24879 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
24881 * Gets wether the animation will automatically reversed
24883 * @param[in] animator Animator object
24884 * @deprecated Use @ref Transit instead.
24886 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24888 * Gets the status for the animator operation. The status of the animator @b
24889 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
24890 * only informs if the animation was started and has not ended(either normally
24891 * or through elm_animator_stop()).
24893 * @param[in] animator Animator object
24894 * @deprecated Use @ref Transit instead.
24896 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24898 * Gets how many times the animation will be repeated
24900 * @param[in] animator Animator object
24901 * @deprecated Use @ref Transit instead.
24903 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24905 * Pause the animator.
24907 * @param[in] animator Animator object
24909 * This causes the animation to be temporarily stopped(the operation callback
24910 * will not be called). If the animation is not yet running this is a no-op.
24911 * Once an animation has been paused with this function it can be resumed
24912 * using elm_animator_resume().
24913 * @deprecated Use @ref Transit instead.
24915 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24917 * @brief Resumes the animator.
24919 * @param[in] animator Animator object
24921 * Resumes an animation that was paused using elm_animator_pause(), after
24922 * calling this function calls to the operation callback will happen
24923 * normally. If an animation is stopped by means of elm_animator_stop it
24924 * @b can't be restarted with this function.@n
24926 * @warning When an animation is resumed it doesn't start from where it was paused, it
24927 * will go to where it would have been if it had not been paused. If an
24928 * animation with a duration of 3 seconds is paused after 1 second for 1 second
24929 * it will resume as if it had ben animating for 2 seconds, the operating
24930 * callback will be called with a frame value of aproximately 2/3.
24931 * @deprecated Use @ref Transit instead.
24933 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24939 * @addtogroup Calendar
24944 * @enum _Elm_Calendar_Mark_Repeat
24945 * @typedef Elm_Calendar_Mark_Repeat
24947 * Event periodicity, used to define if a mark should be repeated
24948 * @b beyond event's day. It's set when a mark is added.
24950 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24951 * there will be marks every week after this date. Marks will be displayed
24952 * at 13th, 20th, 27th, 3rd June ...
24954 * Values don't work as bitmask, only one can be choosen.
24956 * @see elm_calendar_mark_add()
24958 * @ingroup Calendar
24960 typedef enum _Elm_Calendar_Mark_Repeat
24962 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24963 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24964 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24965 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*/
24966 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. */
24967 } Elm_Calendar_Mark_Repeat;
24969 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(). */
24972 * Add a new calendar widget to the given parent Elementary
24973 * (container) object.
24975 * @param parent The parent object.
24976 * @return a new calendar widget handle or @c NULL, on errors.
24978 * This function inserts a new calendar widget on the canvas.
24980 * @ref calendar_example_01
24982 * @ingroup Calendar
24984 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24987 * Get weekdays names displayed by the calendar.
24989 * @param obj The calendar object.
24990 * @return Array of seven strings to be used as weekday names.
24992 * By default, weekdays abbreviations get from system are displayed:
24993 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24994 * The first string is related to Sunday, the second to Monday...
24996 * @see elm_calendar_weekdays_name_set()
24998 * @ref calendar_example_05
25000 * @ingroup Calendar
25002 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25005 * Set weekdays names to be displayed by the calendar.
25007 * @param obj The calendar object.
25008 * @param weekdays Array of seven strings to be used as weekday names.
25009 * @warning It must have 7 elements, or it will access invalid memory.
25010 * @warning The strings must be NULL terminated ('@\0').
25012 * By default, weekdays abbreviations get from system are displayed:
25013 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25015 * The first string should be related to Sunday, the second to Monday...
25017 * The usage should be like this:
25019 * const char *weekdays[] =
25021 * "Sunday", "Monday", "Tuesday", "Wednesday",
25022 * "Thursday", "Friday", "Saturday"
25024 * elm_calendar_weekdays_names_set(calendar, weekdays);
25027 * @see elm_calendar_weekdays_name_get()
25029 * @ref calendar_example_02
25031 * @ingroup Calendar
25033 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25036 * Set the minimum and maximum values for the year
25038 * @param obj The calendar object
25039 * @param min The minimum year, greater than 1901;
25040 * @param max The maximum year;
25042 * Maximum must be greater than minimum, except if you don't wan't to set
25044 * Default values are 1902 and -1.
25046 * If the maximum year is a negative value, it will be limited depending
25047 * on the platform architecture (year 2037 for 32 bits);
25049 * @see elm_calendar_min_max_year_get()
25051 * @ref calendar_example_03
25053 * @ingroup Calendar
25055 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25058 * Get the minimum and maximum values for the year
25060 * @param obj The calendar object.
25061 * @param min The minimum year.
25062 * @param max The maximum year.
25064 * Default values are 1902 and -1.
25066 * @see elm_calendar_min_max_year_get() for more details.
25068 * @ref calendar_example_05
25070 * @ingroup Calendar
25072 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25075 * Enable or disable day selection
25077 * @param obj The calendar object.
25078 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25081 * Enabled by default. If disabled, the user still can select months,
25082 * but not days. Selected days are highlighted on calendar.
25083 * It should be used if you won't need such selection for the widget usage.
25085 * When a day is selected, or month is changed, smart callbacks for
25086 * signal "changed" will be called.
25088 * @see elm_calendar_day_selection_enable_get()
25090 * @ref calendar_example_04
25092 * @ingroup Calendar
25094 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25097 * Get a value whether day selection is enabled or not.
25099 * @see elm_calendar_day_selection_enable_set() for details.
25101 * @param obj The calendar object.
25102 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25103 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25105 * @ref calendar_example_05
25107 * @ingroup Calendar
25109 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25113 * Set selected date to be highlighted on calendar.
25115 * @param obj The calendar object.
25116 * @param selected_time A @b tm struct to represent the selected date.
25118 * Set the selected date, changing the displayed month if needed.
25119 * Selected date changes when the user goes to next/previous month or
25120 * select a day pressing over it on calendar.
25122 * @see elm_calendar_selected_time_get()
25124 * @ref calendar_example_04
25126 * @ingroup Calendar
25128 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25131 * Get selected date.
25133 * @param obj The calendar object
25134 * @param selected_time A @b tm struct to point to selected date
25135 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25138 * Get date selected by the user or set by function
25139 * elm_calendar_selected_time_set().
25140 * Selected date changes when the user goes to next/previous month or
25141 * select a day pressing over it on calendar.
25143 * @see elm_calendar_selected_time_get()
25145 * @ref calendar_example_05
25147 * @ingroup Calendar
25149 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25152 * Set a function to format the string that will be used to display
25155 * @param obj The calendar object
25156 * @param format_function Function to set the month-year string given
25157 * the selected date
25159 * By default it uses strftime with "%B %Y" format string.
25160 * It should allocate the memory that will be used by the string,
25161 * that will be freed by the widget after usage.
25162 * A pointer to the string and a pointer to the time struct will be provided.
25167 * _format_month_year(struct tm *selected_time)
25170 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25171 * return strdup(buf);
25174 * elm_calendar_format_function_set(calendar, _format_month_year);
25177 * @ref calendar_example_02
25179 * @ingroup Calendar
25181 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25184 * Add a new mark to the calendar
25186 * @param obj The calendar object
25187 * @param mark_type A string used to define the type of mark. It will be
25188 * emitted to the theme, that should display a related modification on these
25189 * days representation.
25190 * @param mark_time A time struct to represent the date of inclusion of the
25191 * mark. For marks that repeats it will just be displayed after the inclusion
25192 * date in the calendar.
25193 * @param repeat Repeat the event following this periodicity. Can be a unique
25194 * mark (that don't repeat), daily, weekly, monthly or annually.
25195 * @return The created mark or @p NULL upon failure.
25197 * Add a mark that will be drawn in the calendar respecting the insertion
25198 * time and periodicity. It will emit the type as signal to the widget theme.
25199 * Default theme supports "holiday" and "checked", but it can be extended.
25201 * It won't immediately update the calendar, drawing the marks.
25202 * For this, call elm_calendar_marks_draw(). However, when user selects
25203 * next or previous month calendar forces marks drawn.
25205 * Marks created with this method can be deleted with
25206 * elm_calendar_mark_del().
25210 * struct tm selected_time;
25211 * time_t current_time;
25213 * current_time = time(NULL) + 5 * 84600;
25214 * localtime_r(¤t_time, &selected_time);
25215 * elm_calendar_mark_add(cal, "holiday", selected_time,
25216 * ELM_CALENDAR_ANNUALLY);
25218 * current_time = time(NULL) + 1 * 84600;
25219 * localtime_r(¤t_time, &selected_time);
25220 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25222 * elm_calendar_marks_draw(cal);
25225 * @see elm_calendar_marks_draw()
25226 * @see elm_calendar_mark_del()
25228 * @ref calendar_example_06
25230 * @ingroup Calendar
25232 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);
25235 * Delete mark from the calendar.
25237 * @param mark The mark to be deleted.
25239 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25240 * should be used instead of getting marks list and deleting each one.
25242 * @see elm_calendar_mark_add()
25244 * @ref calendar_example_06
25246 * @ingroup Calendar
25248 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25251 * Remove all calendar's marks
25253 * @param obj The calendar object.
25255 * @see elm_calendar_mark_add()
25256 * @see elm_calendar_mark_del()
25258 * @ingroup Calendar
25260 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25264 * Get a list of all the calendar marks.
25266 * @param obj The calendar object.
25267 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25269 * @see elm_calendar_mark_add()
25270 * @see elm_calendar_mark_del()
25271 * @see elm_calendar_marks_clear()
25273 * @ingroup Calendar
25275 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25278 * Draw calendar marks.
25280 * @param obj The calendar object.
25282 * Should be used after adding, removing or clearing marks.
25283 * It will go through the entire marks list updating the calendar.
25284 * If lots of marks will be added, add all the marks and then call
25287 * When the month is changed, i.e. user selects next or previous month,
25288 * marks will be drawed.
25290 * @see elm_calendar_mark_add()
25291 * @see elm_calendar_mark_del()
25292 * @see elm_calendar_marks_clear()
25294 * @ref calendar_example_06
25296 * @ingroup Calendar
25298 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25299 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25300 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25301 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25304 * Set a day text color to the same that represents Saturdays.
25306 * @param obj The calendar object.
25307 * @param pos The text position. Position is the cell counter, from left
25308 * to right, up to down. It starts on 0 and ends on 41.
25310 * @deprecated use elm_calendar_mark_add() instead like:
25313 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25314 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25317 * @see elm_calendar_mark_add()
25319 * @ingroup Calendar
25321 EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25324 * Set a day text color to the same that represents Sundays.
25326 * @param obj The calendar object.
25327 * @param pos The text position. Position is the cell counter, from left
25328 * to right, up to down. It starts on 0 and ends on 41.
25330 * @deprecated use elm_calendar_mark_add() instead like:
25333 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25334 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25337 * @see elm_calendar_mark_add()
25339 * @ingroup Calendar
25341 EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25344 * Set a day text color to the same that represents Weekdays.
25346 * @param obj The calendar object
25347 * @param pos The text position. Position is the cell counter, from left
25348 * to right, up to down. It starts on 0 and ends on 41.
25350 * @deprecated use elm_calendar_mark_add() instead like:
25353 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25355 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25356 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25357 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25358 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25359 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25360 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25361 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25362 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25363 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25366 * @see elm_calendar_mark_add()
25368 * @ingroup Calendar
25370 EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25373 * Set the interval on time updates for an user mouse button hold
25374 * on calendar widgets' month selection.
25376 * @param obj The calendar object
25377 * @param interval The (first) interval value in seconds
25379 * This interval value is @b decreased while the user holds the
25380 * mouse pointer either selecting next or previous month.
25382 * This helps the user to get to a given month distant from the
25383 * current one easier/faster, as it will start to change quicker and
25384 * quicker on mouse button holds.
25386 * The calculation for the next change interval value, starting from
25387 * the one set with this call, is the previous interval divided by
25388 * 1.05, so it decreases a little bit.
25390 * The default starting interval value for automatic changes is
25393 * @see elm_calendar_interval_get()
25395 * @ingroup Calendar
25397 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25400 * Get the interval on time updates for an user mouse button hold
25401 * on calendar widgets' month selection.
25403 * @param obj The calendar object
25404 * @return The (first) interval value, in seconds, set on it
25406 * @see elm_calendar_interval_set() for more details
25408 * @ingroup Calendar
25410 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25417 * @defgroup Diskselector Diskselector
25418 * @ingroup Elementary
25420 * @image html img/widget/diskselector/preview-00.png
25421 * @image latex img/widget/diskselector/preview-00.eps
25423 * A diskselector is a kind of list widget. It scrolls horizontally,
25424 * and can contain label and icon objects. Three items are displayed
25425 * with the selected one in the middle.
25427 * It can act like a circular list with round mode and labels can be
25428 * reduced for a defined length for side items.
25430 * Smart callbacks one can listen to:
25431 * - "selected" - when item is selected, i.e. scroller stops.
25433 * Available styles for it:
25436 * List of examples:
25437 * @li @ref diskselector_example_01
25438 * @li @ref diskselector_example_02
25442 * @addtogroup Diskselector
25446 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(). */
25449 * Add a new diskselector widget to the given parent Elementary
25450 * (container) object.
25452 * @param parent The parent object.
25453 * @return a new diskselector widget handle or @c NULL, on errors.
25455 * This function inserts a new diskselector widget on the canvas.
25457 * @ingroup Diskselector
25459 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25462 * Enable or disable round mode.
25464 * @param obj The diskselector object.
25465 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25468 * Disabled by default. If round mode is enabled the items list will
25469 * work like a circle list, so when the user reaches the last item,
25470 * the first one will popup.
25472 * @see elm_diskselector_round_get()
25474 * @ingroup Diskselector
25476 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25479 * Get a value whether round mode is enabled or not.
25481 * @see elm_diskselector_round_set() for details.
25483 * @param obj The diskselector object.
25484 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25485 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25487 * @ingroup Diskselector
25489 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25492 * Get the side labels max length.
25494 * @deprecated use elm_diskselector_side_label_length_get() instead:
25496 * @param obj The diskselector object.
25497 * @return The max length defined for side labels, or 0 if not a valid
25500 * @ingroup Diskselector
25502 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25505 * Set the side labels max length.
25507 * @deprecated use elm_diskselector_side_label_length_set() instead:
25509 * @param obj The diskselector object.
25510 * @param len The max length defined for side labels.
25512 * @ingroup Diskselector
25514 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25517 * Get the side labels max length.
25519 * @see elm_diskselector_side_label_length_set() for details.
25521 * @param obj The diskselector object.
25522 * @return The max length defined for side labels, or 0 if not a valid
25525 * @ingroup Diskselector
25527 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25530 * Set the side labels max length.
25532 * @param obj The diskselector object.
25533 * @param len The max length defined for side labels.
25535 * Length is the number of characters of items' label that will be
25536 * visible when it's set on side positions. It will just crop
25537 * the string after defined size. E.g.:
25539 * An item with label "January" would be displayed on side position as
25540 * "Jan" if max length is set to 3, or "Janu", if this property
25543 * When it's selected, the entire label will be displayed, except for
25544 * width restrictions. In this case label will be cropped and "..."
25545 * will be concatenated.
25547 * Default side label max length is 3.
25549 * This property will be applyed over all items, included before or
25550 * later this function call.
25552 * @ingroup Diskselector
25554 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25557 * Set the number of items to be displayed.
25559 * @param obj The diskselector object.
25560 * @param num The number of items the diskselector will display.
25562 * Default value is 3, and also it's the minimun. If @p num is less
25563 * than 3, it will be set to 3.
25565 * Also, it can be set on theme, using data item @c display_item_num
25566 * on group "elm/diskselector/item/X", where X is style set.
25569 * group { name: "elm/diskselector/item/X";
25571 * item: "display_item_num" "5";
25574 * @ingroup Diskselector
25576 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25579 * Get the number of items in the diskselector object.
25581 * @param obj The diskselector object.
25583 * @ingroup Diskselector
25585 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25588 * Set bouncing behaviour when the scrolled content reaches an edge.
25590 * Tell the internal scroller object whether it should bounce or not
25591 * when it reaches the respective edges for each axis.
25593 * @param obj The diskselector object.
25594 * @param h_bounce Whether to bounce or not in the horizontal axis.
25595 * @param v_bounce Whether to bounce or not in the vertical axis.
25597 * @see elm_scroller_bounce_set()
25599 * @ingroup Diskselector
25601 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25604 * Get the bouncing behaviour of the internal scroller.
25606 * Get whether the internal scroller should bounce when the edge of each
25607 * axis is reached scrolling.
25609 * @param obj The diskselector object.
25610 * @param h_bounce Pointer where to store the bounce state of the horizontal
25612 * @param v_bounce Pointer where to store the bounce state of the vertical
25615 * @see elm_scroller_bounce_get()
25616 * @see elm_diskselector_bounce_set()
25618 * @ingroup Diskselector
25620 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25623 * Get the scrollbar policy.
25625 * @see elm_diskselector_scroller_policy_get() for details.
25627 * @param obj The diskselector object.
25628 * @param policy_h Pointer where to store horizontal scrollbar policy.
25629 * @param policy_v Pointer where to store vertical scrollbar policy.
25631 * @ingroup Diskselector
25633 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);
25636 * Set the scrollbar policy.
25638 * @param obj The diskselector object.
25639 * @param policy_h Horizontal scrollbar policy.
25640 * @param policy_v Vertical scrollbar policy.
25642 * This sets the scrollbar visibility policy for the given scroller.
25643 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25644 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25645 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25646 * This applies respectively for the horizontal and vertical scrollbars.
25648 * The both are disabled by default, i.e., are set to
25649 * #ELM_SCROLLER_POLICY_OFF.
25651 * @ingroup Diskselector
25653 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25656 * Remove all diskselector's items.
25658 * @param obj The diskselector object.
25660 * @see elm_diskselector_item_del()
25661 * @see elm_diskselector_item_append()
25663 * @ingroup Diskselector
25665 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25668 * Get a list of all the diskselector items.
25670 * @param obj The diskselector object.
25671 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25672 * or @c NULL on failure.
25674 * @see elm_diskselector_item_append()
25675 * @see elm_diskselector_item_del()
25676 * @see elm_diskselector_clear()
25678 * @ingroup Diskselector
25680 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25683 * Appends a new item to the diskselector object.
25685 * @param obj The diskselector object.
25686 * @param label The label of the diskselector item.
25687 * @param icon The icon object to use at left side of the item. An
25688 * icon can be any Evas object, but usually it is an icon created
25689 * with elm_icon_add().
25690 * @param func The function to call when the item is selected.
25691 * @param data The data to associate with the item for related callbacks.
25693 * @return The created item or @c NULL upon failure.
25695 * A new item will be created and appended to the diskselector, i.e., will
25696 * be set as last item. Also, if there is no selected item, it will
25697 * be selected. This will always happens for the first appended item.
25699 * If no icon is set, label will be centered on item position, otherwise
25700 * the icon will be placed at left of the label, that will be shifted
25703 * Items created with this method can be deleted with
25704 * elm_diskselector_item_del().
25706 * Associated @p data can be properly freed when item is deleted if a
25707 * callback function is set with elm_diskselector_item_del_cb_set().
25709 * If a function is passed as argument, it will be called everytime this item
25710 * is selected, i.e., the user stops the diskselector with this
25711 * item on center position. If such function isn't needed, just passing
25712 * @c NULL as @p func is enough. The same should be done for @p data.
25714 * Simple example (with no function callback or data associated):
25716 * disk = elm_diskselector_add(win);
25717 * ic = elm_icon_add(win);
25718 * elm_icon_file_set(ic, "path/to/image", NULL);
25719 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25720 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25723 * @see elm_diskselector_item_del()
25724 * @see elm_diskselector_item_del_cb_set()
25725 * @see elm_diskselector_clear()
25726 * @see elm_icon_add()
25728 * @ingroup Diskselector
25730 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);
25734 * Delete them item from the diskselector.
25736 * @param it The item of diskselector to be deleted.
25738 * If deleting all diskselector items is required, elm_diskselector_clear()
25739 * should be used instead of getting items list and deleting each one.
25741 * @see elm_diskselector_clear()
25742 * @see elm_diskselector_item_append()
25743 * @see elm_diskselector_item_del_cb_set()
25745 * @ingroup Diskselector
25747 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25750 * Set the function called when a diskselector item is freed.
25752 * @param it The item to set the callback on
25753 * @param func The function called
25755 * If there is a @p func, then it will be called prior item's memory release.
25756 * That will be called with the following arguments:
25758 * @li item's Evas object;
25761 * This way, a data associated to a diskselector item could be properly
25764 * @ingroup Diskselector
25766 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25769 * Get the data associated to the item.
25771 * @param it The diskselector item
25772 * @return The data associated to @p it
25774 * The return value is a pointer to data associated to @p item when it was
25775 * created, with function elm_diskselector_item_append(). If no data
25776 * was passed as argument, it will return @c NULL.
25778 * @see elm_diskselector_item_append()
25780 * @ingroup Diskselector
25782 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25785 * Set the icon associated to the item.
25787 * @param it The diskselector item
25788 * @param icon The icon object to associate with @p it
25790 * The icon object to use at left side of the item. An
25791 * icon can be any Evas object, but usually it is an icon created
25792 * with elm_icon_add().
25794 * Once the icon object is set, a previously set one will be deleted.
25795 * @warning Setting the same icon for two items will cause the icon to
25796 * dissapear from the first item.
25798 * If an icon was passed as argument on item creation, with function
25799 * elm_diskselector_item_append(), it will be already
25800 * associated to the item.
25802 * @see elm_diskselector_item_append()
25803 * @see elm_diskselector_item_icon_get()
25805 * @ingroup Diskselector
25807 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25810 * Get the icon associated to the item.
25812 * @param it The diskselector item
25813 * @return The icon associated to @p it
25815 * The return value is a pointer to the icon associated to @p item when it was
25816 * created, with function elm_diskselector_item_append(), or later
25817 * with function elm_diskselector_item_icon_set. If no icon
25818 * was passed as argument, it will return @c NULL.
25820 * @see elm_diskselector_item_append()
25821 * @see elm_diskselector_item_icon_set()
25823 * @ingroup Diskselector
25825 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25828 * Set the label of item.
25830 * @param it The item of diskselector.
25831 * @param label The label of item.
25833 * The label to be displayed by the item.
25835 * If no icon is set, label will be centered on item position, otherwise
25836 * the icon will be placed at left of the label, that will be shifted
25839 * An item with label "January" would be displayed on side position as
25840 * "Jan" if max length is set to 3 with function
25841 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25844 * When this @p item is selected, the entire label will be displayed,
25845 * except for width restrictions.
25846 * In this case label will be cropped and "..." will be concatenated,
25847 * but only for display purposes. It will keep the entire string, so
25848 * if diskselector is resized the remaining characters will be displayed.
25850 * If a label was passed as argument on item creation, with function
25851 * elm_diskselector_item_append(), it will be already
25852 * displayed by the item.
25854 * @see elm_diskselector_side_label_lenght_set()
25855 * @see elm_diskselector_item_label_get()
25856 * @see elm_diskselector_item_append()
25858 * @ingroup Diskselector
25860 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25863 * Get the label of item.
25865 * @param it The item of diskselector.
25866 * @return The label of item.
25868 * The return value is a pointer to the label associated to @p item when it was
25869 * created, with function elm_diskselector_item_append(), or later
25870 * with function elm_diskselector_item_label_set. If no label
25871 * was passed as argument, it will return @c NULL.
25873 * @see elm_diskselector_item_label_set() for more details.
25874 * @see elm_diskselector_item_append()
25876 * @ingroup Diskselector
25878 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25881 * Get the selected item.
25883 * @param obj The diskselector object.
25884 * @return The selected diskselector item.
25886 * The selected item can be unselected with function
25887 * elm_diskselector_item_selected_set(), and the first item of
25888 * diskselector will be selected.
25890 * The selected item always will be centered on diskselector, with
25891 * full label displayed, i.e., max lenght set to side labels won't
25892 * apply on the selected item. More details on
25893 * elm_diskselector_side_label_length_set().
25895 * @ingroup Diskselector
25897 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25900 * Set the selected state of an item.
25902 * @param it The diskselector item
25903 * @param selected The selected state
25905 * This sets the selected state of the given item @p it.
25906 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25908 * If a new item is selected the previosly selected will be unselected.
25909 * Previoulsy selected item can be get with function
25910 * elm_diskselector_selected_item_get().
25912 * If the item @p it is unselected, the first item of diskselector will
25915 * Selected items will be visible on center position of diskselector.
25916 * So if it was on another position before selected, or was invisible,
25917 * diskselector will animate items until the selected item reaches center
25920 * @see elm_diskselector_item_selected_get()
25921 * @see elm_diskselector_selected_item_get()
25923 * @ingroup Diskselector
25925 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25928 * Get whether the @p item is selected or not.
25930 * @param it The diskselector item.
25931 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25932 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25934 * @see elm_diskselector_selected_item_set() for details.
25935 * @see elm_diskselector_item_selected_get()
25937 * @ingroup Diskselector
25939 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25942 * Get the first item of the diskselector.
25944 * @param obj The diskselector object.
25945 * @return The first item, or @c NULL if none.
25947 * The list of items follows append order. So it will return the first
25948 * item appended to the widget that wasn't deleted.
25950 * @see elm_diskselector_item_append()
25951 * @see elm_diskselector_items_get()
25953 * @ingroup Diskselector
25955 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25958 * Get the last item of the diskselector.
25960 * @param obj The diskselector object.
25961 * @return The last item, or @c NULL if none.
25963 * The list of items follows append order. So it will return last first
25964 * item appended to the widget that wasn't deleted.
25966 * @see elm_diskselector_item_append()
25967 * @see elm_diskselector_items_get()
25969 * @ingroup Diskselector
25971 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25974 * Get the item before @p item in diskselector.
25976 * @param it The diskselector item.
25977 * @return The item before @p item, or @c NULL if none or on failure.
25979 * The list of items follows append order. So it will return item appended
25980 * just before @p item and that wasn't deleted.
25982 * If it is the first item, @c NULL will be returned.
25983 * First item can be get by elm_diskselector_first_item_get().
25985 * @see elm_diskselector_item_append()
25986 * @see elm_diskselector_items_get()
25988 * @ingroup Diskselector
25990 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25993 * Get the item after @p item in diskselector.
25995 * @param it The diskselector item.
25996 * @return The item after @p item, or @c NULL if none or on failure.
25998 * The list of items follows append order. So it will return item appended
25999 * just after @p item and that wasn't deleted.
26001 * If it is the last item, @c NULL will be returned.
26002 * Last item can be get by elm_diskselector_last_item_get().
26004 * @see elm_diskselector_item_append()
26005 * @see elm_diskselector_items_get()
26007 * @ingroup Diskselector
26009 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26012 * Set the text to be shown in the diskselector item.
26014 * @param item Target item
26015 * @param text The text to set in the content
26017 * Setup the text as tooltip to object. The item can have only one tooltip,
26018 * so any previous tooltip data is removed.
26020 * @see elm_object_tooltip_text_set() for more details.
26022 * @ingroup Diskselector
26024 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26027 * Set the content to be shown in the tooltip item.
26029 * Setup the tooltip to item. The item can have only one tooltip,
26030 * so any previous tooltip data is removed. @p func(with @p data) will
26031 * be called every time that need show the tooltip and it should
26032 * return a valid Evas_Object. This object is then managed fully by
26033 * tooltip system and is deleted when the tooltip is gone.
26035 * @param item the diskselector item being attached a tooltip.
26036 * @param func the function used to create the tooltip contents.
26037 * @param data what to provide to @a func as callback data/context.
26038 * @param del_cb called when data is not needed anymore, either when
26039 * another callback replaces @p func, the tooltip is unset with
26040 * elm_diskselector_item_tooltip_unset() or the owner @a item
26041 * dies. This callback receives as the first parameter the
26042 * given @a data, and @c event_info is the item.
26044 * @see elm_object_tooltip_content_cb_set() for more details.
26046 * @ingroup Diskselector
26048 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);
26051 * Unset tooltip from item.
26053 * @param item diskselector item to remove previously set tooltip.
26055 * Remove tooltip from item. The callback provided as del_cb to
26056 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26057 * it is not used anymore.
26059 * @see elm_object_tooltip_unset() for more details.
26060 * @see elm_diskselector_item_tooltip_content_cb_set()
26062 * @ingroup Diskselector
26064 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26068 * Sets a different style for this item tooltip.
26070 * @note before you set a style you should define a tooltip with
26071 * elm_diskselector_item_tooltip_content_cb_set() or
26072 * elm_diskselector_item_tooltip_text_set()
26074 * @param item diskselector item with tooltip already set.
26075 * @param style the theme style to use (default, transparent, ...)
26077 * @see elm_object_tooltip_style_set() for more details.
26079 * @ingroup Diskselector
26081 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26084 * Get the style for this item tooltip.
26086 * @param item diskselector item with tooltip already set.
26087 * @return style the theme style in use, defaults to "default". If the
26088 * object does not have a tooltip set, then NULL is returned.
26090 * @see elm_object_tooltip_style_get() for more details.
26091 * @see elm_diskselector_item_tooltip_style_set()
26093 * @ingroup Diskselector
26095 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26098 * Set the cursor to be shown when mouse is over the diskselector item
26100 * @param item Target item
26101 * @param cursor the cursor name to be used.
26103 * @see elm_object_cursor_set() for more details.
26105 * @ingroup Diskselector
26107 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26110 * Get the cursor to be shown when mouse is over the diskselector item
26112 * @param item diskselector item with cursor already set.
26113 * @return the cursor name.
26115 * @see elm_object_cursor_get() for more details.
26116 * @see elm_diskselector_cursor_set()
26118 * @ingroup Diskselector
26120 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26124 * Unset the cursor to be shown when mouse is over the diskselector item
26126 * @param item Target item
26128 * @see elm_object_cursor_unset() for more details.
26129 * @see elm_diskselector_cursor_set()
26131 * @ingroup Diskselector
26133 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26136 * Sets a different style for this item cursor.
26138 * @note before you set a style you should define a cursor with
26139 * elm_diskselector_item_cursor_set()
26141 * @param item diskselector item with cursor already set.
26142 * @param style the theme style to use (default, transparent, ...)
26144 * @see elm_object_cursor_style_set() for more details.
26146 * @ingroup Diskselector
26148 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26152 * Get the style for this item cursor.
26154 * @param item diskselector item with cursor already set.
26155 * @return style the theme style in use, defaults to "default". If the
26156 * object does not have a cursor set, then @c NULL is returned.
26158 * @see elm_object_cursor_style_get() for more details.
26159 * @see elm_diskselector_item_cursor_style_set()
26161 * @ingroup Diskselector
26163 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26167 * Set if the cursor set should be searched on the theme or should use
26168 * the provided by the engine, only.
26170 * @note before you set if should look on theme you should define a cursor
26171 * with elm_diskselector_item_cursor_set().
26172 * By default it will only look for cursors provided by the engine.
26174 * @param item widget item with cursor already set.
26175 * @param engine_only boolean to define if cursors set with
26176 * elm_diskselector_item_cursor_set() should be searched only
26177 * between cursors provided by the engine or searched on widget's
26180 * @see elm_object_cursor_engine_only_set() for more details.
26182 * @ingroup Diskselector
26184 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26187 * Get the cursor engine only usage for this item cursor.
26189 * @param item widget item with cursor already set.
26190 * @return engine_only boolean to define it cursors should be looked only
26191 * between the provided by the engine or searched on widget's theme as well.
26192 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26194 * @see elm_object_cursor_engine_only_get() for more details.
26195 * @see elm_diskselector_item_cursor_engine_only_set()
26197 * @ingroup Diskselector
26199 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26206 * @defgroup Colorselector Colorselector
26210 * @image html img/widget/colorselector/preview-00.png
26211 * @image latex img/widget/colorselector/preview-00.eps
26213 * @brief Widget for user to select a color.
26215 * Signals that you can add callbacks for are:
26216 * "changed" - When the color value changes(event_info is NULL).
26218 * See @ref tutorial_colorselector.
26221 * @brief Add a new colorselector to the parent
26223 * @param parent The parent object
26224 * @return The new object or NULL if it cannot be created
26226 * @ingroup Colorselector
26228 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26230 * Set a color for the colorselector
26232 * @param obj Colorselector object
26233 * @param r r-value of color
26234 * @param g g-value of color
26235 * @param b b-value of color
26236 * @param a a-value of color
26238 * @ingroup Colorselector
26240 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26242 * Get a color from the colorselector
26244 * @param obj Colorselector object
26245 * @param r integer pointer for r-value of color
26246 * @param g integer pointer for g-value of color
26247 * @param b integer pointer for b-value of color
26248 * @param a integer pointer for a-value of color
26250 * @ingroup Colorselector
26252 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26258 * @defgroup Ctxpopup Ctxpopup
26260 * @image html img/widget/ctxpopup/preview-00.png
26261 * @image latex img/widget/ctxpopup/preview-00.eps
26263 * @brief Context popup widet.
26265 * A ctxpopup is a widget that, when shown, pops up a list of items.
26266 * It automatically chooses an area inside its parent object's view
26267 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26268 * optimally fit into it. In the default theme, it will also point an
26269 * arrow to it's top left position at the time one shows it. Ctxpopup
26270 * items have a label and/or an icon. It is intended for a small
26271 * number of items (hence the use of list, not genlist).
26273 * @note Ctxpopup is a especialization of @ref Hover.
26275 * Signals that you can add callbacks for are:
26276 * "dismissed" - the ctxpopup was dismissed
26278 * Default contents parts of the ctxpopup widget that you can use for are:
26279 * @li "elm.swallow.content" - A content of the ctxpopup
26281 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26284 typedef enum _Elm_Ctxpopup_Direction
26286 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26288 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26289 the clicked area */
26290 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26291 the clicked area */
26292 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26294 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26295 } Elm_Ctxpopup_Direction;
26296 #define Elm_Ctxpopup_Item Elm_Object_Item
26299 * @brief Add a new Ctxpopup object to the parent.
26301 * @param parent Parent object
26302 * @return New object or @c NULL, if it cannot be created
26304 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26306 * @brief Set the Ctxpopup's parent
26308 * @param obj The ctxpopup object
26309 * @param area The parent to use
26311 * Set the parent object.
26313 * @note elm_ctxpopup_add() will automatically call this function
26314 * with its @c parent argument.
26316 * @see elm_ctxpopup_add()
26317 * @see elm_hover_parent_set()
26319 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26321 * @brief Get the Ctxpopup's parent
26323 * @param obj The ctxpopup object
26325 * @see elm_ctxpopup_hover_parent_set() for more information
26327 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26329 * @brief Clear all items in the given ctxpopup object.
26331 * @param obj Ctxpopup object
26333 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26335 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26337 * @param obj Ctxpopup object
26338 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26340 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26342 * @brief Get the value of current ctxpopup object's orientation.
26344 * @param obj Ctxpopup object
26345 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26347 * @see elm_ctxpopup_horizontal_set()
26349 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26351 * @brief Add a new item to a ctxpopup object.
26353 * @param obj Ctxpopup object
26354 * @param icon Icon to be set on new item
26355 * @param label The Label of the new item
26356 * @param func Convenience function called when item selected
26357 * @param data Data passed to @p func
26358 * @return A handle to the item added or @c NULL, on errors
26360 * @warning Ctxpopup can't hold both an item list and a content at the same
26361 * time. When an item is added, any previous content will be removed.
26363 * @see elm_ctxpopup_content_set()
26365 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);
26367 * @brief Delete the given item in a ctxpopup object.
26369 * @param it Ctxpopup item to be deleted
26371 * @see elm_ctxpopup_item_append()
26373 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26375 * @brief Set the ctxpopup item's state as disabled or enabled.
26377 * @param it Ctxpopup item to be enabled/disabled
26378 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26380 * When disabled the item is greyed out to indicate it's state.
26382 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26384 * @brief Get the ctxpopup item's disabled/enabled state.
26386 * @param it Ctxpopup item to be enabled/disabled
26387 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26389 * @see elm_ctxpopup_item_disabled_set()
26391 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26393 * @brief Get the icon object for the given ctxpopup item.
26395 * @param it Ctxpopup item
26396 * @return icon object or @c NULL, if the item does not have icon or an error
26399 * @see elm_ctxpopup_item_append()
26400 * @see elm_ctxpopup_item_icon_set()
26402 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26404 * @brief Sets the side icon associated with the ctxpopup item
26406 * @param it Ctxpopup item
26407 * @param icon Icon object to be set
26409 * Once the icon object is set, a previously set one will be deleted.
26410 * @warning Setting the same icon for two items will cause the icon to
26411 * dissapear from the first item.
26413 * @see elm_ctxpopup_item_append()
26415 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26417 * @brief Get the label for the given ctxpopup item.
26419 * @param it Ctxpopup item
26420 * @return label string or @c NULL, if the item does not have label or an
26423 * @see elm_ctxpopup_item_append()
26424 * @see elm_ctxpopup_item_label_set()
26426 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26428 * @brief (Re)set the label on the given ctxpopup item.
26430 * @param it Ctxpopup item
26431 * @param label String to set as label
26433 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26435 * @brief Set an elm widget as the content of the ctxpopup.
26437 * @param obj Ctxpopup object
26438 * @param content Content to be swallowed
26440 * If the content object is already set, a previous one will bedeleted. If
26441 * you want to keep that old content object, use the
26442 * elm_ctxpopup_content_unset() function.
26444 * @deprecated use elm_object_content_set()
26446 * @warning Ctxpopup can't hold both a item list and a content at the same
26447 * time. When a content is set, any previous items will be removed.
26449 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26451 * @brief Unset the ctxpopup content
26453 * @param obj Ctxpopup object
26454 * @return The content that was being used
26456 * Unparent and return the content object which was set for this widget.
26458 * @deprecated use elm_object_content_unset()
26460 * @see elm_ctxpopup_content_set()
26462 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26464 * @brief Set the direction priority of a ctxpopup.
26466 * @param obj Ctxpopup object
26467 * @param first 1st priority of direction
26468 * @param second 2nd priority of direction
26469 * @param third 3th priority of direction
26470 * @param fourth 4th priority of direction
26472 * This functions gives a chance to user to set the priority of ctxpopup
26473 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26474 * requested direction.
26476 * @see Elm_Ctxpopup_Direction
26478 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);
26480 * @brief Get the direction priority of a ctxpopup.
26482 * @param obj Ctxpopup object
26483 * @param first 1st priority of direction to be returned
26484 * @param second 2nd priority of direction to be returned
26485 * @param third 3th priority of direction to be returned
26486 * @param fourth 4th priority of direction to be returned
26488 * @see elm_ctxpopup_direction_priority_set() for more information.
26490 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);
26493 * @brief Get the current direction of a ctxpopup.
26495 * @param obj Ctxpopup object
26496 * @return current direction of a ctxpopup
26498 * @warning Once the ctxpopup showed up, the direction would be determined
26500 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26509 * @defgroup Transit Transit
26510 * @ingroup Elementary
26512 * Transit is designed to apply various animated transition effects to @c
26513 * Evas_Object, such like translation, rotation, etc. For using these
26514 * effects, create an @ref Elm_Transit and add the desired transition effects.
26516 * Once the effects are added into transit, they will be automatically
26517 * managed (their callback will be called until the duration is ended, and
26518 * they will be deleted on completion).
26522 * Elm_Transit *trans = elm_transit_add();
26523 * elm_transit_object_add(trans, obj);
26524 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26525 * elm_transit_duration_set(transit, 1);
26526 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26527 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26528 * elm_transit_repeat_times_set(transit, 3);
26531 * Some transition effects are used to change the properties of objects. They
26533 * @li @ref elm_transit_effect_translation_add
26534 * @li @ref elm_transit_effect_color_add
26535 * @li @ref elm_transit_effect_rotation_add
26536 * @li @ref elm_transit_effect_wipe_add
26537 * @li @ref elm_transit_effect_zoom_add
26538 * @li @ref elm_transit_effect_resizing_add
26540 * Other transition effects are used to make one object disappear and another
26541 * object appear on its old place. These effects are:
26543 * @li @ref elm_transit_effect_flip_add
26544 * @li @ref elm_transit_effect_resizable_flip_add
26545 * @li @ref elm_transit_effect_fade_add
26546 * @li @ref elm_transit_effect_blend_add
26548 * It's also possible to make a transition chain with @ref
26549 * elm_transit_chain_transit_add.
26551 * @warning We strongly recommend to use elm_transit just when edje can not do
26552 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26553 * animations can be manipulated inside the theme.
26555 * List of examples:
26556 * @li @ref transit_example_01_explained
26557 * @li @ref transit_example_02_explained
26558 * @li @ref transit_example_03_c
26559 * @li @ref transit_example_04_c
26565 * @enum Elm_Transit_Tween_Mode
26567 * The type of acceleration used in the transition.
26571 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26572 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26573 over time, then decrease again
26575 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26577 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26579 } Elm_Transit_Tween_Mode;
26582 * @enum Elm_Transit_Effect_Flip_Axis
26584 * The axis where flip effect should be applied.
26588 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26589 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26590 } Elm_Transit_Effect_Flip_Axis;
26592 * @enum Elm_Transit_Effect_Wipe_Dir
26594 * The direction where the wipe effect should occur.
26598 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26599 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26600 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26601 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26602 } Elm_Transit_Effect_Wipe_Dir;
26603 /** @enum Elm_Transit_Effect_Wipe_Type
26605 * Whether the wipe effect should show or hide the object.
26609 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26611 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26613 } Elm_Transit_Effect_Wipe_Type;
26616 * @typedef Elm_Transit
26618 * The Transit created with elm_transit_add(). This type has the information
26619 * about the objects which the transition will be applied, and the
26620 * transition effects that will be used. It also contains info about
26621 * duration, number of repetitions, auto-reverse, etc.
26623 typedef struct _Elm_Transit Elm_Transit;
26624 typedef void Elm_Transit_Effect;
26626 * @typedef Elm_Transit_Effect_Transition_Cb
26628 * Transition callback called for this effect on each transition iteration.
26630 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26632 * Elm_Transit_Effect_End_Cb
26634 * Transition callback called for this effect when the transition is over.
26636 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26639 * Elm_Transit_Del_Cb
26641 * A callback called when the transit is deleted.
26643 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26648 * @note Is not necessary to delete the transit object, it will be deleted at
26649 * the end of its operation.
26650 * @note The transit will start playing when the program enter in the main loop, is not
26651 * necessary to give a start to the transit.
26653 * @return The transit object.
26657 EAPI Elm_Transit *elm_transit_add(void);
26660 * Stops the animation and delete the @p transit object.
26662 * Call this function if you wants to stop the animation before the duration
26663 * time. Make sure the @p transit object is still alive with
26664 * elm_transit_del_cb_set() function.
26665 * All added effects will be deleted, calling its repective data_free_cb
26666 * functions. The function setted by elm_transit_del_cb_set() will be called.
26668 * @see elm_transit_del_cb_set()
26670 * @param transit The transit object to be deleted.
26673 * @warning Just call this function if you are sure the transit is alive.
26675 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26678 * Add a new effect to the transit.
26680 * @note The cb function and the data are the key to the effect. If you try to
26681 * add an already added effect, nothing is done.
26682 * @note After the first addition of an effect in @p transit, if its
26683 * effect list become empty again, the @p transit will be killed by
26684 * elm_transit_del(transit) function.
26688 * Elm_Transit *transit = elm_transit_add();
26689 * elm_transit_effect_add(transit,
26690 * elm_transit_effect_blend_op,
26691 * elm_transit_effect_blend_context_new(),
26692 * elm_transit_effect_blend_context_free);
26695 * @param transit The transit object.
26696 * @param transition_cb The operation function. It is called when the
26697 * animation begins, it is the function that actually performs the animation.
26698 * It is called with the @p data, @p transit and the time progression of the
26699 * animation (a double value between 0.0 and 1.0).
26700 * @param effect The context data of the effect.
26701 * @param end_cb The function to free the context data, it will be called
26702 * at the end of the effect, it must finalize the animation and free the
26706 * @warning The transit free the context data at the and of the transition with
26707 * the data_free_cb function, do not use the context data in another transit.
26709 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);
26712 * Delete an added effect.
26714 * This function will remove the effect from the @p transit, calling the
26715 * data_free_cb to free the @p data.
26717 * @see elm_transit_effect_add()
26719 * @note If the effect is not found, nothing is done.
26720 * @note If the effect list become empty, this function will call
26721 * elm_transit_del(transit), that is, it will kill the @p transit.
26723 * @param transit The transit object.
26724 * @param transition_cb The operation function.
26725 * @param effect The context data of the effect.
26729 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);
26732 * Add new object to apply the effects.
26734 * @note After the first addition of an object in @p transit, if its
26735 * object list become empty again, the @p transit will be killed by
26736 * elm_transit_del(transit) function.
26737 * @note If the @p obj belongs to another transit, the @p obj will be
26738 * removed from it and it will only belong to the @p transit. If the old
26739 * transit stays without objects, it will die.
26740 * @note When you add an object into the @p transit, its state from
26741 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26742 * transit ends, if you change this state whith evas_object_pass_events_set()
26743 * after add the object, this state will change again when @p transit stops to
26746 * @param transit The transit object.
26747 * @param obj Object to be animated.
26750 * @warning It is not allowed to add a new object after transit begins to go.
26752 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26755 * Removes an added object from the transit.
26757 * @note If the @p obj is not in the @p transit, nothing is done.
26758 * @note If the list become empty, this function will call
26759 * elm_transit_del(transit), that is, it will kill the @p transit.
26761 * @param transit The transit object.
26762 * @param obj Object to be removed from @p transit.
26765 * @warning It is not allowed to remove objects after transit begins to go.
26767 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26770 * Get the objects of the transit.
26772 * @param transit The transit object.
26773 * @return a Eina_List with the objects from the transit.
26777 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26780 * Enable/disable keeping up the objects states.
26781 * If it is not kept, the objects states will be reset when transition ends.
26783 * @note @p transit can not be NULL.
26784 * @note One state includes geometry, color, map data.
26786 * @param transit The transit object.
26787 * @param state_keep Keeping or Non Keeping.
26791 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26794 * Get a value whether the objects states will be reset or not.
26796 * @note @p transit can not be NULL
26798 * @see elm_transit_objects_final_state_keep_set()
26800 * @param transit The transit object.
26801 * @return EINA_TRUE means the states of the objects will be reset.
26802 * If @p transit is NULL, EINA_FALSE is returned
26806 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26809 * Set the event enabled when transit is operating.
26811 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26812 * events from mouse and keyboard during the animation.
26813 * @note When you add an object with elm_transit_object_add(), its state from
26814 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26815 * transit ends, if you change this state with evas_object_pass_events_set()
26816 * after adding the object, this state will change again when @p transit stops
26819 * @param transit The transit object.
26820 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26821 * ignored otherwise.
26825 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26828 * Get the value of event enabled status.
26830 * @see elm_transit_event_enabled_set()
26832 * @param transit The Transit object
26833 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26834 * EINA_FALSE is returned
26838 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26841 * Set the user-callback function when the transit is deleted.
26843 * @note Using this function twice will overwrite the first function setted.
26844 * @note the @p transit object will be deleted after call @p cb function.
26846 * @param transit The transit object.
26847 * @param cb Callback function pointer. This function will be called before
26848 * the deletion of the transit.
26849 * @param data Callback funtion user data. It is the @p op parameter.
26853 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26856 * Set reverse effect automatically.
26858 * If auto reverse is setted, after running the effects with the progress
26859 * parameter from 0 to 1, it will call the effecs again with the progress
26860 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26861 * where the duration was setted with the function elm_transit_add and
26862 * the repeat with the function elm_transit_repeat_times_set().
26864 * @param transit The transit object.
26865 * @param reverse EINA_TRUE means the auto_reverse is on.
26869 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26872 * Get if the auto reverse is on.
26874 * @see elm_transit_auto_reverse_set()
26876 * @param transit The transit object.
26877 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26878 * EINA_FALSE is returned
26882 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26885 * Set the transit repeat count. Effect will be repeated by repeat count.
26887 * This function sets the number of repetition the transit will run after
26888 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26889 * If the @p repeat is a negative number, it will repeat infinite times.
26891 * @note If this function is called during the transit execution, the transit
26892 * will run @p repeat times, ignoring the times it already performed.
26894 * @param transit The transit object
26895 * @param repeat Repeat count
26899 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26902 * Get the transit repeat count.
26904 * @see elm_transit_repeat_times_set()
26906 * @param transit The Transit object.
26907 * @return The repeat count. If @p transit is NULL
26912 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26915 * Set the transit animation acceleration type.
26917 * This function sets the tween mode of the transit that can be:
26918 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26919 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26920 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26921 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26923 * @param transit The transit object.
26924 * @param tween_mode The tween type.
26928 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26931 * Get the transit animation acceleration type.
26933 * @note @p transit can not be NULL
26935 * @param transit The transit object.
26936 * @return The tween type. If @p transit is NULL
26937 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26941 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26944 * Set the transit animation time
26946 * @note @p transit can not be NULL
26948 * @param transit The transit object.
26949 * @param duration The animation time.
26953 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26956 * Get the transit animation time
26958 * @note @p transit can not be NULL
26960 * @param transit The transit object.
26962 * @return The transit animation time.
26966 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26969 * Starts the transition.
26970 * Once this API is called, the transit begins to measure the time.
26972 * @note @p transit can not be NULL
26974 * @param transit The transit object.
26978 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26981 * Pause/Resume the transition.
26983 * If you call elm_transit_go again, the transit will be started from the
26984 * beginning, and will be unpaused.
26986 * @note @p transit can not be NULL
26988 * @param transit The transit object.
26989 * @param paused Whether the transition should be paused or not.
26993 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26996 * Get the value of paused status.
26998 * @see elm_transit_paused_set()
27000 * @note @p transit can not be NULL
27002 * @param transit The transit object.
27003 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27004 * EINA_FALSE is returned
27008 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27011 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27013 * The value returned is a fraction (current time / total time). It
27014 * represents the progression position relative to the total.
27016 * @note @p transit can not be NULL
27018 * @param transit The transit object.
27020 * @return The time progression value. If @p transit is NULL
27025 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27028 * Makes the chain relationship between two transits.
27030 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27031 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27033 * @param transit The transit object.
27034 * @param chain_transit The chain transit object. This transit will be operated
27035 * after transit is done.
27037 * This function adds @p chain_transit transition to a chain after the @p
27038 * transit, and will be started as soon as @p transit ends. See @ref
27039 * transit_example_02_explained for a full example.
27043 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27046 * Cut off the chain relationship between two transits.
27048 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27049 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27051 * @param transit The transit object.
27052 * @param chain_transit The chain transit object.
27054 * This function remove the @p chain_transit transition from the @p transit.
27058 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27061 * Get the current chain transit list.
27063 * @note @p transit can not be NULL.
27065 * @param transit The transit object.
27066 * @return chain transit list.
27070 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27073 * Add the Resizing Effect to Elm_Transit.
27075 * @note This API is one of the facades. It creates resizing effect context
27076 * and add it's required APIs to elm_transit_effect_add.
27078 * @see elm_transit_effect_add()
27080 * @param transit Transit object.
27081 * @param from_w Object width size when effect begins.
27082 * @param from_h Object height size when effect begins.
27083 * @param to_w Object width size when effect ends.
27084 * @param to_h Object height size when effect ends.
27085 * @return Resizing effect context data.
27089 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);
27092 * Add the Translation Effect to Elm_Transit.
27094 * @note This API is one of the facades. It creates translation effect context
27095 * and add it's required APIs to elm_transit_effect_add.
27097 * @see elm_transit_effect_add()
27099 * @param transit Transit object.
27100 * @param from_dx X Position variation when effect begins.
27101 * @param from_dy Y Position variation when effect begins.
27102 * @param to_dx X Position variation when effect ends.
27103 * @param to_dy Y Position variation when effect ends.
27104 * @return Translation effect context data.
27107 * @warning It is highly recommended just create a transit with this effect when
27108 * the window that the objects of the transit belongs has already been created.
27109 * This is because this effect needs the geometry information about the objects,
27110 * and if the window was not created yet, it can get a wrong information.
27112 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);
27115 * Add the Zoom Effect to Elm_Transit.
27117 * @note This API is one of the facades. It creates zoom effect context
27118 * and add it's required APIs to elm_transit_effect_add.
27120 * @see elm_transit_effect_add()
27122 * @param transit Transit object.
27123 * @param from_rate Scale rate when effect begins (1 is current rate).
27124 * @param to_rate Scale rate when effect ends.
27125 * @return Zoom effect context data.
27128 * @warning It is highly recommended just create a transit with this effect when
27129 * the window that the objects of the transit belongs has already been created.
27130 * This is because this effect needs the geometry information about the objects,
27131 * and if the window was not created yet, it can get a wrong information.
27133 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27136 * Add the Flip Effect to Elm_Transit.
27138 * @note This API is one of the facades. It creates flip effect context
27139 * and add it's required APIs to elm_transit_effect_add.
27140 * @note This effect is applied to each pair of objects in the order they are listed
27141 * in the transit list of objects. The first object in the pair will be the
27142 * "front" object and the second will be the "back" object.
27144 * @see elm_transit_effect_add()
27146 * @param transit Transit object.
27147 * @param axis Flipping Axis(X or Y).
27148 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27149 * @return Flip effect context data.
27152 * @warning It is highly recommended just create a transit with this effect when
27153 * the window that the objects of the transit belongs has already been created.
27154 * This is because this effect needs the geometry information about the objects,
27155 * and if the window was not created yet, it can get a wrong information.
27157 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27160 * Add the Resizable Flip Effect to Elm_Transit.
27162 * @note This API is one of the facades. It creates resizable flip effect context
27163 * and add it's required APIs to elm_transit_effect_add.
27164 * @note This effect is applied to each pair of objects in the order they are listed
27165 * in the transit list of objects. The first object in the pair will be the
27166 * "front" object and the second will be the "back" object.
27168 * @see elm_transit_effect_add()
27170 * @param transit Transit object.
27171 * @param axis Flipping Axis(X or Y).
27172 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27173 * @return Resizable flip effect context data.
27176 * @warning It is highly recommended just create a transit with this effect when
27177 * the window that the objects of the transit belongs has already been created.
27178 * This is because this effect needs the geometry information about the objects,
27179 * and if the window was not created yet, it can get a wrong information.
27181 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27184 * Add the Wipe Effect to Elm_Transit.
27186 * @note This API is one of the facades. It creates wipe effect context
27187 * and add it's required APIs to elm_transit_effect_add.
27189 * @see elm_transit_effect_add()
27191 * @param transit Transit object.
27192 * @param type Wipe type. Hide or show.
27193 * @param dir Wipe Direction.
27194 * @return Wipe effect context data.
27197 * @warning It is highly recommended just create a transit with this effect when
27198 * the window that the objects of the transit belongs has already been created.
27199 * This is because this effect needs the geometry information about the objects,
27200 * and if the window was not created yet, it can get a wrong information.
27202 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27205 * Add the Color Effect to Elm_Transit.
27207 * @note This API is one of the facades. It creates color effect context
27208 * and add it's required APIs to elm_transit_effect_add.
27210 * @see elm_transit_effect_add()
27212 * @param transit Transit object.
27213 * @param from_r RGB R when effect begins.
27214 * @param from_g RGB G when effect begins.
27215 * @param from_b RGB B when effect begins.
27216 * @param from_a RGB A when effect begins.
27217 * @param to_r RGB R when effect ends.
27218 * @param to_g RGB G when effect ends.
27219 * @param to_b RGB B when effect ends.
27220 * @param to_a RGB A when effect ends.
27221 * @return Color effect context data.
27225 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);
27228 * Add the Fade Effect to Elm_Transit.
27230 * @note This API is one of the facades. It creates fade effect context
27231 * and add it's required APIs to elm_transit_effect_add.
27232 * @note This effect is applied to each pair of objects in the order they are listed
27233 * in the transit list of objects. The first object in the pair will be the
27234 * "before" object and the second will be the "after" object.
27236 * @see elm_transit_effect_add()
27238 * @param transit Transit object.
27239 * @return Fade effect context data.
27242 * @warning It is highly recommended just create a transit with this effect when
27243 * the window that the objects of the transit belongs has already been created.
27244 * This is because this effect needs the color information about the objects,
27245 * and if the window was not created yet, it can get a wrong information.
27247 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27250 * Add the Blend Effect to Elm_Transit.
27252 * @note This API is one of the facades. It creates blend effect context
27253 * and add it's required APIs to elm_transit_effect_add.
27254 * @note This effect is applied to each pair of objects in the order they are listed
27255 * in the transit list of objects. The first object in the pair will be the
27256 * "before" object and the second will be the "after" object.
27258 * @see elm_transit_effect_add()
27260 * @param transit Transit object.
27261 * @return Blend effect context data.
27264 * @warning It is highly recommended just create a transit with this effect when
27265 * the window that the objects of the transit belongs has already been created.
27266 * This is because this effect needs the color information about the objects,
27267 * and if the window was not created yet, it can get a wrong information.
27269 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27272 * Add the Rotation Effect to Elm_Transit.
27274 * @note This API is one of the facades. It creates rotation effect context
27275 * and add it's required APIs to elm_transit_effect_add.
27277 * @see elm_transit_effect_add()
27279 * @param transit Transit object.
27280 * @param from_degree Degree when effect begins.
27281 * @param to_degree Degree when effect is ends.
27282 * @return Rotation effect context data.
27285 * @warning It is highly recommended just create a transit with this effect when
27286 * the window that the objects of the transit belongs has already been created.
27287 * This is because this effect needs the geometry information about the objects,
27288 * and if the window was not created yet, it can get a wrong information.
27290 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27293 * Add the ImageAnimation Effect to Elm_Transit.
27295 * @note This API is one of the facades. It creates image animation effect context
27296 * and add it's required APIs to elm_transit_effect_add.
27297 * The @p images parameter is a list images paths. This list and
27298 * its contents will be deleted at the end of the effect by
27299 * elm_transit_effect_image_animation_context_free() function.
27303 * char buf[PATH_MAX];
27304 * Eina_List *images = NULL;
27305 * Elm_Transit *transi = elm_transit_add();
27307 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27308 * images = eina_list_append(images, eina_stringshare_add(buf));
27310 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27311 * images = eina_list_append(images, eina_stringshare_add(buf));
27312 * elm_transit_effect_image_animation_add(transi, images);
27316 * @see elm_transit_effect_add()
27318 * @param transit Transit object.
27319 * @param images Eina_List of images file paths. This list and
27320 * its contents will be deleted at the end of the effect by
27321 * elm_transit_effect_image_animation_context_free() function.
27322 * @return Image Animation effect context data.
27326 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27332 typedef struct _Elm_Store Elm_Store;
27333 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27334 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27335 typedef struct _Elm_Store_Item Elm_Store_Item;
27336 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27337 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27338 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27339 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27340 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27341 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27342 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27343 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27344 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27346 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27347 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27348 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27349 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27350 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27351 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27352 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27356 ELM_STORE_ITEM_MAPPING_NONE = 0,
27357 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27358 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27359 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27360 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27361 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27362 // can add more here as needed by common apps
27363 ELM_STORE_ITEM_MAPPING_LAST
27364 } Elm_Store_Item_Mapping_Type;
27366 struct _Elm_Store_Item_Mapping_Icon
27368 // FIXME: allow edje file icons
27370 Elm_Icon_Lookup_Order lookup_order;
27371 Eina_Bool standard_name : 1;
27372 Eina_Bool no_scale : 1;
27373 Eina_Bool smooth : 1;
27374 Eina_Bool scale_up : 1;
27375 Eina_Bool scale_down : 1;
27378 struct _Elm_Store_Item_Mapping_Empty
27383 struct _Elm_Store_Item_Mapping_Photo
27388 struct _Elm_Store_Item_Mapping_Custom
27390 Elm_Store_Item_Mapping_Cb func;
27393 struct _Elm_Store_Item_Mapping
27395 Elm_Store_Item_Mapping_Type type;
27400 Elm_Store_Item_Mapping_Empty empty;
27401 Elm_Store_Item_Mapping_Icon icon;
27402 Elm_Store_Item_Mapping_Photo photo;
27403 Elm_Store_Item_Mapping_Custom custom;
27404 // add more types here
27408 struct _Elm_Store_Item_Info
27413 Eina_Bool rec_item;
27414 int pre_group_index;
27416 Elm_Genlist_Item_Class *item_class;
27417 const Elm_Store_Item_Mapping *mapping;
27422 struct _Elm_Store_Item_Info_Filesystem
27424 Elm_Store_Item_Info base;
27428 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27429 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27431 EAPI Elm_Store *elm_store_dbsystem_new(void);
27432 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27433 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27434 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27435 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27436 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27437 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27438 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27439 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27440 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27441 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27442 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27443 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27444 EAPI void elm_store_free(Elm_Store *st);
27445 EAPI Elm_Store *elm_store_filesystem_new(void);
27446 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27447 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27448 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27450 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27452 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27453 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27454 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27455 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27456 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27457 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27459 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27460 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27461 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27462 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27463 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27464 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27465 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27468 * @defgroup SegmentControl SegmentControl
27469 * @ingroup Elementary
27471 * @image html img/widget/segment_control/preview-00.png
27472 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27474 * @image html img/segment_control.png
27475 * @image latex img/segment_control.eps width=\textwidth
27477 * Segment control widget is a horizontal control made of multiple segment
27478 * items, each segment item functioning similar to discrete two state button.
27479 * A segment control groups the items together and provides compact
27480 * single button with multiple equal size segments.
27482 * Segment item size is determined by base widget
27483 * size and the number of items added.
27484 * Only one segment item can be at selected state. A segment item can display
27485 * combination of Text and any Evas_Object like Images or other widget.
27487 * Smart callbacks one can listen to:
27488 * - "changed" - When the user clicks on a segment item which is not
27489 * previously selected and get selected. The event_info parameter is the
27490 * segment item pointer.
27492 * Available styles for it:
27495 * Here is an example on its usage:
27496 * @li @ref segment_control_example
27500 * @addtogroup SegmentControl
27504 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27507 * Add a new segment control widget to the given parent Elementary
27508 * (container) object.
27510 * @param parent The parent object.
27511 * @return a new segment control widget handle or @c NULL, on errors.
27513 * This function inserts a new segment control widget on the canvas.
27515 * @ingroup SegmentControl
27517 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27520 * Append a new item to the segment control object.
27522 * @param obj The segment control object.
27523 * @param icon The icon object to use for the left side of the item. An
27524 * icon can be any Evas object, but usually it is an icon created
27525 * with elm_icon_add().
27526 * @param label The label of the item.
27527 * Note that, NULL is different from empty string "".
27528 * @return The created item or @c NULL upon failure.
27530 * A new item will be created and appended to the segment control, i.e., will
27531 * be set as @b last item.
27533 * If it should be inserted at another position,
27534 * elm_segment_control_item_insert_at() should be used instead.
27536 * Items created with this function can be deleted with function
27537 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27539 * @note @p label set to @c NULL is different from empty string "".
27541 * only has icon, it will be displayed bigger and centered. If it has
27542 * icon and label, even that an empty string, icon will be smaller and
27543 * positioned at left.
27547 * sc = elm_segment_control_add(win);
27548 * ic = elm_icon_add(win);
27549 * elm_icon_file_set(ic, "path/to/image", NULL);
27550 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27551 * elm_segment_control_item_add(sc, ic, "label");
27552 * evas_object_show(sc);
27555 * @see elm_segment_control_item_insert_at()
27556 * @see elm_segment_control_item_del()
27558 * @ingroup SegmentControl
27560 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27563 * Insert a new item to the segment control object at specified position.
27565 * @param obj The segment control object.
27566 * @param icon The icon object to use for the left side of the item. An
27567 * icon can be any Evas object, but usually it is an icon created
27568 * with elm_icon_add().
27569 * @param label The label of the item.
27570 * @param index Item position. Value should be between 0 and items count.
27571 * @return The created item or @c NULL upon failure.
27573 * Index values must be between @c 0, when item will be prepended to
27574 * segment control, and items count, that can be get with
27575 * elm_segment_control_item_count_get(), case when item will be appended
27576 * to segment control, just like elm_segment_control_item_add().
27578 * Items created with this function can be deleted with function
27579 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27581 * @note @p label set to @c NULL is different from empty string "".
27583 * only has icon, it will be displayed bigger and centered. If it has
27584 * icon and label, even that an empty string, icon will be smaller and
27585 * positioned at left.
27587 * @see elm_segment_control_item_add()
27588 * @see elm_segment_control_item_count_get()
27589 * @see elm_segment_control_item_del()
27591 * @ingroup SegmentControl
27593 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);
27596 * Remove a segment control item from its parent, deleting it.
27598 * @param it The item to be removed.
27600 * Items can be added with elm_segment_control_item_add() or
27601 * elm_segment_control_item_insert_at().
27603 * @ingroup SegmentControl
27605 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27608 * Remove a segment control item at given index from its parent,
27611 * @param obj The segment control object.
27612 * @param index The position of the segment control item to be deleted.
27614 * Items can be added with elm_segment_control_item_add() or
27615 * elm_segment_control_item_insert_at().
27617 * @ingroup SegmentControl
27619 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27622 * Get the Segment items count from segment control.
27624 * @param obj The segment control object.
27625 * @return Segment items count.
27627 * It will just return the number of items added to segment control @p obj.
27629 * @ingroup SegmentControl
27631 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27634 * Get the item placed at specified index.
27636 * @param obj The segment control object.
27637 * @param index The index of the segment item.
27638 * @return The segment control item or @c NULL on failure.
27640 * Index is the position of an item in segment control widget. Its
27641 * range is from @c 0 to <tt> count - 1 </tt>.
27642 * Count is the number of items, that can be get with
27643 * elm_segment_control_item_count_get().
27645 * @ingroup SegmentControl
27647 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27650 * Get the label of item.
27652 * @param obj The segment control object.
27653 * @param index The index of the segment item.
27654 * @return The label of the item at @p index.
27656 * The return value is a pointer to the label associated to the item when
27657 * it was created, with function elm_segment_control_item_add(), or later
27658 * with function elm_segment_control_item_label_set. If no label
27659 * was passed as argument, it will return @c NULL.
27661 * @see elm_segment_control_item_label_set() for more details.
27662 * @see elm_segment_control_item_add()
27664 * @ingroup SegmentControl
27666 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27669 * Set the label of item.
27671 * @param it The item of segment control.
27672 * @param text The label of item.
27674 * The label to be displayed by the item.
27675 * Label will be at right of the icon (if set).
27677 * If a label was passed as argument on item creation, with function
27678 * elm_control_segment_item_add(), it will be already
27679 * displayed by the item.
27681 * @see elm_segment_control_item_label_get()
27682 * @see elm_segment_control_item_add()
27684 * @ingroup SegmentControl
27686 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27689 * Get the icon associated to the item.
27691 * @param obj The segment control object.
27692 * @param index The index of the segment item.
27693 * @return The left side icon associated to the item at @p index.
27695 * The return value is a pointer to the icon associated to the item when
27696 * it was created, with function elm_segment_control_item_add(), or later
27697 * with function elm_segment_control_item_icon_set(). If no icon
27698 * was passed as argument, it will return @c NULL.
27700 * @see elm_segment_control_item_add()
27701 * @see elm_segment_control_item_icon_set()
27703 * @ingroup SegmentControl
27705 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27708 * Set the icon associated to the item.
27710 * @param it The segment control item.
27711 * @param icon The icon object to associate with @p it.
27713 * The icon object to use at left side of the item. An
27714 * icon can be any Evas object, but usually it is an icon created
27715 * with elm_icon_add().
27717 * Once the icon object is set, a previously set one will be deleted.
27718 * @warning Setting the same icon for two items will cause the icon to
27719 * dissapear from the first item.
27721 * If an icon was passed as argument on item creation, with function
27722 * elm_segment_control_item_add(), it will be already
27723 * associated to the item.
27725 * @see elm_segment_control_item_add()
27726 * @see elm_segment_control_item_icon_get()
27728 * @ingroup SegmentControl
27730 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27733 * Get the index of an item.
27735 * @param it The segment control item.
27736 * @return The position of item in segment control widget.
27738 * Index is the position of an item in segment control widget. Its
27739 * range is from @c 0 to <tt> count - 1 </tt>.
27740 * Count is the number of items, that can be get with
27741 * elm_segment_control_item_count_get().
27743 * @ingroup SegmentControl
27745 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27748 * Get the base object of the item.
27750 * @param it The segment control item.
27751 * @return The base object associated with @p it.
27753 * Base object is the @c Evas_Object that represents that item.
27755 * @ingroup SegmentControl
27757 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27760 * Get the selected item.
27762 * @param obj The segment control object.
27763 * @return The selected item or @c NULL if none of segment items is
27766 * The selected item can be unselected with function
27767 * elm_segment_control_item_selected_set().
27769 * The selected item always will be highlighted on segment control.
27771 * @ingroup SegmentControl
27773 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27776 * Set the selected state of an item.
27778 * @param it The segment control item
27779 * @param select The selected state
27781 * This sets the selected state of the given item @p it.
27782 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27784 * If a new item is selected the previosly selected will be unselected.
27785 * Previoulsy selected item can be get with function
27786 * elm_segment_control_item_selected_get().
27788 * The selected item always will be highlighted on segment control.
27790 * @see elm_segment_control_item_selected_get()
27792 * @ingroup SegmentControl
27794 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27801 * @defgroup Grid Grid
27803 * The grid is a grid layout widget that lays out a series of children as a
27804 * fixed "grid" of widgets using a given percentage of the grid width and
27805 * height each using the child object.
27807 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27808 * widgets size itself. The default is 100 x 100, so that means the
27809 * position and sizes of children will effectively be percentages (0 to 100)
27810 * of the width or height of the grid widget
27816 * Add a new grid to the parent
27818 * @param parent The parent object
27819 * @return The new object or NULL if it cannot be created
27823 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27826 * Set the virtual size of the grid
27828 * @param obj The grid object
27829 * @param w The virtual width of the grid
27830 * @param h The virtual height of the grid
27834 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27837 * Get the virtual size of the grid
27839 * @param obj The grid object
27840 * @param w Pointer to integer to store the virtual width of the grid
27841 * @param h Pointer to integer to store the virtual height of the grid
27845 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27848 * Pack child at given position and size
27850 * @param obj The grid object
27851 * @param subobj The child to pack
27852 * @param x The virtual x coord at which to pack it
27853 * @param y The virtual y coord at which to pack it
27854 * @param w The virtual width at which to pack it
27855 * @param h The virtual height at which to pack it
27859 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27862 * Unpack a child from a grid object
27864 * @param obj The grid object
27865 * @param subobj The child to unpack
27869 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27872 * Faster way to remove all child objects from a grid object.
27874 * @param obj The grid object
27875 * @param clear If true, it will delete just removed children
27879 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27882 * Set packing of an existing child at to position and size
27884 * @param subobj The child to set packing of
27885 * @param x The virtual x coord at which to pack it
27886 * @param y The virtual y coord at which to pack it
27887 * @param w The virtual width at which to pack it
27888 * @param h The virtual height at which to pack it
27892 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27895 * get packing of a child
27897 * @param subobj The child to query
27898 * @param x Pointer to integer to store the virtual x coord
27899 * @param y Pointer to integer to store the virtual y coord
27900 * @param w Pointer to integer to store the virtual width
27901 * @param h Pointer to integer to store the virtual height
27905 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27911 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
27912 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
27915 * @defgroup Video Video
27917 * @addtogroup Video
27920 * Elementary comes with two object that help design application that need
27921 * to display video. The main one, Elm_Video, display a video by using Emotion.
27922 * It does embedded the video inside an Edje object, so you can do some
27923 * animation depending on the video state change. It does also implement a
27924 * ressource management policy to remove this burden from the application writer.
27926 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27927 * It take care of updating its content according to Emotion event and provide a
27928 * way to theme itself. It also does automatically raise the priority of the
27929 * linked Elm_Video so it will use the video decoder if available. It also does
27930 * activate the remember function on the linked Elm_Video object.
27932 * Signals that you can add callback for are :
27934 * "forward,clicked" - the user clicked the forward button.
27935 * "info,clicked" - the user clicked the info button.
27936 * "next,clicked" - the user clicked the next button.
27937 * "pause,clicked" - the user clicked the pause button.
27938 * "play,clicked" - the user clicked the play button.
27939 * "prev,clicked" - the user clicked the prev button.
27940 * "rewind,clicked" - the user clicked the rewind button.
27941 * "stop,clicked" - the user clicked the stop button.
27943 * To set the video of the player, you can use elm_object_content_set() API.
27948 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27950 * @param parent The parent object
27951 * @return a new player widget handle or @c NULL, on errors.
27953 * This function inserts a new player widget on the canvas.
27955 * @see elm_object_content_set()
27959 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27962 * @brief Link a Elm_Payer with an Elm_Video object.
27964 * @param player the Elm_Player object.
27965 * @param video The Elm_Video object.
27967 * This mean that action on the player widget will affect the
27968 * video object and the state of the video will be reflected in
27969 * the player itself.
27971 * @see elm_player_add()
27972 * @see elm_video_add()
27976 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27979 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27981 * @param parent The parent object
27982 * @return a new video widget handle or @c NULL, on errors.
27984 * This function inserts a new video widget on the canvas.
27986 * @seeelm_video_file_set()
27987 * @see elm_video_uri_set()
27991 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27994 * @brief Define the file that will be the video source.
27996 * @param video The video object to define the file for.
27997 * @param filename The file to target.
27999 * This function will explicitly define a filename as a source
28000 * for the video of the Elm_Video object.
28002 * @see elm_video_uri_set()
28003 * @see elm_video_add()
28004 * @see elm_player_add()
28008 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28011 * @brief Define the uri that will be the video source.
28013 * @param video The video object to define the file for.
28014 * @param uri The uri to target.
28016 * This function will define an uri as a source for the video of the
28017 * Elm_Video object. URI could be remote source of video, like http:// or local source
28018 * like for example WebCam who are most of the time v4l2:// (but that depend and
28019 * you should use Emotion API to request and list the available Webcam on your system).
28021 * @see elm_video_file_set()
28022 * @see elm_video_add()
28023 * @see elm_player_add()
28027 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28030 * @brief Get the underlying Emotion object.
28032 * @param video The video object to proceed the request on.
28033 * @return the underlying Emotion object.
28037 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28040 * @brief Start to play the video
28042 * @param video The video object to proceed the request on.
28044 * Start to play the video and cancel all suspend state.
28048 EAPI void elm_video_play(Evas_Object *video);
28051 * @brief Pause the video
28053 * @param video The video object to proceed the request on.
28055 * Pause the video and start a timer to trigger suspend mode.
28059 EAPI void elm_video_pause(Evas_Object *video);
28062 * @brief Stop the video
28064 * @param video The video object to proceed the request on.
28066 * Stop the video and put the emotion in deep sleep mode.
28070 EAPI void elm_video_stop(Evas_Object *video);
28073 * @brief Is the video actually playing.
28075 * @param video The video object to proceed the request on.
28076 * @return EINA_TRUE if the video is actually playing.
28078 * You should consider watching event on the object instead of polling
28079 * the object state.
28083 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28086 * @brief Is it possible to seek inside the video.
28088 * @param video The video object to proceed the request on.
28089 * @return EINA_TRUE if is possible to seek inside the video.
28093 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28096 * @brief Is the audio muted.
28098 * @param video The video object to proceed the request on.
28099 * @return EINA_TRUE if the audio is muted.
28103 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28106 * @brief Change the mute state of the Elm_Video object.
28108 * @param video The video object to proceed the request on.
28109 * @param mute The new mute state.
28113 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28116 * @brief Get the audio level of the current video.
28118 * @param video The video object to proceed the request on.
28119 * @return the current audio level.
28123 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28126 * @brief Set the audio level of anElm_Video object.
28128 * @param video The video object to proceed the request on.
28129 * @param volume The new audio volume.
28133 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28135 EAPI double elm_video_play_position_get(const Evas_Object *video);
28136 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28137 EAPI double elm_video_play_length_get(const Evas_Object *video);
28138 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28139 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28140 EAPI const char *elm_video_title_get(const Evas_Object *video);
28145 // FIXME: incomplete - carousel. don't use this until this comment is removed
28146 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28147 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28148 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28149 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28150 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28151 /* smart callbacks called:
28152 * "clicked" - when the user clicks on a carousel item and becomes selected
28157 typedef enum _Elm_Datefield_ItemType
28159 ELM_DATEFIELD_YEAR = 0,
28160 ELM_DATEFIELD_MONTH,
28161 ELM_DATEFIELD_DATE,
28162 ELM_DATEFIELD_HOUR,
28163 ELM_DATEFIELD_MINUTE,
28165 } Elm_Datefield_ItemType;
28167 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28168 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28169 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28170 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28171 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28172 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28173 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28174 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28175 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28176 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28177 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28178 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28179 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28181 /* smart callbacks called:
28182 * "changed" - when datefield value is changed, this signal is sent.
28185 ////////////////////// DEPRECATED ///////////////////////////////////
28187 typedef enum _Elm_Datefield_Layout
28189 ELM_DATEFIELD_LAYOUT_TIME,
28190 ELM_DATEFIELD_LAYOUT_DATE,
28191 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28192 } Elm_Datefield_Layout;
28194 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28195 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28196 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28197 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28198 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28199 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28200 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28201 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28202 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28203 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28204 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28205 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28206 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28207 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28208 /////////////////////////////////////////////////////////////////////
28211 typedef enum _Elm_Popup_Response
28213 ELM_POPUP_RESPONSE_NONE = -1,
28214 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28215 ELM_POPUP_RESPONSE_OK = -3,
28216 ELM_POPUP_RESPONSE_CANCEL = -4,
28217 ELM_POPUP_RESPONSE_CLOSE = -5
28218 } Elm_Popup_Response;
28220 typedef enum _Elm_Popup_Mode
28222 ELM_POPUP_TYPE_NONE = 0,
28223 ELM_POPUP_TYPE_ALERT = (1 << 0)
28226 typedef enum _Elm_Popup_Orient
28228 ELM_POPUP_ORIENT_TOP,
28229 ELM_POPUP_ORIENT_CENTER,
28230 ELM_POPUP_ORIENT_BOTTOM,
28231 ELM_POPUP_ORIENT_LEFT,
28232 ELM_POPUP_ORIENT_RIGHT,
28233 ELM_POPUP_ORIENT_TOP_LEFT,
28234 ELM_POPUP_ORIENT_TOP_RIGHT,
28235 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28236 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28237 } Elm_Popup_Orient;
28239 /* smart callbacks called:
28240 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28243 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28244 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28245 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28246 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28247 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28248 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28249 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28250 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28251 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28252 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28253 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28254 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28255 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28256 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28257 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28258 EAPI int elm_popup_run(Evas_Object *obj);
28260 /* NavigationBar */
28261 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28262 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28266 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28267 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28268 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28269 ELM_NAVIGATIONBAR_BACK_BUTTON
28270 } Elm_Navi_Button_Type;
28272 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28273 EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28274 EAPI void elm_navigationbar_pop(Evas_Object *obj);
28275 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28276 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28277 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28278 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28279 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28280 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28281 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28282 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28283 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28284 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28285 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28286 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28287 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28288 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28289 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28290 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28291 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28292 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28293 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28295 /* NavigationBar */
28296 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28297 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28301 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28302 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28303 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28304 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28305 ELM_NAVIGATIONBAR_EX_MAX
28306 } Elm_Navi_ex_Button_Type;
28307 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28309 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28310 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28311 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
28312 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28313 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28314 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28315 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28316 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28317 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28318 EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28319 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28320 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28321 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28322 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28323 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28324 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28325 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28326 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28327 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28328 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28329 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28330 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28331 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28332 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28333 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28334 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28335 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28336 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28339 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28340 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28341 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28342 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28343 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28344 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28345 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28346 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28347 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28348 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28351 * @defgroup Naviframe Naviframe
28353 * @brief Naviframe is a kind of view manager for the applications.
28355 * Naviframe provides functions to switch different pages with stack
28356 * mechanism. It means if one page(item) needs to be changed to the new one,
28357 * then naviframe would push the new page to it's internal stack. Of course,
28358 * it can be back to the previous page by popping the top page. Naviframe
28359 * provides some transition effect while the pages are switching (same as
28362 * Since each item could keep the different styles, users could keep the
28363 * same look & feel for the pages or different styles for the items in it's
28366 * Signals that you can add callback for are:
28368 * @li "transition,finished" - When the transition is finished in changing
28370 * @li "title,clicked" - User clicked title area
28372 * Default contents parts for the naviframe items that you can use for are:
28374 * @li "elm.swallow.content" - The main content of the page
28375 * @li "elm.swallow.prev_btn" - The button to go to the previous page
28376 * @li "elm.swallow.next_btn" - The button to go to the next page
28378 * Default text parts of naviframe items that you can be used are:
28380 * @li "elm.text.title" - The title label in the title area
28382 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28386 * @brief Add a new Naviframe object to the parent.
28388 * @param parent Parent object
28389 * @return New object or @c NULL, if it cannot be created
28391 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28393 * @brief Push a new item to the top of the naviframe stack (and show it).
28395 * @param obj The naviframe object
28396 * @param title_label The label in the title area. The name of the title
28397 * label part is "elm.text.title"
28398 * @param prev_btn The button to go to the previous item. If it is NULL,
28399 * then naviframe will create a back button automatically. The name of
28400 * the prev_btn part is "elm.swallow.prev_btn"
28401 * @param next_btn The button to go to the next item. Or It could be just an
28402 * extra function button. The name of the next_btn part is
28403 * "elm.swallow.next_btn"
28404 * @param content The main content object. The name of content part is
28405 * "elm.swallow.content"
28406 * @param item_style The current item style name. @c NULL would be default.
28407 * @return The created item or @c NULL upon failure.
28409 * The item pushed becomes one page of the naviframe, this item will be
28410 * deleted when it is popped.
28412 * @see also elm_naviframe_item_style_set()
28414 * The following styles are available for this item:
28417 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);
28419 * @brief Pop an item that is on top of the stack
28421 * @param obj The naviframe object
28422 * @return @c NULL or the content object(if the
28423 * elm_naviframe_content_preserve_on_pop_get is true).
28425 * This pops an item that is on the top(visible) of the naviframe, makes it
28426 * disappear, then deletes the item. The item that was underneath it on the
28427 * stack will become visible.
28429 * @see also elm_naviframe_content_preserve_on_pop_get()
28431 * @ingroup Naviframe
28433 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28435 * @brief Pop the items between the top and the above one on the given item.
28437 * @param it The naviframe item
28439 * @ingroup Naviframe
28441 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28443 * Promote an item already in the naviframe stack to the top of the stack
28445 * @param it The naviframe item
28447 * This will take the indicated item and promote it to the top of the stack
28448 * as if it had been pushed there. The item must already be inside the
28449 * naviframe stack to work.
28452 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28454 * @brief Delete the given item instantly.
28456 * @param it The naviframe item
28458 * This just deletes the given item from the naviframe item list instantly.
28459 * So this would not emit any signals for view transitions but just change
28460 * the current view if the given item is a top one.
28462 * @ingroup Naviframe
28464 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28466 * @brief preserve the content objects when items are popped.
28468 * @param obj The naviframe object
28469 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28471 * @see also elm_naviframe_content_preserve_on_pop_get()
28473 * @ingroup Naviframe
28475 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28477 * @brief Get a value whether preserve mode is enabled or not.
28479 * @param obj The naviframe object
28480 * @return If @c EINA_TRUE, preserve mode is enabled
28482 * @see also elm_naviframe_content_preserve_on_pop_set()
28484 * @ingroup Naviframe
28486 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28488 * @brief Get a top item on the naviframe stack
28490 * @param obj The naviframe object
28491 * @return The top item on the naviframe stack or @c NULL, if the stack is
28494 * @ingroup Naviframe
28496 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28498 * @brief Get a bottom item on the naviframe stack
28500 * @param obj The naviframe object
28501 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28504 * @ingroup Naviframe
28506 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28508 * @brief Set an item style
28510 * @param obj The naviframe item
28511 * @param item_style The current item style name. @c NULL would be default
28513 * The following styles are available for this item:
28516 * @see also elm_naviframe_item_style_get()
28518 * @ingroup Naviframe
28520 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28522 * @brief Get an item style
28524 * @param obj The naviframe item
28525 * @return The current item style name
28527 * @see also elm_naviframe_item_style_set()
28529 * @ingroup Naviframe
28531 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28533 * @brief Show/Hide the title area
28535 * @param it The naviframe item
28536 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28539 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28541 * @see also elm_naviframe_item_title_visible_get()
28543 * @ingroup Naviframe
28545 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28547 * @brief Get a value whether title area is visible or not.
28549 * @param it The naviframe item
28550 * @return If @c EINA_TRUE, title area is visible
28552 * @see also elm_naviframe_item_title_visible_set()
28554 * @ingroup Naviframe
28556 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28559 * @brief Set creating prev button automatically or not
28561 * @param obj The naviframe object
28562 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28563 * be created internally when you pass the @c NULL to the prev_btn
28564 * parameter in elm_naviframe_item_push
28566 * @see also elm_naviframe_item_push()
28568 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28570 * @brief Get a value whether prev button(back button) will be auto pushed or
28573 * @param obj The naviframe object
28574 * @return If @c EINA_TRUE, prev button will be auto pushed.
28576 * @see also elm_naviframe_item_push()
28577 * elm_naviframe_prev_btn_auto_pushed_set()
28579 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28582 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28583 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28584 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28585 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28586 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28587 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28588 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28589 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28590 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28592 typedef enum _Elm_Controlbar_Mode_Type
28594 ELM_CONTROLBAR_MODE_DEFAULT = 0,
28595 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28596 ELM_CONTROLBAR_MODE_TRANSPARENCY,
28597 ELM_CONTROLBAR_MODE_LARGE,
28598 ELM_CONTROLBAR_MODE_SMALL,
28599 ELM_CONTROLBAR_MODE_LEFT,
28600 ELM_CONTROLBAR_MODE_RIGHT
28601 } Elm_Controlbar_Mode_Type;
28603 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28604 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28605 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28606 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28607 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
28608 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
28609 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28610 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28611 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28612 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28613 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28614 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28615 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28616 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28617 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28618 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
28619 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
28620 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28621 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28622 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28623 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28624 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28625 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28626 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28627 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28628 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28629 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28630 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28631 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
28632 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28633 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28634 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28635 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28636 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28637 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28638 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
28639 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28640 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28641 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28644 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28645 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28646 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
28647 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28648 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28649 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28650 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28651 EAPI void elm_searchbar_clear(Evas_Object *obj);
28652 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28654 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28655 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28656 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28657 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28660 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28661 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
28662 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
28663 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28664 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28669 ELM_TICKERNOTI_ORIENT_TOP = 0,
28670 ELM_TICKERNOTI_ORIENT_BOTTOM,
28671 ELM_TICKERNOTI_ORIENT_LAST
28672 } Elm_Tickernoti_Orient;
28674 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
28675 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28676 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28677 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28678 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28679 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28680 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28683 ELM_TICKERNOTI_DEFAULT,
28684 ELM_TICKERNOTI_DETAILVIEW
28685 } Elm_Tickernoti_Mode;
28686 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28687 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28688 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28689 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28690 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28691 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28692 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28693 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28694 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28695 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28696 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28697 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28698 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28699 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28700 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28701 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28702 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28703 /* ############################################################################### */
28705 * Parts which can be used with elm_object_text_part_set() and
28706 * elm_object_text_part_get():
28708 * @li NULL/"default" - Operates on tickernoti content-text
28710 * Parts which can be used with elm_object_content_part_set() and
28711 * elm_object_content_part_get():
28713 * @li "icon" - Operates on tickernoti's icon
28714 * @li "button" - Operates on tickernoti's button
28716 * smart callbacks called:
28717 * @li "clicked" - emitted when tickernoti is clicked, except at the
28718 * swallow/button region, if any.
28719 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28720 * any hide animation, this signal is emitted after the animation.
28724 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28726 struct _Colorpalette_Color
28728 unsigned int r, g, b;
28731 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28732 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28733 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28734 /* smart callbacks called:
28735 * "clicked" - when image clicked
28739 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28740 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
28741 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
28742 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28743 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
28744 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28745 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28746 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28747 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28748 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28749 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28750 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28751 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
28752 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28753 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
28754 /* smart callbacks called:
28755 * "clicked" - when an editfield is clicked
28756 * "unfocused" - when an editfield is unfocused
28760 /* Sliding Drawer */
28761 typedef enum _Elm_SlidingDrawer_Pos
28763 ELM_SLIDINGDRAWER_BOTTOM,
28764 ELM_SLIDINGDRAWER_LEFT,
28765 ELM_SLIDINGDRAWER_RIGHT,
28766 ELM_SLIDINGDRAWER_TOP
28767 } Elm_SlidingDrawer_Pos;
28769 typedef struct _Elm_SlidingDrawer_Drag_Value
28772 } Elm_SlidingDrawer_Drag_Value;
28774 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28775 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28776 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28777 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28778 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
28779 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
28781 /* multibuttonentry */
28782 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28783 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28784 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
28785 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
28786 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
28787 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
28788 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
28789 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
28790 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
28791 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
28792 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
28793 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
28794 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
28795 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
28796 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
28797 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
28798 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
28799 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
28800 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
28801 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
28802 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
28803 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
28804 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
28805 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
28806 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
28807 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
28808 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
28809 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
28810 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
28811 /* smart callback called:
28812 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28813 * "added" - This signal is emitted when a new multibuttonentry item is added.
28814 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
28815 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
28816 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
28817 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
28818 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28819 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
28820 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
28821 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
28822 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
28823 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
28825 /* available styles:
28830 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
28831 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
28832 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
28833 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
28834 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
28835 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
28836 /* smart callback called:
28837 * "expanded" - This signal is emitted when a stackedicon is expanded.
28838 * "clicked" - This signal is emitted when a stackedicon is clicked.
28840 /* available styles:
28844 /* dialoguegroup */
28845 typedef struct _Dialogue_Item Dialogue_Item;
28847 typedef enum _Elm_Dialoguegourp_Item_Style
28849 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
28850 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
28851 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
28852 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
28853 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
28854 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
28855 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
28856 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
28857 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
28858 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
28859 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
28860 } Elm_Dialoguegroup_Item_Style;
28862 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
28863 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28864 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28865 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
28866 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
28867 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
28868 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
28869 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
28870 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
28871 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
28872 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
28873 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
28874 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
28875 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
28876 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
28877 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
28882 ELM_DAYSELECTOR_SUN,
28883 ELM_DAYSELECTOR_MON,
28884 ELM_DAYSELECTOR_TUE,
28885 ELM_DAYSELECTOR_WED,
28886 ELM_DAYSELECTOR_THU,
28887 ELM_DAYSELECTOR_FRI,
28888 ELM_DAYSELECTOR_SAT
28889 } Elm_DaySelector_Day;
28891 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
28892 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
28893 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
28896 typedef struct _Imageslider_Item Elm_Imageslider_Item;
28897 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
28898 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28899 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
28900 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
28901 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
28902 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28903 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
28904 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28905 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28906 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28907 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28908 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28909 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
28910 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
28911 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
28912 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);