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_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #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
365 // disabled - evas 1.1 won't have this.
366 //#include <Evas_GL.h>
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when the application has reconfigured elementary settings due
487 * to an external configuration tool asking it to.
489 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
492 * Emitted when any Elementary's policy value is changed.
494 EAPI extern int ELM_EVENT_POLICY_CHANGED;
497 * @typedef Elm_Event_Policy_Changed
499 * Data on the event when an Elementary policy has changed
501 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
504 * @struct _Elm_Event_Policy_Changed
506 * Data on the event when an Elementary policy has changed
508 struct _Elm_Event_Policy_Changed
510 unsigned int policy; /**< the policy identifier */
511 int new_value; /**< value the policy had before the change */
512 int old_value; /**< new value the policy got */
516 * Policy identifiers.
518 typedef enum _Elm_Policy
520 ELM_POLICY_QUIT, /**< under which circumstances the application
521 * should quit automatically. @see
525 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
528 typedef enum _Elm_Policy_Quit
530 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
532 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
534 * window is closed */
535 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
537 typedef enum _Elm_Focus_Direction
541 } Elm_Focus_Direction;
543 typedef enum _Elm_Text_Format
545 ELM_TEXT_FORMAT_PLAIN_UTF8,
546 ELM_TEXT_FORMAT_MARKUP_UTF8
550 * Line wrapping types.
552 typedef enum _Elm_Wrap_Type
554 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
555 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
556 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
557 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
563 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
565 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
566 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
567 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
568 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
569 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
571 ELM_INPUT_PANEL_LAYOUT_INVALID
572 } Elm_Input_Panel_Layout;
576 ELM_AUTOCAPITAL_TYPE_NONE,
577 ELM_AUTOCAPITAL_TYPE_WORD,
578 ELM_AUTOCAPITAL_TYPE_SENTENCE,
579 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
580 } Elm_Autocapital_Type;
583 * @typedef Elm_Object_Item
584 * An Elementary Object item handle.
587 typedef struct _Elm_Object_Item Elm_Object_Item;
591 * Called back when a widget's tooltip is activated and needs content.
592 * @param data user-data given to elm_object_tooltip_content_cb_set()
593 * @param obj owner widget.
594 * @param tooltip The tooltip object (affix content to this!)
596 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
599 * Called back when a widget's item tooltip is activated and needs content.
600 * @param data user-data given to elm_object_tooltip_content_cb_set()
601 * @param obj owner widget.
602 * @param tooltip The tooltip object (affix content to this!)
603 * @param item context dependent item. As an example, if tooltip was
604 * set on Elm_List_Item, then it is of this type.
606 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
608 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
610 #ifndef ELM_LIB_QUICKLAUNCH
611 #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 */
613 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
616 /**************************************************************************/
620 * Initialize Elementary
622 * @param[in] argc System's argument count value
623 * @param[in] argv System's pointer to array of argument strings
624 * @return The init counter value.
626 * This function initializes Elementary and increments a counter of
627 * the number of calls to it. It returns the new counter's value.
629 * @warning This call is exported only for use by the @c ELM_MAIN()
630 * macro. There is no need to use this if you use this macro (which
631 * is highly advisable). An elm_main() should contain the entry
632 * point code for your application, having the same prototype as
633 * elm_init(), and @b not being static (putting the @c EAPI symbol
634 * in front of its type declaration is advisable). The @c
635 * ELM_MAIN() call should be placed just after it.
638 * @dontinclude bg_example_01.c
642 * See the full @ref bg_example_01_c "example".
644 * @see elm_shutdown().
647 EAPI int elm_init(int argc, char **argv);
650 * Shut down Elementary
652 * @return The init counter value.
654 * This should be called at the end of your application, just
655 * before it ceases to do any more processing. This will clean up
656 * any permanent resources your application may have allocated via
657 * Elementary that would otherwise persist.
659 * @see elm_init() for an example
663 EAPI int elm_shutdown(void);
666 * Run Elementary's main loop
668 * This call should be issued just after all initialization is
669 * completed. This function will not return until elm_exit() is
670 * called. It will keep looping, running the main
671 * (event/processing) loop for Elementary.
673 * @see elm_init() for an example
677 EAPI void elm_run(void);
680 * Exit Elementary's main loop
682 * If this call is issued, it will flag the main loop to cease
683 * processing and return back to its parent function (usually your
684 * elm_main() function).
686 * @see elm_init() for an example. There, just after a request to
687 * close the window comes, the main loop will be left.
689 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
690 * applications, you'll be able to get this function called automatically for you.
694 EAPI void elm_exit(void);
697 * Provide information in order to make Elementary determine the @b
698 * run time location of the software in question, so other data files
699 * such as images, sound files, executable utilities, libraries,
700 * modules and locale files can be found.
702 * @param mainfunc This is your application's main function name,
703 * whose binary's location is to be found. Providing @c NULL
704 * will make Elementary not to use it
705 * @param dom This will be used as the application's "domain", in the
706 * form of a prefix to any environment variables that may
707 * override prefix detection and the directory name, inside the
708 * standard share or data directories, where the software's
709 * data files will be looked for.
710 * @param checkfile This is an (optional) magic file's path to check
711 * for existence (and it must be located in the data directory,
712 * under the share directory provided above). Its presence will
713 * help determine the prefix found was correct. Pass @c NULL if
714 * the check is not to be done.
716 * This function allows one to re-locate the application somewhere
717 * else after compilation, if the developer wishes for easier
718 * distribution of pre-compiled binaries.
720 * The prefix system is designed to locate where the given software is
721 * installed (under a common path prefix) at run time and then report
722 * specific locations of this prefix and common directories inside
723 * this prefix like the binary, library, data and locale directories,
724 * through the @c elm_app_*_get() family of functions.
726 * Call elm_app_info_set() early on before you change working
727 * directory or anything about @c argv[0], so it gets accurate
730 * It will then try and trace back which file @p mainfunc comes from,
731 * if provided, to determine the application's prefix directory.
733 * The @p dom parameter provides a string prefix to prepend before
734 * environment variables, allowing a fallback to @b specific
735 * environment variables to locate the software. You would most
736 * probably provide a lowercase string there, because it will also
737 * serve as directory domain, explained next. For environment
738 * variables purposes, this string is made uppercase. For example if
739 * @c "myapp" is provided as the prefix, then the program would expect
740 * @c "MYAPP_PREFIX" as a master environment variable to specify the
741 * exact install prefix for the software, or more specific environment
742 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
743 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
744 * the user or scripts before launching. If not provided (@c NULL),
745 * environment variables will not be used to override compiled-in
746 * defaults or auto detections.
748 * The @p dom string also provides a subdirectory inside the system
749 * shared data directory for data files. For example, if the system
750 * directory is @c /usr/local/share, then this directory name is
751 * appended, creating @c /usr/local/share/myapp, if it @p was @c
752 * "myapp". It is expected that the application installs data files in
755 * The @p checkfile is a file name or path of something inside the
756 * share or data directory to be used to test that the prefix
757 * detection worked. For example, your app will install a wallpaper
758 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
759 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
762 * @see elm_app_compile_bin_dir_set()
763 * @see elm_app_compile_lib_dir_set()
764 * @see elm_app_compile_data_dir_set()
765 * @see elm_app_compile_locale_set()
766 * @see elm_app_prefix_dir_get()
767 * @see elm_app_bin_dir_get()
768 * @see elm_app_lib_dir_get()
769 * @see elm_app_data_dir_get()
770 * @see elm_app_locale_dir_get()
772 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
775 * Provide information on the @b fallback application's binaries
776 * directory, in scenarios where they get overriden by
777 * elm_app_info_set().
779 * @param dir The path to the default binaries directory (compile time
782 * @note Elementary will as well use this path to determine actual
783 * names of binaries' directory paths, maybe changing it to be @c
784 * something/local/bin instead of @c something/bin, only, for
787 * @warning You should call this function @b before
788 * elm_app_info_set().
790 EAPI void elm_app_compile_bin_dir_set(const char *dir);
793 * Provide information on the @b fallback application's libraries
794 * directory, on scenarios where they get overriden by
795 * elm_app_info_set().
797 * @param dir The path to the default libraries directory (compile
800 * @note Elementary will as well use this path to determine actual
801 * names of libraries' directory paths, maybe changing it to be @c
802 * something/lib32 or @c something/lib64 instead of @c something/lib,
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_lib_dir_set(const char *dir);
811 * Provide information on the @b fallback application's data
812 * directory, on scenarios where they get overriden by
813 * elm_app_info_set().
815 * @param dir The path to the default data directory (compile time
818 * @note Elementary will as well use this path to determine actual
819 * names of data directory paths, maybe changing it to be @c
820 * something/local/share instead of @c something/share, only, for
823 * @warning You should call this function @b before
824 * elm_app_info_set().
826 EAPI void elm_app_compile_data_dir_set(const char *dir);
829 * Provide information on the @b fallback application's locale
830 * directory, on scenarios where they get overriden by
831 * elm_app_info_set().
833 * @param dir The path to the default locale directory (compile time
836 * @warning You should call this function @b before
837 * elm_app_info_set().
839 EAPI void elm_app_compile_locale_set(const char *dir);
842 * Retrieve the application's run time prefix directory, as set by
843 * elm_app_info_set() and the way (environment) the application was
846 * @return The directory prefix the application is actually using.
848 EAPI const char *elm_app_prefix_dir_get(void);
851 * Retrieve the application's run time binaries prefix directory, as
852 * set by elm_app_info_set() and the way (environment) the application
855 * @return The binaries directory prefix the application is actually
858 EAPI const char *elm_app_bin_dir_get(void);
861 * Retrieve the application's run time libraries prefix directory, as
862 * set by elm_app_info_set() and the way (environment) the application
865 * @return The libraries directory prefix the application is actually
868 EAPI const char *elm_app_lib_dir_get(void);
871 * Retrieve the application's run time data prefix directory, as
872 * set by elm_app_info_set() and the way (environment) the application
875 * @return The data directory prefix the application is actually
878 EAPI const char *elm_app_data_dir_get(void);
881 * Retrieve the application's run time locale prefix directory, as
882 * set by elm_app_info_set() and the way (environment) the application
885 * @return The locale directory prefix the application is actually
888 EAPI const char *elm_app_locale_dir_get(void);
890 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
891 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
892 EAPI int elm_quicklaunch_init(int argc, char **argv);
893 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
894 EAPI int elm_quicklaunch_sub_shutdown(void);
895 EAPI int elm_quicklaunch_shutdown(void);
896 EAPI void elm_quicklaunch_seed(void);
897 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
898 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
899 EAPI void elm_quicklaunch_cleanup(void);
900 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
901 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
903 EAPI Eina_Bool elm_need_efreet(void);
904 EAPI Eina_Bool elm_need_e_dbus(void);
907 * This must be called before any other function that deals with
908 * elm_thumb objects or ethumb_client instances.
912 EAPI Eina_Bool elm_need_ethumb(void);
915 * This must be called before any other function that deals with
916 * elm_web objects or ewk_view instances.
920 EAPI Eina_Bool elm_need_web(void);
923 * Set a new policy's value (for a given policy group/identifier).
925 * @param policy policy identifier, as in @ref Elm_Policy.
926 * @param value policy value, which depends on the identifier
928 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
930 * Elementary policies define applications' behavior,
931 * somehow. These behaviors are divided in policy groups (see
932 * #Elm_Policy enumeration). This call will emit the Ecore event
933 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
934 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
937 * @note Currently, we have only one policy identifier/group
938 * (#ELM_POLICY_QUIT), which has two possible values.
942 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
945 * Gets the policy value for given policy identifier.
947 * @param policy policy identifier, as in #Elm_Policy.
948 * @return The currently set policy value, for that
949 * identifier. Will be @c 0 if @p policy passed is invalid.
953 EAPI int elm_policy_get(unsigned int policy);
956 * Change the language of the current application
958 * The @p lang passed must be the full name of the locale to use, for
959 * example "en_US.utf8" or "es_ES@euro".
961 * Changing language with this function will make Elementary run through
962 * all its widgets, translating strings set with
963 * elm_object_domain_translatable_text_part_set(). This way, an entire
964 * UI can have its language changed without having to restart the program.
966 * For more complex cases, like having formatted strings that need
967 * translation, widgets will also emit a "language,changed" signal that
968 * the user can listen to to manually translate the text.
970 * @param lang Language to set, must be the full name of the locale
974 EAPI void elm_language_set(const char *lang);
977 * Set a label of an object
979 * @param obj The Elementary object
980 * @param part The text part name to set (NULL for the default label)
981 * @param label The new text of the label
983 * @note Elementary objects may have many labels (e.g. Action Slider)
984 * @deprecated Use elm_object_part_text_set() instead.
987 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
990 * Set a label of an object
992 * @param obj The Elementary object
993 * @param part The text part name to set (NULL for the default label)
994 * @param label The new text of the label
996 * @note Elementary objects may have many labels (e.g. Action Slider)
1000 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1002 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1005 * Get a label of an object
1007 * @param obj The Elementary object
1008 * @param part The text part name to get (NULL for the default label)
1009 * @return text of the label or NULL for any error
1011 * @note Elementary objects may have many labels (e.g. Action Slider)
1012 * @deprecated Use elm_object_part_text_get() instead.
1015 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1018 * Get a label of an object
1020 * @param obj The Elementary object
1021 * @param part The text part name to get (NULL for the default label)
1022 * @return text of the label or NULL for any error
1024 * @note Elementary objects may have many labels (e.g. Action Slider)
1028 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1030 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1033 * Set the text for an objects' part, marking it as translatable.
1035 * The string to set as @p text must be the original one. Do not pass the
1036 * return of @c gettext() here. Elementary will translate the string
1037 * internally and set it on the object using elm_object_part_text_set(),
1038 * also storing the original string so that it can be automatically
1039 * translated when the language is changed with elm_language_set().
1041 * The @p domain will be stored along to find the translation in the
1042 * correct catalog. It can be NULL, in which case it will use whatever
1043 * domain was set by the application with @c textdomain(). This is useful
1044 * in case you are building a library on top of Elementary that will have
1045 * its own translatable strings, that should not be mixed with those of
1046 * programs using the library.
1048 * @param obj The object containing the text part
1049 * @param part The name of the part to set
1050 * @param domain The translation domain to use
1051 * @param text The original, non-translated text to set
1055 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1057 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1059 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1062 * Gets the original string set as translatable for an object
1064 * When setting translated strings, the function elm_object_part_text_get()
1065 * will return the translation returned by @c gettext(). To get the
1066 * original string use this function.
1068 * @param obj The object
1069 * @param part The name of the part that was set
1071 * @return The original, untranslated string
1075 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1077 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1080 * Set a content of an object
1082 * @param obj The Elementary object
1083 * @param part The content part name to set (NULL for the default content)
1084 * @param content The new content of the object
1086 * @note Elementary objects may have many contents
1090 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1092 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1095 * Get a content of an object
1097 * @param obj The Elementary object
1098 * @param item The content part name to get (NULL for the default content)
1099 * @return content of the object or NULL for any error
1101 * @note Elementary objects may have many contents
1105 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1107 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1110 * Unset a content of an object
1112 * @param obj The Elementary object
1113 * @param item The content part name to unset (NULL for the default content)
1115 * @note Elementary objects may have many contents
1119 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1121 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1124 * Set the text to read out when in accessibility mode
1126 * @param obj The object which is to be described
1127 * @param txt The text that describes the widget to people with poor or no vision
1131 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1134 * Get the widget object's handle which contains a given item
1136 * @param item The Elementary object item
1137 * @return The widget object
1139 * @note This returns the widget object itself that an item belongs to.
1143 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1146 * Set a content of an object item
1148 * @param it The Elementary object item
1149 * @param part The content part name to set (NULL for the default content)
1150 * @param content The new content of the object item
1152 * @note Elementary object items may have many contents
1156 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1158 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1161 * Get a content of an object item
1163 * @param it The Elementary object item
1164 * @param part The content part name to unset (NULL for the default content)
1165 * @return content of the object item or NULL for any error
1167 * @note Elementary object items may have many contents
1171 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1173 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1176 * Unset a content of an object item
1178 * @param it The Elementary object item
1179 * @param part The content part name to unset (NULL for the default content)
1181 * @note Elementary object items may have many contents
1185 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1187 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1190 * Set a label of an object item
1192 * @param it The Elementary object item
1193 * @param part The text part name to set (NULL for the default label)
1194 * @param label The new text of the label
1196 * @note Elementary object items may have many labels
1200 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1202 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1205 * Get a label of an object item
1207 * @param it The Elementary object item
1208 * @param part The text part name to get (NULL for the default label)
1209 * @return text of the label or NULL for any error
1211 * @note Elementary object items may have many labels
1215 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1217 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1220 * Set the text to read out when in accessibility mode
1222 * @param it The object item which is to be described
1223 * @param txt The text that describes the widget to people with poor or no vision
1227 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1230 * Get the data associated with an object item
1231 * @param it The Elementary object item
1232 * @return The data associated with @p it
1236 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1239 * Set the data associated with an object item
1240 * @param it The Elementary object item
1241 * @param data The data to be associated with @p it
1245 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1248 * Send a signal to the edje object of the widget item.
1250 * This function sends a signal to the edje object of the obj item. An
1251 * edje program can respond to a signal by specifying matching
1252 * 'signal' and 'source' fields.
1254 * @param it The Elementary object item
1255 * @param emission The signal's name.
1256 * @param source The signal's source.
1259 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1262 * Set the disabled state of an widget item.
1264 * @param obj The Elementary object item
1265 * @param disabled The state to put in in: @c EINA_TRUE for
1266 * disabled, @c EINA_FALSE for enabled
1268 * Elementary object item can be @b disabled, in which state they won't
1269 * receive input and, in general, will be themed differently from
1270 * their normal state, usually greyed out. Useful for contexts
1271 * where you don't want your users to interact with some of the
1272 * parts of you interface.
1274 * This sets the state for the widget item, either disabling it or
1279 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1282 * Get the disabled state of an widget item.
1284 * @param obj The Elementary object
1285 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1286 * if it's enabled (or on errors)
1288 * This gets the state of the widget, which might be enabled or disabled.
1292 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1299 * @defgroup Caches Caches
1301 * These are functions which let one fine-tune some cache values for
1302 * Elementary applications, thus allowing for performance adjustments.
1308 * @brief Flush all caches.
1310 * Frees all data that was in cache and is not currently being used to reduce
1311 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1312 * to calling all of the following functions:
1313 * @li edje_file_cache_flush()
1314 * @li edje_collection_cache_flush()
1315 * @li eet_clearcache()
1316 * @li evas_image_cache_flush()
1317 * @li evas_font_cache_flush()
1318 * @li evas_render_dump()
1319 * @note Evas caches are flushed for every canvas associated with a window.
1323 EAPI void elm_all_flush(void);
1326 * Get the configured cache flush interval time
1328 * This gets the globally configured cache flush interval time, in
1331 * @return The cache flush interval time
1334 * @see elm_all_flush()
1336 EAPI int elm_cache_flush_interval_get(void);
1339 * Set the configured cache flush interval time
1341 * This sets the globally configured cache flush interval time, in ticks
1343 * @param size The cache flush interval time
1346 * @see elm_all_flush()
1348 EAPI void elm_cache_flush_interval_set(int size);
1351 * Set the configured cache flush interval time for all applications on the
1354 * This sets the globally configured cache flush interval time -- in ticks
1355 * -- for all applications on the display.
1357 * @param size The cache flush interval time
1360 EAPI void elm_cache_flush_interval_all_set(int size);
1363 * Get the configured cache flush enabled state
1365 * This gets the globally configured cache flush state - if it is enabled
1366 * or not. When cache flushing is enabled, elementary will regularly
1367 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1368 * memory and allow usage to re-seed caches and data in memory where it
1369 * can do so. An idle application will thus minimise its memory usage as
1370 * data will be freed from memory and not be re-loaded as it is idle and
1371 * not rendering or doing anything graphically right now.
1373 * @return The cache flush state
1376 * @see elm_all_flush()
1378 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1381 * Set the configured cache flush enabled state
1383 * This sets the globally configured cache flush enabled state.
1385 * @param size The cache flush enabled state
1388 * @see elm_all_flush()
1390 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1393 * Set the configured cache flush enabled state for all applications on the
1396 * This sets the globally configured cache flush enabled state for all
1397 * applications on the display.
1399 * @param size The cache flush enabled state
1402 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1405 * Get the configured font cache size
1407 * This gets the globally configured font cache size, in bytes.
1409 * @return The font cache size
1412 EAPI int elm_font_cache_get(void);
1415 * Set the configured font cache size
1417 * This sets the globally configured font cache size, in bytes
1419 * @param size The font cache size
1422 EAPI void elm_font_cache_set(int size);
1425 * Set the configured font cache size for all applications on the
1428 * This sets the globally configured font cache size -- in bytes
1429 * -- for all applications on the display.
1431 * @param size The font cache size
1434 EAPI void elm_font_cache_all_set(int size);
1437 * Get the configured image cache size
1439 * This gets the globally configured image cache size, in bytes
1441 * @return The image cache size
1444 EAPI int elm_image_cache_get(void);
1447 * Set the configured image cache size
1449 * This sets the globally configured image cache size, in bytes
1451 * @param size The image cache size
1454 EAPI void elm_image_cache_set(int size);
1457 * Set the configured image cache size for all applications on the
1460 * This sets the globally configured image cache size -- in bytes
1461 * -- for all applications on the display.
1463 * @param size The image cache size
1466 EAPI void elm_image_cache_all_set(int size);
1469 * Get the configured edje file cache size.
1471 * This gets the globally configured edje file cache size, in number
1474 * @return The edje file cache size
1477 EAPI int elm_edje_file_cache_get(void);
1480 * Set the configured edje file cache size
1482 * This sets the globally configured edje file cache size, in number
1485 * @param size The edje file cache size
1488 EAPI void elm_edje_file_cache_set(int size);
1491 * Set the configured edje file cache size for all applications on the
1494 * This sets the globally configured edje file cache size -- in number
1495 * of files -- for all applications on the display.
1497 * @param size The edje file cache size
1500 EAPI void elm_edje_file_cache_all_set(int size);
1503 * Get the configured edje collections (groups) cache size.
1505 * This gets the globally configured edje collections cache size, in
1506 * number of collections.
1508 * @return The edje collections cache size
1511 EAPI int elm_edje_collection_cache_get(void);
1514 * Set the configured edje collections (groups) cache size
1516 * This sets the globally configured edje collections cache size, in
1517 * number of collections.
1519 * @param size The edje collections cache size
1522 EAPI void elm_edje_collection_cache_set(int size);
1525 * Set the configured edje collections (groups) cache size for all
1526 * applications on the display
1528 * This sets the globally configured edje collections cache size -- in
1529 * number of collections -- for all applications on the display.
1531 * @param size The edje collections cache size
1534 EAPI void elm_edje_collection_cache_all_set(int size);
1541 * @defgroup Scaling Widget Scaling
1543 * Different widgets can be scaled independently. These functions
1544 * allow you to manipulate this scaling on a per-widget basis. The
1545 * object and all its children get their scaling factors multiplied
1546 * by the scale factor set. This is multiplicative, in that if a
1547 * child also has a scale size set it is in turn multiplied by its
1548 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1549 * double size, @c 0.5 is half, etc.
1551 * @ref general_functions_example_page "This" example contemplates
1552 * some of these functions.
1556 * Get the global scaling factor
1558 * This gets the globally configured scaling factor that is applied to all
1561 * @return The scaling factor
1564 EAPI double elm_scale_get(void);
1567 * Set the global scaling factor
1569 * This sets the globally configured scaling factor that is applied to all
1572 * @param scale The scaling factor to set
1575 EAPI void elm_scale_set(double scale);
1578 * Set the global scaling factor for all applications on the display
1580 * This sets the globally configured scaling factor that is applied to all
1581 * objects for all applications.
1582 * @param scale The scaling factor to set
1585 EAPI void elm_scale_all_set(double scale);
1588 * Set the scaling factor for a given Elementary object
1590 * @param obj The Elementary to operate on
1591 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1596 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1599 * Get the scaling factor for a given Elementary object
1601 * @param obj The object
1602 * @return The scaling factor set by elm_object_scale_set()
1606 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1609 * @defgroup Password_last_show Password last input show
1611 * Last show feature of password mode enables user to view
1612 * the last input entered for few seconds before masking it.
1613 * These functions allow to set this feature in password mode
1614 * of entry widget and also allow to manipulate the duration
1615 * for which the input has to be visible.
1621 * Get show last setting of password mode.
1623 * This gets the show last input setting of password mode which might be
1624 * enabled or disabled.
1626 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1628 * @ingroup Password_last_show
1630 EAPI Eina_Bool elm_password_show_last_get(void);
1633 * Set show last setting in password mode.
1635 * This enables or disables show last setting of password mode.
1637 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1638 * @see elm_password_show_last_timeout_set()
1639 * @ingroup Password_last_show
1641 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1644 * Get's the timeout value in last show password mode.
1646 * This gets the time out value for which the last input entered in password
1647 * mode will be visible.
1649 * @return The timeout value of last show password mode.
1650 * @ingroup Password_last_show
1652 EAPI double elm_password_show_last_timeout_get(void);
1655 * Set's the timeout value in last show password mode.
1657 * This sets the time out value for which the last input entered in password
1658 * mode will be visible.
1660 * @param password_show_last_timeout The timeout value.
1661 * @see elm_password_show_last_set()
1662 * @ingroup Password_last_show
1664 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1671 * @defgroup UI-Mirroring Selective Widget mirroring
1673 * These functions allow you to set ui-mirroring on specific
1674 * widgets or the whole interface. Widgets can be in one of two
1675 * modes, automatic and manual. Automatic means they'll be changed
1676 * according to the system mirroring mode and manual means only
1677 * explicit changes will matter. You are not supposed to change
1678 * mirroring state of a widget set to automatic, will mostly work,
1679 * but the behavior is not really defined.
1684 EAPI Eina_Bool elm_mirrored_get(void);
1685 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1688 * Get the system mirrored mode. This determines the default mirrored mode
1691 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1693 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1696 * Set the system mirrored mode. This determines the default mirrored mode
1699 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1701 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1704 * Returns the widget's mirrored mode setting.
1706 * @param obj The widget.
1707 * @return mirrored mode setting of the object.
1710 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1713 * Sets the widget's mirrored mode setting.
1714 * When widget in automatic mode, it follows the system mirrored mode set by
1715 * elm_mirrored_set().
1716 * @param obj The widget.
1717 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1719 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1726 * Set the style to use by a widget
1728 * Sets the style name that will define the appearance of a widget. Styles
1729 * vary from widget to widget and may also be defined by other themes
1730 * by means of extensions and overlays.
1732 * @param obj The Elementary widget to style
1733 * @param style The style name to use
1735 * @see elm_theme_extension_add()
1736 * @see elm_theme_extension_del()
1737 * @see elm_theme_overlay_add()
1738 * @see elm_theme_overlay_del()
1742 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1744 * Get the style used by the widget
1746 * This gets the style being used for that widget. Note that the string
1747 * pointer is only valid as longas the object is valid and the style doesn't
1750 * @param obj The Elementary widget to query for its style
1751 * @return The style name used
1753 * @see elm_object_style_set()
1757 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1760 * @defgroup Styles Styles
1762 * Widgets can have different styles of look. These generic API's
1763 * set styles of widgets, if they support them (and if the theme(s)
1766 * @ref general_functions_example_page "This" example contemplates
1767 * some of these functions.
1771 * Set the disabled state of an Elementary object.
1773 * @param obj The Elementary object to operate on
1774 * @param disabled The state to put in in: @c EINA_TRUE for
1775 * disabled, @c EINA_FALSE for enabled
1777 * Elementary objects can be @b disabled, in which state they won't
1778 * receive input and, in general, will be themed differently from
1779 * their normal state, usually greyed out. Useful for contexts
1780 * where you don't want your users to interact with some of the
1781 * parts of you interface.
1783 * This sets the state for the widget, either disabling it or
1788 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1791 * Get the disabled state of an Elementary object.
1793 * @param obj The Elementary object to operate on
1794 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1795 * if it's enabled (or on errors)
1797 * This gets the state of the widget, which might be enabled or disabled.
1801 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1804 * @defgroup WidgetNavigation Widget Tree Navigation.
1806 * How to check if an Evas Object is an Elementary widget? How to
1807 * get the first elementary widget that is parent of the given
1808 * object? These are all covered in widget tree navigation.
1810 * @ref general_functions_example_page "This" example contemplates
1811 * some of these functions.
1815 * Check if the given Evas Object is an Elementary widget.
1817 * @param obj the object to query.
1818 * @return @c EINA_TRUE if it is an elementary widget variant,
1819 * @c EINA_FALSE otherwise
1820 * @ingroup WidgetNavigation
1822 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1825 * Get the first parent of the given object that is an Elementary
1828 * @param obj the Elementary object to query parent from.
1829 * @return the parent object that is an Elementary widget, or @c
1830 * NULL, if it was not found.
1832 * Use this to query for an object's parent widget.
1834 * @note Most of Elementary users wouldn't be mixing non-Elementary
1835 * smart objects in the objects tree of an application, as this is
1836 * an advanced usage of Elementary with Evas. So, except for the
1837 * application's window, which is the root of that tree, all other
1838 * objects would have valid Elementary widget parents.
1840 * @ingroup WidgetNavigation
1842 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1845 * Get the top level parent of an Elementary widget.
1847 * @param obj The object to query.
1848 * @return The top level Elementary widget, or @c NULL if parent cannot be
1850 * @ingroup WidgetNavigation
1852 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1855 * Get the string that represents this Elementary widget.
1857 * @note Elementary is weird and exposes itself as a single
1858 * Evas_Object_Smart_Class of type "elm_widget", so
1859 * evas_object_type_get() always return that, making debug and
1860 * language bindings hard. This function tries to mitigate this
1861 * problem, but the solution is to change Elementary to use
1862 * proper inheritance.
1864 * @param obj the object to query.
1865 * @return Elementary widget name, or @c NULL if not a valid widget.
1866 * @ingroup WidgetNavigation
1868 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1871 * @defgroup Config Elementary Config
1873 * Elementary configuration is formed by a set options bounded to a
1874 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1875 * "finger size", etc. These are functions with which one syncronizes
1876 * changes made to those values to the configuration storing files, de
1877 * facto. You most probably don't want to use the functions in this
1878 * group unlees you're writing an elementary configuration manager.
1884 * Save back Elementary's configuration, so that it will persist on
1887 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1890 * This function will take effect -- thus, do I/O -- immediately. Use
1891 * it when you want to apply all configuration changes at once. The
1892 * current configuration set will get saved onto the current profile
1893 * configuration file.
1896 EAPI Eina_Bool elm_config_save(void);
1899 * Reload Elementary's configuration, bounded to current selected
1902 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1905 * Useful when you want to force reloading of configuration values for
1906 * a profile. If one removes user custom configuration directories,
1907 * for example, it will force a reload with system values instead.
1910 EAPI void elm_config_reload(void);
1917 * @defgroup Profile Elementary Profile
1919 * Profiles are pre-set options that affect the whole look-and-feel of
1920 * Elementary-based applications. There are, for example, profiles
1921 * aimed at desktop computer applications and others aimed at mobile,
1922 * touchscreen-based ones. You most probably don't want to use the
1923 * functions in this group unlees you're writing an elementary
1924 * configuration manager.
1930 * Get Elementary's profile in use.
1932 * This gets the global profile that is applied to all Elementary
1935 * @return The profile's name
1938 EAPI const char *elm_profile_current_get(void);
1941 * Get an Elementary's profile directory path in the filesystem. One
1942 * may want to fetch a system profile's dir or an user one (fetched
1945 * @param profile The profile's name
1946 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1947 * or a system one (@c EINA_FALSE)
1948 * @return The profile's directory path.
1951 * @note You must free it with elm_profile_dir_free().
1953 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1956 * Free an Elementary's profile directory path, as returned by
1957 * elm_profile_dir_get().
1959 * @param p_dir The profile's path
1963 EAPI void elm_profile_dir_free(const char *p_dir);
1966 * Get Elementary's list of available profiles.
1968 * @return The profiles list. List node data are the profile name
1972 * @note One must free this list, after usage, with the function
1973 * elm_profile_list_free().
1975 EAPI Eina_List *elm_profile_list_get(void);
1978 * Free Elementary's list of available profiles.
1980 * @param l The profiles list, as returned by elm_profile_list_get().
1984 EAPI void elm_profile_list_free(Eina_List *l);
1987 * Set Elementary's profile.
1989 * This sets the global profile that is applied to Elementary
1990 * applications. Just the process the call comes from will be
1993 * @param profile The profile's name
1997 EAPI void elm_profile_set(const char *profile);
2000 * Set Elementary's profile.
2002 * This sets the global profile that is applied to all Elementary
2003 * applications. All running Elementary windows will be affected.
2005 * @param profile The profile's name
2009 EAPI void elm_profile_all_set(const char *profile);
2016 * @defgroup Engine Elementary Engine
2018 * These are functions setting and querying which rendering engine
2019 * Elementary will use for drawing its windows' pixels.
2021 * The following are the available engines:
2022 * @li "software_x11"
2025 * @li "software_16_x11"
2026 * @li "software_8_x11"
2029 * @li "software_gdi"
2030 * @li "software_16_wince_gdi"
2032 * @li "software_16_sdl"
2036 * @li "opengl_cocoa"
2043 * @brief Get Elementary's rendering engine in use.
2045 * @return The rendering engine's name
2046 * @note there's no need to free the returned string, here.
2048 * This gets the global rendering engine that is applied to all Elementary
2051 * @see elm_engine_set()
2053 EAPI const char *elm_engine_current_get(void);
2056 * @brief Set Elementary's rendering engine for use.
2058 * @param engine The rendering engine's name
2060 * This sets global rendering engine that is applied to all Elementary
2061 * applications. Note that it will take effect only to Elementary windows
2062 * created after this is called.
2064 * @see elm_win_add()
2066 EAPI void elm_engine_set(const char *engine);
2073 * @defgroup Fonts Elementary Fonts
2075 * These are functions dealing with font rendering, selection and the
2076 * like for Elementary applications. One might fetch which system
2077 * fonts are there to use and set custom fonts for individual classes
2078 * of UI items containing text (text classes).
2083 typedef struct _Elm_Text_Class
2089 typedef struct _Elm_Font_Overlay
2091 const char *text_class;
2093 Evas_Font_Size size;
2096 typedef struct _Elm_Font_Properties
2100 } Elm_Font_Properties;
2103 * Get Elementary's list of supported text classes.
2105 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2108 * Release the list with elm_text_classes_list_free().
2110 EAPI const Eina_List *elm_text_classes_list_get(void);
2113 * Free Elementary's list of supported text classes.
2117 * @see elm_text_classes_list_get().
2119 EAPI void elm_text_classes_list_free(const Eina_List *list);
2122 * Get Elementary's list of font overlays, set with
2123 * elm_font_overlay_set().
2125 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2130 * For each text class, one can set a <b>font overlay</b> for it,
2131 * overriding the default font properties for that class coming from
2132 * the theme in use. There is no need to free this list.
2134 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2136 EAPI const Eina_List *elm_font_overlay_list_get(void);
2139 * Set a font overlay for a given Elementary text class.
2141 * @param text_class Text class name
2142 * @param font Font name and style string
2143 * @param size Font size
2147 * @p font has to be in the format returned by
2148 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2149 * and elm_font_overlay_unset().
2151 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2154 * Unset a font overlay for a given Elementary text class.
2156 * @param text_class Text class name
2160 * This will bring back text elements belonging to text class
2161 * @p text_class back to their default font settings.
2163 EAPI void elm_font_overlay_unset(const char *text_class);
2166 * Apply the changes made with elm_font_overlay_set() and
2167 * elm_font_overlay_unset() on the current Elementary window.
2171 * This applies all font overlays set to all objects in the UI.
2173 EAPI void elm_font_overlay_apply(void);
2176 * Apply the changes made with elm_font_overlay_set() and
2177 * elm_font_overlay_unset() on all Elementary application windows.
2181 * This applies all font overlays set to all objects in the UI.
2183 EAPI void elm_font_overlay_all_apply(void);
2186 * Translate a font (family) name string in fontconfig's font names
2187 * syntax into an @c Elm_Font_Properties struct.
2189 * @param font The font name and styles string
2190 * @return the font properties struct
2194 * @note The reverse translation can be achived with
2195 * elm_font_fontconfig_name_get(), for one style only (single font
2196 * instance, not family).
2198 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2201 * Free font properties return by elm_font_properties_get().
2203 * @param efp the font properties struct
2207 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2210 * Translate a font name, bound to a style, into fontconfig's font names
2213 * @param name The font (family) name
2214 * @param style The given style (may be @c NULL)
2216 * @return the font name and style string
2220 * @note The reverse translation can be achived with
2221 * elm_font_properties_get(), for one style only (single font
2222 * instance, not family).
2224 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2227 * Free the font string return by elm_font_fontconfig_name_get().
2229 * @param efp the font properties struct
2233 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2236 * Create a font hash table of available system fonts.
2238 * One must call it with @p list being the return value of
2239 * evas_font_available_list(). The hash will be indexed by font
2240 * (family) names, being its values @c Elm_Font_Properties blobs.
2242 * @param list The list of available system fonts, as returned by
2243 * evas_font_available_list().
2244 * @return the font hash.
2248 * @note The user is supposed to get it populated at least with 3
2249 * default font families (Sans, Serif, Monospace), which should be
2250 * present on most systems.
2252 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2255 * Free the hash return by elm_font_available_hash_add().
2257 * @param hash the hash to be freed.
2261 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2268 * @defgroup Fingers Fingers
2270 * Elementary is designed to be finger-friendly for touchscreens,
2271 * and so in addition to scaling for display resolution, it can
2272 * also scale based on finger "resolution" (or size). You can then
2273 * customize the granularity of the areas meant to receive clicks
2276 * Different profiles may have pre-set values for finger sizes.
2278 * @ref general_functions_example_page "This" example contemplates
2279 * some of these functions.
2285 * Get the configured "finger size"
2287 * @return The finger size
2289 * This gets the globally configured finger size, <b>in pixels</b>
2293 EAPI Evas_Coord elm_finger_size_get(void);
2296 * Set the configured finger size
2298 * This sets the globally configured finger size in pixels
2300 * @param size The finger size
2303 EAPI void elm_finger_size_set(Evas_Coord size);
2306 * Set the configured finger size for all applications on the display
2308 * This sets the globally configured finger size in pixels for all
2309 * applications on the display
2311 * @param size The finger size
2314 EAPI void elm_finger_size_all_set(Evas_Coord size);
2321 * @defgroup Focus Focus
2323 * An Elementary application has, at all times, one (and only one)
2324 * @b focused object. This is what determines where the input
2325 * events go to within the application's window. Also, focused
2326 * objects can be decorated differently, in order to signal to the
2327 * user where the input is, at a given moment.
2329 * Elementary applications also have the concept of <b>focus
2330 * chain</b>: one can cycle through all the windows' focusable
2331 * objects by input (tab key) or programmatically. The default
2332 * focus chain for an application is the one define by the order in
2333 * which the widgets where added in code. One will cycle through
2334 * top level widgets, and, for each one containg sub-objects, cycle
2335 * through them all, before returning to the level
2336 * above. Elementary also allows one to set @b custom focus chains
2337 * for their applications.
2339 * Besides the focused decoration a widget may exhibit, when it
2340 * gets focus, Elementary has a @b global focus highlight object
2341 * that can be enabled for a window. If one chooses to do so, this
2342 * extra highlight effect will surround the current focused object,
2345 * @note Some Elementary widgets are @b unfocusable, after
2346 * creation, by their very nature: they are not meant to be
2347 * interacted with input events, but are there just for visual
2350 * @ref general_functions_example_page "This" example contemplates
2351 * some of these functions.
2355 * Get the enable status of the focus highlight
2357 * This gets whether the highlight on focused objects is enabled or not
2360 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2363 * Set the enable status of the focus highlight
2365 * Set whether to show or not the highlight on focused objects
2366 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2369 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2372 * Get the enable status of the highlight animation
2374 * Get whether the focus highlight, if enabled, will animate its switch from
2375 * one object to the next
2378 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2381 * Set the enable status of the highlight animation
2383 * Set whether the focus highlight, if enabled, will animate its switch from
2384 * one object to the next
2385 * @param animate Enable animation if EINA_TRUE, disable otherwise
2388 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2391 * Get the whether an Elementary object has the focus or not.
2393 * @param obj The Elementary object to get the information from
2394 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2395 * not (and on errors).
2397 * @see elm_object_focus_set()
2401 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 * Set/unset focus to a given Elementary object.
2406 * @param obj The Elementary object to operate on.
2407 * @param enable @c EINA_TRUE Set focus to a given object,
2408 * @c EINA_FALSE Unset focus to a given object.
2410 * @note When you set focus to this object, if it can handle focus, will
2411 * take the focus away from the one who had it previously and will, for
2412 * now on, be the one receiving input events. Unsetting focus will remove
2413 * the focus from @p obj, passing it back to the previous element in the
2416 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2420 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2423 * Make a given Elementary object the focused one.
2425 * @param obj The Elementary object to make focused.
2427 * @note This object, if it can handle focus, will take the focus
2428 * away from the one who had it previously and will, for now on, be
2429 * the one receiving input events.
2431 * @see elm_object_focus_get()
2432 * @deprecated use elm_object_focus_set() instead.
2436 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2439 * Remove the focus from an Elementary object
2441 * @param obj The Elementary to take focus from
2443 * This removes the focus from @p obj, passing it back to the
2444 * previous element in the focus chain list.
2446 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2447 * @deprecated use elm_object_focus_set() instead.
2451 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2454 * Set the ability for an Element object to be focused
2456 * @param obj The Elementary object to operate on
2457 * @param enable @c EINA_TRUE if the object can be focused, @c
2458 * EINA_FALSE if not (and on errors)
2460 * This sets whether the object @p obj is able to take focus or
2461 * not. Unfocusable objects do nothing when programmatically
2462 * focused, being the nearest focusable parent object the one
2463 * really getting focus. Also, when they receive mouse input, they
2464 * will get the event, but not take away the focus from where it
2469 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2472 * Get whether an Elementary object is focusable or not
2474 * @param obj The Elementary object to operate on
2475 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2476 * EINA_FALSE if not (and on errors)
2478 * @note Objects which are meant to be interacted with by input
2479 * events are created able to be focused, by default. All the
2484 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2487 * Set custom focus chain.
2489 * This function overwrites any previous custom focus chain within
2490 * the list of objects. The previous list will be deleted and this list
2491 * will be managed by elementary. After it is set, don't modify it.
2493 * @note On focus cycle, only will be evaluated children of this container.
2495 * @param obj The container object
2496 * @param objs Chain of objects to pass focus
2499 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2502 * Unset a custom focus chain on a given Elementary widget
2504 * @param obj The container object to remove focus chain from
2506 * Any focus chain previously set on @p obj (for its child objects)
2507 * is removed entirely after this call.
2511 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2514 * Get custom focus chain
2516 * @param obj The container object
2519 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2522 * Append object to custom focus chain.
2524 * @note If relative_child equal to NULL or not in custom chain, the object
2525 * will be added in end.
2527 * @note On focus cycle, only will be evaluated children of this container.
2529 * @param obj The container object
2530 * @param child The child to be added in custom chain
2531 * @param relative_child The relative object to position the child
2534 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2537 * Prepend object to custom focus chain.
2539 * @note If relative_child equal to NULL or not in custom chain, the object
2540 * will be added in begin.
2542 * @note On focus cycle, only will be evaluated children of this container.
2544 * @param obj The container object
2545 * @param child The child to be added in custom chain
2546 * @param relative_child The relative object to position the child
2549 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2552 * Give focus to next object in object tree.
2554 * Give focus to next object in focus chain of one object sub-tree.
2555 * If the last object of chain already have focus, the focus will go to the
2556 * first object of chain.
2558 * @param obj The object root of sub-tree
2559 * @param dir Direction to cycle the focus
2563 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2566 * Give focus to near object in one direction.
2568 * Give focus to near object in direction of one object.
2569 * If none focusable object in given direction, the focus will not change.
2571 * @param obj The reference object
2572 * @param x Horizontal component of direction to focus
2573 * @param y Vertical component of direction to focus
2577 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2580 * Make the elementary object and its children to be unfocusable
2583 * @param obj The Elementary object to operate on
2584 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2585 * @c EINA_FALSE for focusable.
2587 * This sets whether the object @p obj and its children objects
2588 * are able to take focus or not. If the tree is set as unfocusable,
2589 * newest focused object which is not in this tree will get focus.
2590 * This API can be helpful for an object to be deleted.
2591 * When an object will be deleted soon, it and its children may not
2592 * want to get focus (by focus reverting or by other focus controls).
2593 * Then, just use this API before deleting.
2595 * @see elm_object_tree_unfocusable_get()
2599 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2602 * Get whether an Elementary object and its children are unfocusable or not.
2604 * @param obj The Elementary object to get the information from
2605 * @return @c EINA_TRUE, if the tree is unfocussable,
2606 * @c EINA_FALSE if not (and on errors).
2608 * @see elm_object_tree_unfocusable_set()
2612 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2615 * @defgroup Scrolling Scrolling
2617 * These are functions setting how scrollable views in Elementary
2618 * widgets should behave on user interaction.
2624 * Get whether scrollers should bounce when they reach their
2625 * viewport's edge during a scroll.
2627 * @return the thumb scroll bouncing state
2629 * This is the default behavior for touch screens, in general.
2630 * @ingroup Scrolling
2632 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2635 * Set whether scrollers should bounce when they reach their
2636 * viewport's edge during a scroll.
2638 * @param enabled the thumb scroll bouncing state
2640 * @see elm_thumbscroll_bounce_enabled_get()
2641 * @ingroup Scrolling
2643 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2646 * Set whether scrollers should bounce when they reach their
2647 * viewport's edge during a scroll, for all Elementary application
2650 * @param enabled the thumb scroll bouncing state
2652 * @see elm_thumbscroll_bounce_enabled_get()
2653 * @ingroup Scrolling
2655 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2658 * Get the amount of inertia a scroller will impose at bounce
2661 * @return the thumb scroll bounce friction
2663 * @ingroup Scrolling
2665 EAPI double elm_scroll_bounce_friction_get(void);
2668 * Set the amount of inertia a scroller will impose at bounce
2671 * @param friction the thumb scroll bounce friction
2673 * @see elm_thumbscroll_bounce_friction_get()
2674 * @ingroup Scrolling
2676 EAPI void elm_scroll_bounce_friction_set(double friction);
2679 * Set the amount of inertia a scroller will impose at bounce
2680 * animations, for all Elementary application windows.
2682 * @param friction the thumb scroll bounce friction
2684 * @see elm_thumbscroll_bounce_friction_get()
2685 * @ingroup Scrolling
2687 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2690 * Get the amount of inertia a <b>paged</b> scroller will impose at
2691 * page fitting animations.
2693 * @return the page scroll friction
2695 * @ingroup Scrolling
2697 EAPI double elm_scroll_page_scroll_friction_get(void);
2700 * Set the amount of inertia a <b>paged</b> scroller will impose at
2701 * page fitting animations.
2703 * @param friction the page scroll friction
2705 * @see elm_thumbscroll_page_scroll_friction_get()
2706 * @ingroup Scrolling
2708 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2711 * Set the amount of inertia a <b>paged</b> scroller will impose at
2712 * page fitting animations, for all Elementary application windows.
2714 * @param friction the page scroll friction
2716 * @see elm_thumbscroll_page_scroll_friction_get()
2717 * @ingroup Scrolling
2719 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2722 * Get the amount of inertia a scroller will impose at region bring
2725 * @return the bring in scroll friction
2727 * @ingroup Scrolling
2729 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2732 * Set the amount of inertia a scroller will impose at region bring
2735 * @param friction the bring in scroll friction
2737 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2738 * @ingroup Scrolling
2740 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2743 * Set the amount of inertia a scroller will impose at region bring
2744 * animations, for all Elementary application windows.
2746 * @param friction the bring in scroll friction
2748 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2749 * @ingroup Scrolling
2751 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2754 * Get the amount of inertia scrollers will impose at animations
2755 * triggered by Elementary widgets' zooming API.
2757 * @return the zoom friction
2759 * @ingroup Scrolling
2761 EAPI double elm_scroll_zoom_friction_get(void);
2764 * Set the amount of inertia scrollers will impose at animations
2765 * triggered by Elementary widgets' zooming API.
2767 * @param friction the zoom friction
2769 * @see elm_thumbscroll_zoom_friction_get()
2770 * @ingroup Scrolling
2772 EAPI void elm_scroll_zoom_friction_set(double friction);
2775 * Set the amount of inertia scrollers will impose at animations
2776 * triggered by Elementary widgets' zooming API, for all Elementary
2777 * application windows.
2779 * @param friction the zoom friction
2781 * @see elm_thumbscroll_zoom_friction_get()
2782 * @ingroup Scrolling
2784 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2787 * Get whether scrollers should be draggable from any point in their
2790 * @return the thumb scroll state
2792 * @note This is the default behavior for touch screens, in general.
2793 * @note All other functions namespaced with "thumbscroll" will only
2794 * have effect if this mode is enabled.
2796 * @ingroup Scrolling
2798 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2801 * Set whether scrollers should be draggable from any point in their
2804 * @param enabled the thumb scroll state
2806 * @see elm_thumbscroll_enabled_get()
2807 * @ingroup Scrolling
2809 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2812 * Set whether scrollers should be draggable from any point in their
2813 * views, for all Elementary application windows.
2815 * @param enabled the thumb scroll state
2817 * @see elm_thumbscroll_enabled_get()
2818 * @ingroup Scrolling
2820 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2823 * Get the number of pixels one should travel while dragging a
2824 * scroller's view to actually trigger scrolling.
2826 * @return the thumb scroll threshould
2828 * One would use higher values for touch screens, in general, because
2829 * of their inherent imprecision.
2830 * @ingroup Scrolling
2832 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2835 * Set the number of pixels one should travel while dragging a
2836 * scroller's view to actually trigger scrolling.
2838 * @param threshold the thumb scroll threshould
2840 * @see elm_thumbscroll_threshould_get()
2841 * @ingroup Scrolling
2843 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2846 * Set the number of pixels one should travel while dragging a
2847 * scroller's view to actually trigger scrolling, for all Elementary
2848 * application windows.
2850 * @param threshold the thumb scroll threshould
2852 * @see elm_thumbscroll_threshould_get()
2853 * @ingroup Scrolling
2855 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2858 * Get the minimum speed of mouse cursor movement which will trigger
2859 * list self scrolling animation after a mouse up event
2862 * @return the thumb scroll momentum threshould
2864 * @ingroup Scrolling
2866 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2869 * Set the minimum speed of mouse cursor movement which will trigger
2870 * list self scrolling animation after a mouse up event
2873 * @param threshold the thumb scroll momentum threshould
2875 * @see elm_thumbscroll_momentum_threshould_get()
2876 * @ingroup Scrolling
2878 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2881 * Set the minimum speed of mouse cursor movement which will trigger
2882 * list self scrolling animation after a mouse up event
2883 * (pixels/second), for all Elementary application windows.
2885 * @param threshold the thumb scroll momentum threshould
2887 * @see elm_thumbscroll_momentum_threshould_get()
2888 * @ingroup Scrolling
2890 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2893 * Get the amount of inertia a scroller will impose at self scrolling
2896 * @return the thumb scroll friction
2898 * @ingroup Scrolling
2900 EAPI double elm_scroll_thumbscroll_friction_get(void);
2903 * Set the amount of inertia a scroller will impose at self scrolling
2906 * @param friction the thumb scroll friction
2908 * @see elm_thumbscroll_friction_get()
2909 * @ingroup Scrolling
2911 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2914 * Set the amount of inertia a scroller will impose at self scrolling
2915 * animations, for all Elementary application windows.
2917 * @param friction the thumb scroll friction
2919 * @see elm_thumbscroll_friction_get()
2920 * @ingroup Scrolling
2922 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2925 * Get the amount of lag between your actual mouse cursor dragging
2926 * movement and a scroller's view movement itself, while pushing it
2927 * into bounce state manually.
2929 * @return the thumb scroll border friction
2931 * @ingroup Scrolling
2933 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2936 * Set the amount of lag between your actual mouse cursor dragging
2937 * movement and a scroller's view movement itself, while pushing it
2938 * into bounce state manually.
2940 * @param friction the thumb scroll border friction. @c 0.0 for
2941 * perfect synchrony between two movements, @c 1.0 for maximum
2944 * @see elm_thumbscroll_border_friction_get()
2945 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2947 * @ingroup Scrolling
2949 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2952 * Set the amount of lag between your actual mouse cursor dragging
2953 * movement and a scroller's view movement itself, while pushing it
2954 * into bounce state manually, for all Elementary application windows.
2956 * @param friction the thumb scroll border friction. @c 0.0 for
2957 * perfect synchrony between two movements, @c 1.0 for maximum
2960 * @see elm_thumbscroll_border_friction_get()
2961 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2963 * @ingroup Scrolling
2965 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2968 * Get the sensitivity amount which is be multiplied by the length of
2971 * @return the thumb scroll sensitivity friction
2973 * @ingroup Scrolling
2975 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2978 * Set the sensitivity amount which is be multiplied by the length of
2981 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2982 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2985 * @see elm_thumbscroll_sensitivity_friction_get()
2986 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2988 * @ingroup Scrolling
2990 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2993 * Set the sensitivity amount which is be multiplied by the length of
2994 * mouse dragging, for all Elementary application windows.
2996 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2997 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3000 * @see elm_thumbscroll_sensitivity_friction_get()
3001 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3003 * @ingroup Scrolling
3005 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3012 * @defgroup Scrollhints Scrollhints
3014 * Objects when inside a scroller can scroll, but this may not always be
3015 * desirable in certain situations. This allows an object to hint to itself
3016 * and parents to "not scroll" in one of 2 ways. If any child object of a
3017 * scroller has pushed a scroll freeze or hold then it affects all parent
3018 * scrollers until all children have released them.
3020 * 1. To hold on scrolling. This means just flicking and dragging may no
3021 * longer scroll, but pressing/dragging near an edge of the scroller will
3022 * still scroll. This is automatically used by the entry object when
3025 * 2. To totally freeze scrolling. This means it stops. until
3032 * Push the scroll hold by 1
3034 * This increments the scroll hold count by one. If it is more than 0 it will
3035 * take effect on the parents of the indicated object.
3037 * @param obj The object
3038 * @ingroup Scrollhints
3040 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3043 * Pop the scroll hold by 1
3045 * This decrements the scroll hold count by one. If it is more than 0 it will
3046 * take effect on the parents of the indicated object.
3048 * @param obj The object
3049 * @ingroup Scrollhints
3051 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3054 * Push the scroll freeze by 1
3056 * This increments the scroll freeze count by one. If it is more
3057 * than 0 it will take effect on the parents of the indicated
3060 * @param obj The object
3061 * @ingroup Scrollhints
3063 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3066 * Pop the scroll freeze by 1
3068 * This decrements the scroll freeze count by one. If it is more
3069 * than 0 it will take effect on the parents of the indicated
3072 * @param obj The object
3073 * @ingroup Scrollhints
3075 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3078 * Lock the scrolling of the given widget (and thus all parents)
3080 * This locks the given object from scrolling in the X axis (and implicitly
3081 * also locks all parent scrollers too from doing the same).
3083 * @param obj The object
3084 * @param lock The lock state (1 == locked, 0 == unlocked)
3085 * @ingroup Scrollhints
3087 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3090 * Lock the scrolling of the given widget (and thus all parents)
3092 * This locks the given object from scrolling in the Y axis (and implicitly
3093 * also locks all parent scrollers too from doing the same).
3095 * @param obj The object
3096 * @param lock The lock state (1 == locked, 0 == unlocked)
3097 * @ingroup Scrollhints
3099 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3102 * Get the scrolling lock of the given widget
3104 * This gets the lock for X axis scrolling.
3106 * @param obj The object
3107 * @ingroup Scrollhints
3109 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3112 * Get the scrolling lock of the given widget
3114 * This gets the lock for X axis scrolling.
3116 * @param obj The object
3117 * @ingroup Scrollhints
3119 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3126 * Send a signal to the widget edje object.
3128 * This function sends a signal to the edje object of the obj. An
3129 * edje program can respond to a signal by specifying matching
3130 * 'signal' and 'source' fields.
3132 * @param obj The object
3133 * @param emission The signal's name.
3134 * @param source The signal's source.
3137 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3140 * Add a callback for a signal emitted by widget edje object.
3142 * This function connects a callback function to a signal emitted by the
3143 * edje object of the obj.
3144 * Globs can occur in either the emission or source name.
3146 * @param obj The object
3147 * @param emission The signal's name.
3148 * @param source The signal's source.
3149 * @param func The callback function to be executed when the signal is
3151 * @param data A pointer to data to pass in to the callback function.
3154 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);
3157 * Remove a signal-triggered callback from a widget edje object.
3159 * This function removes a callback, previoulsy attached to a
3160 * signal emitted by the edje object of the obj. The parameters
3161 * emission, source and func must match exactly those passed to a
3162 * previous call to elm_object_signal_callback_add(). The data
3163 * pointer that was passed to this call will be returned.
3165 * @param obj The object
3166 * @param emission The signal's name.
3167 * @param source The signal's source.
3168 * @param func The callback function to be executed when the signal is
3170 * @return The data pointer
3173 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);
3176 * Add a callback for input events (key up, key down, mouse wheel)
3177 * on a given Elementary widget
3179 * @param obj The widget to add an event callback on
3180 * @param func The callback function to be executed when the event
3182 * @param data Data to pass in to @p func
3184 * Every widget in an Elementary interface set to receive focus,
3185 * with elm_object_focus_allow_set(), will propagate @b all of its
3186 * key up, key down and mouse wheel input events up to its parent
3187 * object, and so on. All of the focusable ones in this chain which
3188 * had an event callback set, with this call, will be able to treat
3189 * those events. There are two ways of making the propagation of
3190 * these event upwards in the tree of widgets to @b cease:
3191 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3192 * the event was @b not processed, so the propagation will go on.
3193 * - The @c event_info pointer passed to @p func will contain the
3194 * event's structure and, if you OR its @c event_flags inner
3195 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3196 * one has already handled it, thus killing the event's
3199 * @note Your event callback will be issued on those events taking
3200 * place only if no other child widget of @obj has consumed the
3203 * @note Not to be confused with @c
3204 * evas_object_event_callback_add(), which will add event callbacks
3205 * per type on general Evas objects (no event propagation
3206 * infrastructure taken in account).
3208 * @note Not to be confused with @c
3209 * elm_object_signal_callback_add(), which will add callbacks to @b
3210 * signals coming from a widget's theme, not input events.
3212 * @note Not to be confused with @c
3213 * edje_object_signal_callback_add(), which does the same as
3214 * elm_object_signal_callback_add(), but directly on an Edje
3217 * @note Not to be confused with @c
3218 * evas_object_smart_callback_add(), which adds callbacks to smart
3219 * objects' <b>smart events</b>, and not input events.
3221 * @see elm_object_event_callback_del()
3225 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3228 * Remove an event callback from a widget.
3230 * This function removes a callback, previoulsy attached to event emission
3232 * The parameters func and data must match exactly those passed to
3233 * a previous call to elm_object_event_callback_add(). The data pointer that
3234 * was passed to this call will be returned.
3236 * @param obj The object
3237 * @param func The callback function to be executed when the event is
3239 * @param data Data to pass in to the callback function.
3240 * @return The data pointer
3243 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3246 * Adjust size of an element for finger usage.
3248 * @param times_w How many fingers should fit horizontally
3249 * @param w Pointer to the width size to adjust
3250 * @param times_h How many fingers should fit vertically
3251 * @param h Pointer to the height size to adjust
3253 * This takes width and height sizes (in pixels) as input and a
3254 * size multiple (which is how many fingers you want to place
3255 * within the area, being "finger" the size set by
3256 * elm_finger_size_set()), and adjusts the size to be large enough
3257 * to accommodate the resulting size -- if it doesn't already
3258 * accommodate it. On return the @p w and @p h sizes pointed to by
3259 * these parameters will be modified, on those conditions.
3261 * @note This is kind of a low level Elementary call, most useful
3262 * on size evaluation times for widgets. An external user wouldn't
3263 * be calling, most of the time.
3267 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3270 * Get the duration for occuring long press event.
3272 * @return Timeout for long press event
3273 * @ingroup Longpress
3275 EAPI double elm_longpress_timeout_get(void);
3278 * Set the duration for occuring long press event.
3280 * @param lonpress_timeout Timeout for long press event
3281 * @ingroup Longpress
3283 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3286 * @defgroup Debug Debug
3287 * don't use it unless you are sure
3293 * Print Tree object hierarchy in stdout
3295 * @param obj The root object
3298 EAPI void elm_object_tree_dump(const Evas_Object *top);
3301 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3303 * @param obj The root object
3304 * @param file The path of output file
3307 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3314 * @defgroup Theme Theme
3316 * Elementary uses Edje to theme its widgets, naturally. But for the most
3317 * part this is hidden behind a simpler interface that lets the user set
3318 * extensions and choose the style of widgets in a much easier way.
3320 * Instead of thinking in terms of paths to Edje files and their groups
3321 * each time you want to change the appearance of a widget, Elementary
3322 * works so you can add any theme file with extensions or replace the
3323 * main theme at one point in the application, and then just set the style
3324 * of widgets with elm_object_style_set() and related functions. Elementary
3325 * will then look in its list of themes for a matching group and apply it,
3326 * and when the theme changes midway through the application, all widgets
3327 * will be updated accordingly.
3329 * There are three concepts you need to know to understand how Elementary
3330 * theming works: default theme, extensions and overlays.
3332 * Default theme, obviously enough, is the one that provides the default
3333 * look of all widgets. End users can change the theme used by Elementary
3334 * by setting the @c ELM_THEME environment variable before running an
3335 * application, or globally for all programs using the @c elementary_config
3336 * utility. Applications can change the default theme using elm_theme_set(),
3337 * but this can go against the user wishes, so it's not an adviced practice.
3339 * Ideally, applications should find everything they need in the already
3340 * provided theme, but there may be occasions when that's not enough and
3341 * custom styles are required to correctly express the idea. For this
3342 * cases, Elementary has extensions.
3344 * Extensions allow the application developer to write styles of its own
3345 * to apply to some widgets. This requires knowledge of how each widget
3346 * is themed, as extensions will always replace the entire group used by
3347 * the widget, so important signals and parts need to be there for the
3348 * object to behave properly (see documentation of Edje for details).
3349 * Once the theme for the extension is done, the application needs to add
3350 * it to the list of themes Elementary will look into, using
3351 * elm_theme_extension_add(), and set the style of the desired widgets as
3352 * he would normally with elm_object_style_set().
3354 * Overlays, on the other hand, can replace the look of all widgets by
3355 * overriding the default style. Like extensions, it's up to the application
3356 * developer to write the theme for the widgets it wants, the difference
3357 * being that when looking for the theme, Elementary will check first the
3358 * list of overlays, then the set theme and lastly the list of extensions,
3359 * so with overlays it's possible to replace the default view and every
3360 * widget will be affected. This is very much alike to setting the whole
3361 * theme for the application and will probably clash with the end user
3362 * options, not to mention the risk of ending up with not matching styles
3363 * across the program. Unless there's a very special reason to use them,
3364 * overlays should be avoided for the resons exposed before.
3366 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3367 * keeps one default internally and every function that receives one of
3368 * these can be called with NULL to refer to this default (except for
3369 * elm_theme_free()). It's possible to create a new instance of a
3370 * ::Elm_Theme to set other theme for a specific widget (and all of its
3371 * children), but this is as discouraged, if not even more so, than using
3372 * overlays. Don't use this unless you really know what you are doing.
3374 * But to be less negative about things, you can look at the following
3376 * @li @ref theme_example_01 "Using extensions"
3377 * @li @ref theme_example_02 "Using overlays"
3382 * @typedef Elm_Theme
3384 * Opaque handler for the list of themes Elementary looks for when
3385 * rendering widgets.
3387 * Stay out of this unless you really know what you are doing. For most
3388 * cases, sticking to the default is all a developer needs.
3390 typedef struct _Elm_Theme Elm_Theme;
3393 * Create a new specific theme
3395 * This creates an empty specific theme that only uses the default theme. A
3396 * specific theme has its own private set of extensions and overlays too
3397 * (which are empty by default). Specific themes do not fall back to themes
3398 * of parent objects. They are not intended for this use. Use styles, overlays
3399 * and extensions when needed, but avoid specific themes unless there is no
3400 * other way (example: you want to have a preview of a new theme you are
3401 * selecting in a "theme selector" window. The preview is inside a scroller
3402 * and should display what the theme you selected will look like, but not
3403 * actually apply it yet. The child of the scroller will have a specific
3404 * theme set to show this preview before the user decides to apply it to all
3407 EAPI Elm_Theme *elm_theme_new(void);
3409 * Free a specific theme
3411 * @param th The theme to free
3413 * This frees a theme created with elm_theme_new().
3415 EAPI void elm_theme_free(Elm_Theme *th);
3417 * Copy the theme fom the source to the destination theme
3419 * @param th The source theme to copy from
3420 * @param thdst The destination theme to copy data to
3422 * This makes a one-time static copy of all the theme config, extensions
3423 * and overlays from @p th to @p thdst. If @p th references a theme, then
3424 * @p thdst is also set to reference it, with all the theme settings,
3425 * overlays and extensions that @p th had.
3427 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3429 * Tell the source theme to reference the ref theme
3431 * @param th The theme that will do the referencing
3432 * @param thref The theme that is the reference source
3434 * This clears @p th to be empty and then sets it to refer to @p thref
3435 * so @p th acts as an override to @p thref, but where its overrides
3436 * don't apply, it will fall through to @p thref for configuration.
3438 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3440 * Return the theme referred to
3442 * @param th The theme to get the reference from
3443 * @return The referenced theme handle
3445 * This gets the theme set as the reference theme by elm_theme_ref_set().
3446 * If no theme is set as a reference, NULL is returned.
3448 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3450 * Return the default theme
3452 * @return The default theme handle
3454 * This returns the internal default theme setup handle that all widgets
3455 * use implicitly unless a specific theme is set. This is also often use
3456 * as a shorthand of NULL.
3458 EAPI Elm_Theme *elm_theme_default_get(void);
3460 * Prepends a theme overlay to the list of overlays
3462 * @param th The theme to add to, or if NULL, the default theme
3463 * @param item The Edje file path to be used
3465 * Use this if your application needs to provide some custom overlay theme
3466 * (An Edje file that replaces some default styles of widgets) where adding
3467 * new styles, or changing system theme configuration is not possible. Do
3468 * NOT use this instead of a proper system theme configuration. Use proper
3469 * configuration files, profiles, environment variables etc. to set a theme
3470 * so that the theme can be altered by simple confiugration by a user. Using
3471 * this call to achieve that effect is abusing the API and will create lots
3474 * @see elm_theme_extension_add()
3476 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3478 * Delete a theme overlay from the list of overlays
3480 * @param th The theme to delete from, or if NULL, the default theme
3481 * @param item The name of the theme overlay
3483 * @see elm_theme_overlay_add()
3485 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3487 * Appends a theme extension to the list of extensions.
3489 * @param th The theme to add to, or if NULL, the default theme
3490 * @param item The Edje file path to be used
3492 * This is intended when an application needs more styles of widgets or new
3493 * widget themes that the default does not provide (or may not provide). The
3494 * application has "extended" usage by coming up with new custom style names
3495 * for widgets for specific uses, but as these are not "standard", they are
3496 * not guaranteed to be provided by a default theme. This means the
3497 * application is required to provide these extra elements itself in specific
3498 * Edje files. This call adds one of those Edje files to the theme search
3499 * path to be search after the default theme. The use of this call is
3500 * encouraged when default styles do not meet the needs of the application.
3501 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3503 * @see elm_object_style_set()
3505 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3507 * Deletes a theme extension from the list of extensions.
3509 * @param th The theme to delete from, or if NULL, the default theme
3510 * @param item The name of the theme extension
3512 * @see elm_theme_extension_add()
3514 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3516 * Set the theme search order for the given theme
3518 * @param th The theme to set the search order, or if NULL, the default theme
3519 * @param theme Theme search string
3521 * This sets the search string for the theme in path-notation from first
3522 * theme to search, to last, delimited by the : character. Example:
3524 * "shiny:/path/to/file.edj:default"
3526 * See the ELM_THEME environment variable for more information.
3528 * @see elm_theme_get()
3529 * @see elm_theme_list_get()
3531 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3533 * Return the theme search order
3535 * @param th The theme to get the search order, or if NULL, the default theme
3536 * @return The internal search order path
3538 * This function returns a colon separated string of theme elements as
3539 * returned by elm_theme_list_get().
3541 * @see elm_theme_set()
3542 * @see elm_theme_list_get()
3544 EAPI const char *elm_theme_get(Elm_Theme *th);
3546 * Return a list of theme elements to be used in a theme.
3548 * @param th Theme to get the list of theme elements from.
3549 * @return The internal list of theme elements
3551 * This returns the internal list of theme elements (will only be valid as
3552 * long as the theme is not modified by elm_theme_set() or theme is not
3553 * freed by elm_theme_free(). This is a list of strings which must not be
3554 * altered as they are also internal. If @p th is NULL, then the default
3555 * theme element list is returned.
3557 * A theme element can consist of a full or relative path to a .edj file,
3558 * or a name, without extension, for a theme to be searched in the known
3559 * theme paths for Elemementary.
3561 * @see elm_theme_set()
3562 * @see elm_theme_get()
3564 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3566 * Return the full patrh for a theme element
3568 * @param f The theme element name
3569 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3570 * @return The full path to the file found.
3572 * This returns a string you should free with free() on success, NULL on
3573 * failure. This will search for the given theme element, and if it is a
3574 * full or relative path element or a simple searchable name. The returned
3575 * path is the full path to the file, if searched, and the file exists, or it
3576 * is simply the full path given in the element or a resolved path if
3577 * relative to home. The @p in_search_path boolean pointed to is set to
3578 * EINA_TRUE if the file was a searchable file andis in the search path,
3579 * and EINA_FALSE otherwise.
3581 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3583 * Flush the current theme.
3585 * @param th Theme to flush
3587 * This flushes caches that let elementary know where to find theme elements
3588 * in the given theme. If @p th is NULL, then the default theme is flushed.
3589 * Call this function if source theme data has changed in such a way as to
3590 * make any caches Elementary kept invalid.
3592 EAPI void elm_theme_flush(Elm_Theme *th);
3594 * This flushes all themes (default and specific ones).
3596 * This will flush all themes in the current application context, by calling
3597 * elm_theme_flush() on each of them.
3599 EAPI void elm_theme_full_flush(void);
3601 * Set the theme for all elementary using applications on the current display
3603 * @param theme The name of the theme to use. Format same as the ELM_THEME
3604 * environment variable.
3606 EAPI void elm_theme_all_set(const char *theme);
3608 * Return a list of theme elements in the theme search path
3610 * @return A list of strings that are the theme element names.
3612 * This lists all available theme files in the standard Elementary search path
3613 * for theme elements, and returns them in alphabetical order as theme
3614 * element names in a list of strings. Free this with
3615 * elm_theme_name_available_list_free() when you are done with the list.
3617 EAPI Eina_List *elm_theme_name_available_list_new(void);
3619 * Free the list returned by elm_theme_name_available_list_new()
3621 * This frees the list of themes returned by
3622 * elm_theme_name_available_list_new(). Once freed the list should no longer
3623 * be used. a new list mys be created.
3625 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3627 * Set a specific theme to be used for this object and its children
3629 * @param obj The object to set the theme on
3630 * @param th The theme to set
3632 * This sets a specific theme that will be used for the given object and any
3633 * child objects it has. If @p th is NULL then the theme to be used is
3634 * cleared and the object will inherit its theme from its parent (which
3635 * ultimately will use the default theme if no specific themes are set).
3637 * Use special themes with great care as this will annoy users and make
3638 * configuration difficult. Avoid any custom themes at all if it can be
3641 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3643 * Get the specific theme to be used
3645 * @param obj The object to get the specific theme from
3646 * @return The specifc theme set.
3648 * This will return a specific theme set, or NULL if no specific theme is
3649 * set on that object. It will not return inherited themes from parents, only
3650 * the specific theme set for that specific object. See elm_object_theme_set()
3651 * for more information.
3653 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3656 * Get a data item from a theme
3658 * @param th The theme, or NULL for default theme
3659 * @param key The data key to search with
3660 * @return The data value, or NULL on failure
3662 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3663 * It works the same way as edje_file_data_get() except that the return is stringshared.
3665 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3671 /** @defgroup Win Win
3673 * @image html img/widget/win/preview-00.png
3674 * @image latex img/widget/win/preview-00.eps
3676 * The window class of Elementary. Contains functions to manipulate
3677 * windows. The Evas engine used to render the window contents is specified
3678 * in the system or user elementary config files (whichever is found last),
3679 * and can be overridden with the ELM_ENGINE environment variable for
3680 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3681 * compilation setup and modules actually installed at runtime) are (listed
3682 * in order of best supported and most likely to be complete and work to
3685 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3686 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3688 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3690 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3692 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3694 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3695 * rendering using SDL as the buffer)
3696 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3697 * GDI with software)
3698 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3699 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3700 * grayscale using dedicated 8bit software engine in X11)
3701 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3702 * X11 using 16bit software engine)
3703 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3704 * (Windows CE rendering via GDI with 16bit software renderer)
3705 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3706 * buffer with 16bit software renderer)
3707 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3708 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3709 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3711 * All engines use a simple string to select the engine to render, EXCEPT
3712 * the "shot" engine. This actually encodes the output of the virtual
3713 * screenshot and how long to delay in the engine string. The engine string
3714 * is encoded in the following way:
3716 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3718 * Where options are separated by a ":" char if more than one option is
3719 * given, with delay, if provided being the first option and file the last
3720 * (order is important). The delay specifies how long to wait after the
3721 * window is shown before doing the virtual "in memory" rendering and then
3722 * save the output to the file specified by the file option (and then exit).
3723 * If no delay is given, the default is 0.5 seconds. If no file is given the
3724 * default output file is "out.png". Repeat option is for continous
3725 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3726 * fixed to "out001.png" Some examples of using the shot engine:
3728 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3729 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3730 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3731 * ELM_ENGINE="shot:delay=2.0" elementary_test
3732 * ELM_ENGINE="shot:" elementary_test
3734 * Signals that you can add callbacks for are:
3736 * @li "delete,request": the user requested to close the window. See
3737 * elm_win_autodel_set().
3738 * @li "focus,in": window got focus
3739 * @li "focus,out": window lost focus
3740 * @li "moved": window that holds the canvas was moved
3743 * @li @ref win_example_01
3748 * Defines the types of window that can be created
3750 * These are hints set on the window so that a running Window Manager knows
3751 * how the window should be handled and/or what kind of decorations it
3754 * Currently, only the X11 backed engines use them.
3756 typedef enum _Elm_Win_Type
3758 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3759 window. Almost every window will be created with this
3761 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3762 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3763 window holding desktop icons. */
3764 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3765 be kept on top of any other window by the Window
3767 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3769 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3770 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3772 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3773 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3774 entry in a menubar is clicked. Typically used
3775 with elm_win_override_set(). This hint exists
3776 for completion only, as the EFL way of
3777 implementing a menu would not normally use a
3778 separate window for its contents. */
3779 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3780 triggered by right-clicking an object. */
3781 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3782 explanatory text that typically appear after the
3783 mouse cursor hovers over an object for a while.
3784 Typically used with elm_win_override_set() and also
3785 not very commonly used in the EFL. */
3786 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3787 battery life or a new E-Mail received. */
3788 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3789 usually used in the EFL. */
3790 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3791 object being dragged across different windows, or even
3792 applications. Typically used with
3793 elm_win_override_set(). */
3794 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3795 buffer. No actual window is created for this
3796 type, instead the window and all of its
3797 contents will be rendered to an image buffer.
3798 This allows to have children window inside a
3799 parent one just like any other object would
3800 be, and do other things like applying @c
3801 Evas_Map effects to it. This is the only type
3802 of window that requires the @c parent
3803 parameter of elm_win_add() to be a valid @c
3808 * The differents layouts that can be requested for the virtual keyboard.
3810 * When the application window is being managed by Illume, it may request
3811 * any of the following layouts for the virtual keyboard.
3813 typedef enum _Elm_Win_Keyboard_Mode
3815 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3816 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3817 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3818 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3819 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3820 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3821 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3822 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3823 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3824 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3825 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3826 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3827 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3828 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3829 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3830 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3831 } Elm_Win_Keyboard_Mode;
3834 * Available commands that can be sent to the Illume manager.
3836 * When running under an Illume session, a window may send commands to the
3837 * Illume manager to perform different actions.
3839 typedef enum _Elm_Illume_Command
3841 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3843 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3845 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3847 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3848 } Elm_Illume_Command;
3851 * Adds a window object. If this is the first window created, pass NULL as
3854 * @param parent Parent object to add the window to, or NULL
3855 * @param name The name of the window
3856 * @param type The window type, one of #Elm_Win_Type.
3858 * The @p parent paramter can be @c NULL for every window @p type except
3859 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3860 * which the image object will be created.
3862 * @return The created object, or NULL on failure
3864 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3866 * Adds a window object with standard setup
3868 * @param name The name of the window
3869 * @param title The title for the window
3871 * This creates a window like elm_win_add() but also puts in a standard
3872 * background with elm_bg_add(), as well as setting the window title to
3873 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3874 * as the parent widget.
3876 * @return The created object, or NULL on failure
3878 * @see elm_win_add()
3880 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3882 * Add @p subobj as a resize object of window @p obj.
3885 * Setting an object as a resize object of the window means that the
3886 * @p subobj child's size and position will be controlled by the window
3887 * directly. That is, the object will be resized to match the window size
3888 * and should never be moved or resized manually by the developer.
3890 * In addition, resize objects of the window control what the minimum size
3891 * of it will be, as well as whether it can or not be resized by the user.
3893 * For the end user to be able to resize a window by dragging the handles
3894 * or borders provided by the Window Manager, or using any other similar
3895 * mechanism, all of the resize objects in the window should have their
3896 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3898 * @param obj The window object
3899 * @param subobj The resize object to add
3901 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3903 * Delete @p subobj as a resize object of window @p obj.
3905 * This function removes the object @p subobj from the resize objects of
3906 * the window @p obj. It will not delete the object itself, which will be
3907 * left unmanaged and should be deleted by the developer, manually handled
3908 * or set as child of some other container.
3910 * @param obj The window object
3911 * @param subobj The resize object to add
3913 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3915 * Set the title of the window
3917 * @param obj The window object
3918 * @param title The title to set
3920 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3922 * Get the title of the window
3924 * The returned string is an internal one and should not be freed or
3925 * modified. It will also be rendered invalid if a new title is set or if
3926 * the window is destroyed.
3928 * @param obj The window object
3931 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3933 * Set the window's autodel state.
3935 * When closing the window in any way outside of the program control, like
3936 * pressing the X button in the titlebar or using a command from the
3937 * Window Manager, a "delete,request" signal is emitted to indicate that
3938 * this event occurred and the developer can take any action, which may
3939 * include, or not, destroying the window object.
3941 * When the @p autodel parameter is set, the window will be automatically
3942 * destroyed when this event occurs, after the signal is emitted.
3943 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3944 * and is up to the program to do so when it's required.
3946 * @param obj The window object
3947 * @param autodel If true, the window will automatically delete itself when
3950 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3952 * Get the window's autodel state.
3954 * @param obj The window object
3955 * @return If the window will automatically delete itself when closed
3957 * @see elm_win_autodel_set()
3959 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961 * Activate a window object.
3963 * This function sends a request to the Window Manager to activate the
3964 * window pointed by @p obj. If honored by the WM, the window will receive
3965 * the keyboard focus.
3967 * @note This is just a request that a Window Manager may ignore, so calling
3968 * this function does not ensure in any way that the window will be the
3969 * active one after it.
3971 * @param obj The window object
3973 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3975 * Lower a window object.
3977 * Places the window pointed by @p obj at the bottom of the stack, so that
3978 * no other window is covered by it.
3980 * If elm_win_override_set() is not set, the Window Manager may ignore this
3983 * @param obj The window object
3985 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3987 * Raise a window object.
3989 * Places the window pointed by @p obj at the top of the stack, so that it's
3990 * not covered by any other window.
3992 * If elm_win_override_set() is not set, the Window Manager may ignore this
3995 * @param obj The window object
3997 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3999 * Set the borderless state of a window.
4001 * This function requests the Window Manager to not draw any decoration
4002 * around the window.
4004 * @param obj The window object
4005 * @param borderless If true, the window is borderless
4007 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4009 * Get the borderless state of a window.
4011 * @param obj The window object
4012 * @return If true, the window is borderless
4014 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4016 * Set the shaped state of a window.
4018 * Shaped windows, when supported, will render the parts of the window that
4019 * has no content, transparent.
4021 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4022 * background object or cover the entire window in any other way, or the
4023 * parts of the canvas that have no data will show framebuffer artifacts.
4025 * @param obj The window object
4026 * @param shaped If true, the window is shaped
4028 * @see elm_win_alpha_set()
4030 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4032 * Get the shaped state of a window.
4034 * @param obj The window object
4035 * @return If true, the window is shaped
4037 * @see elm_win_shaped_set()
4039 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4041 * Set the alpha channel state of a window.
4043 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4044 * possibly making parts of the window completely or partially transparent.
4045 * This is also subject to the underlying system supporting it, like for
4046 * example, running under a compositing manager. If no compositing is
4047 * available, enabling this option will instead fallback to using shaped
4048 * windows, with elm_win_shaped_set().
4050 * @param obj The window object
4051 * @param alpha If true, the window has an alpha channel
4053 * @see elm_win_alpha_set()
4055 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4057 * Get the transparency state of a window.
4059 * @param obj The window object
4060 * @return If true, the window is transparent
4062 * @see elm_win_transparent_set()
4064 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4066 * Set the transparency state of a window.
4068 * Use elm_win_alpha_set() instead.
4070 * @param obj The window object
4071 * @param transparent If true, the window is transparent
4073 * @see elm_win_alpha_set()
4075 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4077 * Get the alpha channel state of a window.
4079 * @param obj The window object
4080 * @return If true, the window has an alpha channel
4082 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 * Set the override state of a window.
4086 * A window with @p override set to EINA_TRUE will not be managed by the
4087 * Window Manager. This means that no decorations of any kind will be shown
4088 * for it, moving and resizing must be handled by the application, as well
4089 * as the window visibility.
4091 * This should not be used for normal windows, and even for not so normal
4092 * ones, it should only be used when there's a good reason and with a lot
4093 * of care. Mishandling override windows may result situations that
4094 * disrupt the normal workflow of the end user.
4096 * @param obj The window object
4097 * @param override If true, the window is overridden
4099 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4101 * Get the override state of a window.
4103 * @param obj The window object
4104 * @return If true, the window is overridden
4106 * @see elm_win_override_set()
4108 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Set the fullscreen state of a window.
4112 * @param obj The window object
4113 * @param fullscreen If true, the window is fullscreen
4115 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4117 * Get the fullscreen state of a window.
4119 * @param obj The window object
4120 * @return If true, the window is fullscreen
4122 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4124 * Set the maximized state of a window.
4126 * @param obj The window object
4127 * @param maximized If true, the window is maximized
4129 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4131 * Get the maximized state of a window.
4133 * @param obj The window object
4134 * @return If true, the window is maximized
4136 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 * Set the iconified state of a window.
4140 * @param obj The window object
4141 * @param iconified If true, the window is iconified
4143 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4145 * Get the iconified state of a window.
4147 * @param obj The window object
4148 * @return If true, the window is iconified
4150 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 * Set the layer of the window.
4154 * What this means exactly will depend on the underlying engine used.
4156 * In the case of X11 backed engines, the value in @p layer has the
4157 * following meanings:
4158 * @li < 3: The window will be placed below all others.
4159 * @li > 5: The window will be placed above all others.
4160 * @li other: The window will be placed in the default layer.
4162 * @param obj The window object
4163 * @param layer The layer of the window
4165 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4167 * Get the layer of the window.
4169 * @param obj The window object
4170 * @return The layer of the window
4172 * @see elm_win_layer_set()
4174 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4176 * Set the rotation of the window.
4178 * Most engines only work with multiples of 90.
4180 * This function is used to set the orientation of the window @p obj to
4181 * match that of the screen. The window itself will be resized to adjust
4182 * to the new geometry of its contents. If you want to keep the window size,
4183 * see elm_win_rotation_with_resize_set().
4185 * @param obj The window object
4186 * @param rotation The rotation of the window, in degrees (0-360),
4187 * counter-clockwise.
4189 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4191 * Rotates the window and resizes it.
4193 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4194 * that they fit inside the current window geometry.
4196 * @param obj The window object
4197 * @param layer The rotation of the window in degrees (0-360),
4198 * counter-clockwise.
4200 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4202 * Get the rotation of the window.
4204 * @param obj The window object
4205 * @return The rotation of the window in degrees (0-360)
4207 * @see elm_win_rotation_set()
4208 * @see elm_win_rotation_with_resize_set()
4210 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Set the sticky state of the window.
4214 * Hints the Window Manager that the window in @p obj should be left fixed
4215 * at its position even when the virtual desktop it's on moves or changes.
4217 * @param obj The window object
4218 * @param sticky If true, the window's sticky state is enabled
4220 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4222 * Get the sticky state of the window.
4224 * @param obj The window object
4225 * @return If true, the window's sticky state is enabled
4227 * @see elm_win_sticky_set()
4229 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set if this window is an illume conformant window
4233 * @param obj The window object
4234 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4236 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4238 * Get if this window is an illume conformant window
4240 * @param obj The window object
4241 * @return A boolean if this window is illume conformant or not
4243 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Set a window to be an illume quickpanel window
4247 * By default window objects are not quickpanel windows.
4249 * @param obj The window object
4250 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4252 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4254 * Get if this window is a quickpanel or not
4256 * @param obj The window object
4257 * @return A boolean if this window is a quickpanel or not
4259 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4261 * Set the major priority of a quickpanel window
4263 * @param obj The window object
4264 * @param priority The major priority for this quickpanel
4266 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4268 * Get the major priority of a quickpanel window
4270 * @param obj The window object
4271 * @return The major priority of this quickpanel
4273 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Set the minor priority of a quickpanel window
4277 * @param obj The window object
4278 * @param priority The minor priority for this quickpanel
4280 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4282 * Get the minor priority of a quickpanel window
4284 * @param obj The window object
4285 * @return The minor priority of this quickpanel
4287 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4289 * Set which zone this quickpanel should appear in
4291 * @param obj The window object
4292 * @param zone The requested zone for this quickpanel
4294 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4296 * Get which zone this quickpanel should appear in
4298 * @param obj The window object
4299 * @return The requested zone for this quickpanel
4301 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 * Set the window to be skipped by keyboard focus
4305 * This sets the window to be skipped by normal keyboard input. This means
4306 * a window manager will be asked to not focus this window as well as omit
4307 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4309 * Call this and enable it on a window BEFORE you show it for the first time,
4310 * otherwise it may have no effect.
4312 * Use this for windows that have only output information or might only be
4313 * interacted with by the mouse or fingers, and never for typing input.
4314 * Be careful that this may have side-effects like making the window
4315 * non-accessible in some cases unless the window is specially handled. Use
4318 * @param obj The window object
4319 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4321 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4323 * Send a command to the windowing environment
4325 * This is intended to work in touchscreen or small screen device
4326 * environments where there is a more simplistic window management policy in
4327 * place. This uses the window object indicated to select which part of the
4328 * environment to control (the part that this window lives in), and provides
4329 * a command and an optional parameter structure (use NULL for this if not
4332 * @param obj The window object that lives in the environment to control
4333 * @param command The command to send
4334 * @param params Optional parameters for the command
4336 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4338 * Get the inlined image object handle
4340 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4341 * then the window is in fact an evas image object inlined in the parent
4342 * canvas. You can get this object (be careful to not manipulate it as it
4343 * is under control of elementary), and use it to do things like get pixel
4344 * data, save the image to a file, etc.
4346 * @param obj The window object to get the inlined image from
4347 * @return The inlined image object, or NULL if none exists
4349 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4351 * Set the enabled status for the focus highlight in a window
4353 * This function will enable or disable the focus highlight only for the
4354 * given window, regardless of the global setting for it
4356 * @param obj The window where to enable the highlight
4357 * @param enabled The enabled value for the highlight
4359 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4361 * Get the enabled value of the focus highlight for this window
4363 * @param obj The window in which to check if the focus highlight is enabled
4365 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4367 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369 * Set the style for the focus highlight on this window
4371 * Sets the style to use for theming the highlight of focused objects on
4372 * the given window. If @p style is NULL, the default will be used.
4374 * @param obj The window where to set the style
4375 * @param style The style to set
4377 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4379 * Get the style set for the focus highlight object
4381 * Gets the style set for this windows highilght object, or NULL if none
4384 * @param obj The window to retrieve the highlights style from
4386 * @return The style set or NULL if none was. Default is used in that case.
4388 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4391 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4392 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4393 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4394 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4395 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4396 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4398 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4399 * (blank mouse, private mouse obj, defaultmouse)
4403 * Sets the keyboard mode of the window.
4405 * @param obj The window object
4406 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4408 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4410 * Gets the keyboard mode of the window.
4412 * @param obj The window object
4413 * @return The mode, one of #Elm_Win_Keyboard_Mode
4415 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4417 * Sets whether the window is a keyboard.
4419 * @param obj The window object
4420 * @param is_keyboard If true, the window is a virtual keyboard
4422 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4424 * Gets whether the window is a keyboard.
4426 * @param obj The window object
4427 * @return If the window is a virtual keyboard
4429 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4432 * Get the screen position of a window.
4434 * @param obj The window object
4435 * @param x The int to store the x coordinate to
4436 * @param y The int to store the y coordinate to
4438 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4444 * @defgroup Inwin Inwin
4446 * @image html img/widget/inwin/preview-00.png
4447 * @image latex img/widget/inwin/preview-00.eps
4448 * @image html img/widget/inwin/preview-01.png
4449 * @image latex img/widget/inwin/preview-01.eps
4450 * @image html img/widget/inwin/preview-02.png
4451 * @image latex img/widget/inwin/preview-02.eps
4453 * An inwin is a window inside a window that is useful for a quick popup.
4454 * It does not hover.
4456 * It works by creating an object that will occupy the entire window, so it
4457 * must be created using an @ref Win "elm_win" as parent only. The inwin
4458 * object can be hidden or restacked below every other object if it's
4459 * needed to show what's behind it without destroying it. If this is done,
4460 * the elm_win_inwin_activate() function can be used to bring it back to
4461 * full visibility again.
4463 * There are three styles available in the default theme. These are:
4464 * @li default: The inwin is sized to take over most of the window it's
4466 * @li minimal: The size of the inwin will be the minimum necessary to show
4468 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4469 * possible, but it's sized vertically the most it needs to fit its\
4472 * Some examples of Inwin can be found in the following:
4473 * @li @ref inwin_example_01
4478 * Adds an inwin to the current window
4480 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4481 * Never call this function with anything other than the top-most window
4482 * as its parameter, unless you are fond of undefined behavior.
4484 * After creating the object, the widget will set itself as resize object
4485 * for the window with elm_win_resize_object_add(), so when shown it will
4486 * appear to cover almost the entire window (how much of it depends on its
4487 * content and the style used). It must not be added into other container
4488 * objects and it needs not be moved or resized manually.
4490 * @param parent The parent object
4491 * @return The new object or NULL if it cannot be created
4493 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4495 * Activates an inwin object, ensuring its visibility
4497 * This function will make sure that the inwin @p obj is completely visible
4498 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4499 * to the front. It also sets the keyboard focus to it, which will be passed
4502 * The object's theme will also receive the signal "elm,action,show" with
4505 * @param obj The inwin to activate
4507 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4509 * Set the content of an inwin object.
4511 * Once the content object is set, a previously set one will be deleted.
4512 * If you want to keep that old content object, use the
4513 * elm_win_inwin_content_unset() function.
4515 * @param obj The inwin object
4516 * @param content The object to set as content
4518 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4520 * Get the content of an inwin object.
4522 * Return the content object which is set for this widget.
4524 * The returned object is valid as long as the inwin is still alive and no
4525 * other content is set on it. Deleting the object will notify the inwin
4526 * about it and this one will be left empty.
4528 * If you need to remove an inwin's content to be reused somewhere else,
4529 * see elm_win_inwin_content_unset().
4531 * @param obj The inwin object
4532 * @return The content that is being used
4534 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4536 * Unset the content of an inwin object.
4538 * Unparent and return the content object which was set for this widget.
4540 * @param obj The inwin object
4541 * @return The content that was being used
4543 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4547 /* X specific calls - won't work on non-x engines (return 0) */
4550 * Get the Ecore_X_Window of an Evas_Object
4552 * @param obj The object
4554 * @return The Ecore_X_Window of @p obj
4558 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4560 /* smart callbacks called:
4561 * "delete,request" - the user requested to delete the window
4562 * "focus,in" - window got focus
4563 * "focus,out" - window lost focus
4564 * "moved" - window that holds the canvas was moved
4570 * @image html img/widget/bg/preview-00.png
4571 * @image latex img/widget/bg/preview-00.eps
4573 * @brief Background object, used for setting a solid color, image or Edje
4574 * group as background to a window or any container object.
4576 * The bg object is used for setting a solid background to a window or
4577 * packing into any container object. It works just like an image, but has
4578 * some properties useful to a background, like setting it to tiled,
4579 * centered, scaled or stretched.
4581 * Default contents parts of the bg widget that you can use for are:
4582 * @li "overlay" - overlay of the bg
4584 * Here is some sample code using it:
4585 * @li @ref bg_01_example_page
4586 * @li @ref bg_02_example_page
4587 * @li @ref bg_03_example_page
4591 typedef enum _Elm_Bg_Option
4593 ELM_BG_OPTION_CENTER, /**< center the background */
4594 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4595 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4596 ELM_BG_OPTION_TILE /**< tile background at its original size */
4600 * Add a new background to the parent
4602 * @param parent The parent object
4603 * @return The new object or NULL if it cannot be created
4607 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4610 * Set the file (image or edje) used for the background
4612 * @param obj The bg object
4613 * @param file The file path
4614 * @param group Optional key (group in Edje) within the file
4616 * This sets the image file used in the background object. The image (or edje)
4617 * will be stretched (retaining aspect if its an image file) to completely fill
4618 * the bg object. This may mean some parts are not visible.
4620 * @note Once the image of @p obj is set, a previously set one will be deleted,
4621 * even if @p file is NULL.
4625 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4628 * Get the file (image or edje) used for the background
4630 * @param obj The bg object
4631 * @param file The file path
4632 * @param group Optional key (group in Edje) within the file
4636 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4639 * Set the option used for the background image
4641 * @param obj The bg object
4642 * @param option The desired background option (TILE, SCALE)
4644 * This sets the option used for manipulating the display of the background
4645 * image. The image can be tiled or scaled.
4649 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4652 * Get the option used for the background image
4654 * @param obj The bg object
4655 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4659 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4661 * Set the option used for the background color
4663 * @param obj The bg object
4668 * This sets the color used for the background rectangle. Its range goes
4673 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4675 * Get the option used for the background color
4677 * @param obj The bg object
4684 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4687 * Set the overlay object used for the background object.
4689 * @param obj The bg object
4690 * @param overlay The overlay object
4692 * This provides a way for elm_bg to have an 'overlay' that will be on top
4693 * of the bg. Once the over object is set, a previously set one will be
4694 * deleted, even if you set the new one to NULL. If you want to keep that
4695 * old content object, use the elm_bg_overlay_unset() function.
4697 * @deprecated use elm_object_content_part_set() instead
4702 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4705 * Get the overlay object used for the background object.
4707 * @param obj The bg object
4708 * @return The content that is being used
4710 * Return the content object which is set for this widget
4712 * @deprecated use elm_object_content_part_get() instead
4716 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4719 * Get the overlay object used for the background object.
4721 * @param obj The bg object
4722 * @return The content that was being used
4724 * Unparent and return the overlay object which was set for this widget
4726 * @deprecated use elm_object_content_part_unset() instead
4730 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4733 * Set the size of the pixmap representation of the image.
4735 * This option just makes sense if an image is going to be set in the bg.
4737 * @param obj The bg object
4738 * @param w The new width of the image pixmap representation.
4739 * @param h The new height of the image pixmap representation.
4741 * This function sets a new size for pixmap representation of the given bg
4742 * image. It allows the image to be loaded already in the specified size,
4743 * reducing the memory usage and load time when loading a big image with load
4744 * size set to a smaller size.
4746 * NOTE: this is just a hint, the real size of the pixmap may differ
4747 * depending on the type of image being loaded, being bigger than requested.
4751 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4752 /* smart callbacks called:
4756 * @defgroup Icon Icon
4758 * @image html img/widget/icon/preview-00.png
4759 * @image latex img/widget/icon/preview-00.eps
4761 * An object that provides standard icon images (delete, edit, arrows, etc.)
4762 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4764 * The icon image requested can be in the elementary theme, or in the
4765 * freedesktop.org paths. It's possible to set the order of preference from
4766 * where the image will be used.
4768 * This API is very similar to @ref Image, but with ready to use images.
4770 * Default images provided by the theme are described below.
4772 * The first list contains icons that were first intended to be used in
4773 * toolbars, but can be used in many other places too:
4789 * Now some icons that were designed to be used in menus (but again, you can
4790 * use them anywhere else):
4795 * @li menu/arrow_down
4796 * @li menu/arrow_left
4797 * @li menu/arrow_right
4806 * And here we have some media player specific icons:
4807 * @li media_player/forward
4808 * @li media_player/info
4809 * @li media_player/next
4810 * @li media_player/pause
4811 * @li media_player/play
4812 * @li media_player/prev
4813 * @li media_player/rewind
4814 * @li media_player/stop
4816 * Signals that you can add callbacks for are:
4818 * "clicked" - This is called when a user has clicked the icon
4820 * An example of usage for this API follows:
4821 * @li @ref tutorial_icon
4829 typedef enum _Elm_Icon_Type
4836 * @enum _Elm_Icon_Lookup_Order
4837 * @typedef Elm_Icon_Lookup_Order
4839 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4840 * theme, FDO paths, or both?
4844 typedef enum _Elm_Icon_Lookup_Order
4846 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4847 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4848 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4849 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4850 } Elm_Icon_Lookup_Order;
4853 * Add a new icon object to the parent.
4855 * @param parent The parent object
4856 * @return The new object or NULL if it cannot be created
4858 * @see elm_icon_file_set()
4862 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4864 * Set the file that will be used as icon.
4866 * @param obj The icon object
4867 * @param file The path to file that will be used as icon image
4868 * @param group The group that the icon belongs to an edje file
4870 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4872 * @note The icon image set by this function can be changed by
4873 * elm_icon_standard_set().
4875 * @see elm_icon_file_get()
4879 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4881 * Set a location in memory to be used as an icon
4883 * @param obj The icon object
4884 * @param img The binary data that will be used as an image
4885 * @param size The size of binary data @p img
4886 * @param format Optional format of @p img to pass to the image loader
4887 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4889 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4891 * @note The icon image set by this function can be changed by
4892 * elm_icon_standard_set().
4896 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);
4898 * Get the file that will be used as icon.
4900 * @param obj The icon object
4901 * @param file The path to file that will be used as the icon image
4902 * @param group The group that the icon belongs to, in edje file
4904 * @see elm_icon_file_set()
4908 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4909 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4911 * Set the icon by icon standards names.
4913 * @param obj The icon object
4914 * @param name The icon name
4916 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4918 * For example, freedesktop.org defines standard icon names such as "home",
4919 * "network", etc. There can be different icon sets to match those icon
4920 * keys. The @p name given as parameter is one of these "keys", and will be
4921 * used to look in the freedesktop.org paths and elementary theme. One can
4922 * change the lookup order with elm_icon_order_lookup_set().
4924 * If name is not found in any of the expected locations and it is the
4925 * absolute path of an image file, this image will be used.
4927 * @note The icon image set by this function can be changed by
4928 * elm_icon_file_set().
4930 * @see elm_icon_standard_get()
4931 * @see elm_icon_file_set()
4935 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4937 * Get the icon name set by icon standard names.
4939 * @param obj The icon object
4940 * @return The icon name
4942 * If the icon image was set using elm_icon_file_set() instead of
4943 * elm_icon_standard_set(), then this function will return @c NULL.
4945 * @see elm_icon_standard_set()
4949 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4951 * Set the smooth scaling for an icon object.
4953 * @param obj The icon object
4954 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4955 * otherwise. Default is @c EINA_TRUE.
4957 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4958 * scaling provides a better resulting image, but is slower.
4960 * The smooth scaling should be disabled when making animations that change
4961 * the icon size, since they will be faster. Animations that don't require
4962 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4963 * is already scaled, since the scaled icon image will be cached).
4965 * @see elm_icon_smooth_get()
4969 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4971 * Get whether smooth scaling is enabled for an icon object.
4973 * @param obj The icon object
4974 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4976 * @see elm_icon_smooth_set()
4980 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4982 * Disable scaling of this object.
4984 * @param obj The icon object.
4985 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4986 * otherwise. Default is @c EINA_FALSE.
4988 * This function disables scaling of the icon object through the function
4989 * elm_object_scale_set(). However, this does not affect the object
4990 * size/resize in any way. For that effect, take a look at
4991 * elm_icon_scale_set().
4993 * @see elm_icon_no_scale_get()
4994 * @see elm_icon_scale_set()
4995 * @see elm_object_scale_set()
4999 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5001 * Get whether scaling is disabled on the object.
5003 * @param obj The icon object
5004 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5006 * @see elm_icon_no_scale_set()
5010 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5012 * Set if the object is (up/down) resizable.
5014 * @param obj The icon object
5015 * @param scale_up A bool to set if the object is resizable up. Default is
5017 * @param scale_down A bool to set if the object is resizable down. Default
5020 * This function limits the icon object resize ability. If @p scale_up is set to
5021 * @c EINA_FALSE, the object can't have its height or width resized to a value
5022 * higher than the original icon size. Same is valid for @p scale_down.
5024 * @see elm_icon_scale_get()
5028 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5030 * Get if the object is (up/down) resizable.
5032 * @param obj The icon object
5033 * @param scale_up A bool to set if the object is resizable up
5034 * @param scale_down A bool to set if the object is resizable down
5036 * @see elm_icon_scale_set()
5040 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5042 * Get the object's image size
5044 * @param obj The icon object
5045 * @param w A pointer to store the width in
5046 * @param h A pointer to store the height in
5050 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5052 * Set if the icon fill the entire object area.
5054 * @param obj The icon object
5055 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5056 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5058 * When the icon object is resized to a different aspect ratio from the
5059 * original icon image, the icon image will still keep its aspect. This flag
5060 * tells how the image should fill the object's area. They are: keep the
5061 * entire icon inside the limits of height and width of the object (@p
5062 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5063 * of the object, and the icon will fill the entire object (@p fill_outside
5066 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5067 * retain property to false. Thus, the icon image will always keep its
5068 * original aspect ratio.
5070 * @see elm_icon_fill_outside_get()
5071 * @see elm_image_fill_outside_set()
5075 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5077 * Get if the object is filled outside.
5079 * @param obj The icon object
5080 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5082 * @see elm_icon_fill_outside_set()
5086 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 * Set the prescale size for the icon.
5090 * @param obj The icon object
5091 * @param size The prescale size. This value is used for both width and
5094 * This function sets a new size for pixmap representation of the given
5095 * icon. It allows the icon to be loaded already in the specified size,
5096 * reducing the memory usage and load time when loading a big icon with load
5097 * size set to a smaller size.
5099 * It's equivalent to the elm_bg_load_size_set() function for bg.
5101 * @note this is just a hint, the real size of the pixmap may differ
5102 * depending on the type of icon being loaded, being bigger than requested.
5104 * @see elm_icon_prescale_get()
5105 * @see elm_bg_load_size_set()
5109 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5111 * Get the prescale size for the icon.
5113 * @param obj The icon object
5114 * @return The prescale size
5116 * @see elm_icon_prescale_set()
5120 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5122 * Gets the image object of the icon. DO NOT MODIFY THIS.
5124 * @param obj The icon object
5125 * @return The internal icon object
5129 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5131 * Sets the icon lookup order used by elm_icon_standard_set().
5133 * @param obj The icon object
5134 * @param order The icon lookup order (can be one of
5135 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5136 * or ELM_ICON_LOOKUP_THEME)
5138 * @see elm_icon_order_lookup_get()
5139 * @see Elm_Icon_Lookup_Order
5143 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5145 * Gets the icon lookup order.
5147 * @param obj The icon object
5148 * @return The icon lookup order
5150 * @see elm_icon_order_lookup_set()
5151 * @see Elm_Icon_Lookup_Order
5155 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5157 * Enable or disable preloading of the icon
5159 * @param obj The icon object
5160 * @param disable If EINA_TRUE, preloading will be disabled
5163 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5165 * Get if the icon supports animation or not.
5167 * @param obj The icon object
5168 * @return @c EINA_TRUE if the icon supports animation,
5169 * @c EINA_FALSE otherwise.
5171 * Return if this elm icon's image can be animated. Currently Evas only
5172 * supports gif animation. If the return value is EINA_FALSE, other
5173 * elm_icon_animated_XXX APIs won't work.
5176 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5178 * Set animation mode of the icon.
5180 * @param obj The icon object
5181 * @param anim @c EINA_TRUE if the object do animation job,
5182 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5184 * Since the default animation mode is set to EINA_FALSE,
5185 * the icon is shown without animation.
5186 * This might be desirable when the application developer wants to show
5187 * a snapshot of the animated icon.
5188 * Set it to EINA_TRUE when the icon needs to be animated.
5191 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5193 * Get animation mode of the icon.
5195 * @param obj The icon object
5196 * @return The animation mode of the icon object
5197 * @see elm_icon_animated_set
5200 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5202 * Set animation play mode of the icon.
5204 * @param obj The icon object
5205 * @param play @c EINA_TRUE the object play animation images,
5206 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5208 * To play elm icon's animation, set play to EINA_TURE.
5209 * For example, you make gif player using this set/get API and click event.
5211 * 1. Click event occurs
5212 * 2. Check play flag using elm_icon_animaged_play_get
5213 * 3. If elm icon was playing, set play to EINA_FALSE.
5214 * Then animation will be stopped and vice versa
5217 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5219 * Get animation play mode of the icon.
5221 * @param obj The icon object
5222 * @return The play mode of the icon object
5224 * @see elm_icon_animated_play_get
5227 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5234 * @defgroup Image Image
5236 * @image html img/widget/image/preview-00.png
5237 * @image latex img/widget/image/preview-00.eps
5240 * An object that allows one to load an image file to it. It can be used
5241 * anywhere like any other elementary widget.
5243 * This widget provides most of the functionality provided from @ref Bg or @ref
5244 * Icon, but with a slightly different API (use the one that fits better your
5247 * The features not provided by those two other image widgets are:
5248 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5249 * @li change the object orientation with elm_image_orient_set();
5250 * @li and turning the image editable with elm_image_editable_set().
5252 * Signals that you can add callbacks for are:
5254 * @li @c "clicked" - This is called when a user has clicked the image
5256 * An example of usage for this API follows:
5257 * @li @ref tutorial_image
5266 * @enum _Elm_Image_Orient
5267 * @typedef Elm_Image_Orient
5269 * Possible orientation options for elm_image_orient_set().
5271 * @image html elm_image_orient_set.png
5272 * @image latex elm_image_orient_set.eps width=\textwidth
5276 typedef enum _Elm_Image_Orient
5278 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5279 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5280 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5281 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5282 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5283 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5284 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5285 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5289 * Add a new image to the parent.
5291 * @param parent The parent object
5292 * @return The new object or NULL if it cannot be created
5294 * @see elm_image_file_set()
5298 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5300 * Set the file that will be used as image.
5302 * @param obj The image object
5303 * @param file The path to file that will be used as image
5304 * @param group The group that the image belongs in edje file (if it's an
5307 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5309 * @see elm_image_file_get()
5313 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5315 * Get the file that will be used as image.
5317 * @param obj The image object
5318 * @param file The path to file
5319 * @param group The group that the image belongs in edje file
5321 * @see elm_image_file_set()
5325 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5327 * Set the smooth effect for an image.
5329 * @param obj The image object
5330 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5331 * otherwise. Default is @c EINA_TRUE.
5333 * Set the scaling algorithm to be used when scaling the image. Smooth
5334 * scaling provides a better resulting image, but is slower.
5336 * The smooth scaling should be disabled when making animations that change
5337 * the image size, since it will be faster. Animations that don't require
5338 * resizing of the image can keep the smooth scaling enabled (even if the
5339 * image is already scaled, since the scaled image will be cached).
5341 * @see elm_image_smooth_get()
5345 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5347 * Get the smooth effect for an image.
5349 * @param obj The image object
5350 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5352 * @see elm_image_smooth_get()
5356 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5359 * Gets the current size of the image.
5361 * @param obj The image object.
5362 * @param w Pointer to store width, or NULL.
5363 * @param h Pointer to store height, or NULL.
5365 * This is the real size of the image, not the size of the object.
5367 * On error, neither w or h will be written.
5371 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5373 * Disable scaling of this object.
5375 * @param obj The image object.
5376 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5377 * otherwise. Default is @c EINA_FALSE.
5379 * This function disables scaling of the elm_image widget through the
5380 * function elm_object_scale_set(). However, this does not affect the widget
5381 * size/resize in any way. For that effect, take a look at
5382 * elm_image_scale_set().
5384 * @see elm_image_no_scale_get()
5385 * @see elm_image_scale_set()
5386 * @see elm_object_scale_set()
5390 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5392 * Get whether scaling is disabled on the object.
5394 * @param obj The image object
5395 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5397 * @see elm_image_no_scale_set()
5401 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5403 * Set if the object is (up/down) resizable.
5405 * @param obj The image object
5406 * @param scale_up A bool to set if the object is resizable up. Default is
5408 * @param scale_down A bool to set if the object is resizable down. Default
5411 * This function limits the image resize ability. If @p scale_up is set to
5412 * @c EINA_FALSE, the object can't have its height or width resized to a value
5413 * higher than the original image size. Same is valid for @p scale_down.
5415 * @see elm_image_scale_get()
5419 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5421 * Get if the object is (up/down) resizable.
5423 * @param obj The image object
5424 * @param scale_up A bool to set if the object is resizable up
5425 * @param scale_down A bool to set if the object is resizable down
5427 * @see elm_image_scale_set()
5431 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5433 * Set if the image fills the entire object area, when keeping the aspect ratio.
5435 * @param obj The image object
5436 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5437 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5439 * When the image should keep its aspect ratio even if resized to another
5440 * aspect ratio, there are two possibilities to resize it: keep the entire
5441 * image inside the limits of height and width of the object (@p fill_outside
5442 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5443 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5445 * @note This option will have no effect if
5446 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5448 * @see elm_image_fill_outside_get()
5449 * @see elm_image_aspect_ratio_retained_set()
5453 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5455 * Get if the object is filled outside
5457 * @param obj The image object
5458 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5460 * @see elm_image_fill_outside_set()
5464 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5466 * Set the prescale size for the image
5468 * @param obj The image object
5469 * @param size The prescale size. This value is used for both width and
5472 * This function sets a new size for pixmap representation of the given
5473 * image. It allows the image to be loaded already in the specified size,
5474 * reducing the memory usage and load time when loading a big image with load
5475 * size set to a smaller size.
5477 * It's equivalent to the elm_bg_load_size_set() function for bg.
5479 * @note this is just a hint, the real size of the pixmap may differ
5480 * depending on the type of image being loaded, being bigger than requested.
5482 * @see elm_image_prescale_get()
5483 * @see elm_bg_load_size_set()
5487 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5489 * Get the prescale size for the image
5491 * @param obj The image object
5492 * @return The prescale size
5494 * @see elm_image_prescale_set()
5498 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5500 * Set the image orientation.
5502 * @param obj The image object
5503 * @param orient The image orientation @ref Elm_Image_Orient
5504 * Default is #ELM_IMAGE_ORIENT_NONE.
5506 * This function allows to rotate or flip the given image.
5508 * @see elm_image_orient_get()
5509 * @see @ref Elm_Image_Orient
5513 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5515 * Get the image orientation.
5517 * @param obj The image object
5518 * @return The image orientation @ref Elm_Image_Orient
5520 * @see elm_image_orient_set()
5521 * @see @ref Elm_Image_Orient
5525 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 * Make the image 'editable'.
5529 * @param obj Image object.
5530 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5532 * This means the image is a valid drag target for drag and drop, and can be
5533 * cut or pasted too.
5537 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5539 * Check if the image 'editable'.
5541 * @param obj Image object.
5542 * @return Editability.
5544 * A return value of EINA_TRUE means the image is a valid drag target
5545 * for drag and drop, and can be cut or pasted too.
5549 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5551 * Get the basic Evas_Image object from this object (widget).
5553 * @param obj The image object to get the inlined image from
5554 * @return The inlined image object, or NULL if none exists
5556 * This function allows one to get the underlying @c Evas_Object of type
5557 * Image from this elementary widget. It can be useful to do things like get
5558 * the pixel data, save the image to a file, etc.
5560 * @note Be careful to not manipulate it, as it is under control of
5565 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5567 * Set whether the original aspect ratio of the image should be kept on resize.
5569 * @param obj The image object.
5570 * @param retained @c EINA_TRUE if the image should retain the aspect,
5571 * @c EINA_FALSE otherwise.
5573 * The original aspect ratio (width / height) of the image is usually
5574 * distorted to match the object's size. Enabling this option will retain
5575 * this original aspect, and the way that the image is fit into the object's
5576 * area depends on the option set by elm_image_fill_outside_set().
5578 * @see elm_image_aspect_ratio_retained_get()
5579 * @see elm_image_fill_outside_set()
5583 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5585 * Get if the object retains the original aspect ratio.
5587 * @param obj The image object.
5588 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5593 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5603 * @image html img/widget/box/preview-00.png
5604 * @image latex img/widget/box/preview-00.eps width=\textwidth
5606 * @image html img/box.png
5607 * @image latex img/box.eps width=\textwidth
5609 * A box arranges objects in a linear fashion, governed by a layout function
5610 * that defines the details of this arrangement.
5612 * By default, the box will use an internal function to set the layout to
5613 * a single row, either vertical or horizontal. This layout is affected
5614 * by a number of parameters, such as the homogeneous flag set by
5615 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5616 * elm_box_align_set() and the hints set to each object in the box.
5618 * For this default layout, it's possible to change the orientation with
5619 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5620 * placing its elements ordered from top to bottom. When horizontal is set,
5621 * the order will go from left to right. If the box is set to be
5622 * homogeneous, every object in it will be assigned the same space, that
5623 * of the largest object. Padding can be used to set some spacing between
5624 * the cell given to each object. The alignment of the box, set with
5625 * elm_box_align_set(), determines how the bounding box of all the elements
5626 * will be placed within the space given to the box widget itself.
5628 * The size hints of each object also affect how they are placed and sized
5629 * within the box. evas_object_size_hint_min_set() will give the minimum
5630 * size the object can have, and the box will use it as the basis for all
5631 * latter calculations. Elementary widgets set their own minimum size as
5632 * needed, so there's rarely any need to use it manually.
5634 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5635 * used to tell whether the object will be allocated the minimum size it
5636 * needs or if the space given to it should be expanded. It's important
5637 * to realize that expanding the size given to the object is not the same
5638 * thing as resizing the object. It could very well end being a small
5639 * widget floating in a much larger empty space. If not set, the weight
5640 * for objects will normally be 0.0 for both axis, meaning the widget will
5641 * not be expanded. To take as much space possible, set the weight to
5642 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5644 * Besides how much space each object is allocated, it's possible to control
5645 * how the widget will be placed within that space using
5646 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5647 * for both axis, meaning the object will be centered, but any value from
5648 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5649 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5650 * is -1.0, means the object will be resized to fill the entire space it
5653 * In addition, customized functions to define the layout can be set, which
5654 * allow the application developer to organize the objects within the box
5655 * in any number of ways.
5657 * The special elm_box_layout_transition() function can be used
5658 * to switch from one layout to another, animating the motion of the
5659 * children of the box.
5661 * @note Objects should not be added to box objects using _add() calls.
5663 * Some examples on how to use boxes follow:
5664 * @li @ref box_example_01
5665 * @li @ref box_example_02
5670 * @typedef Elm_Box_Transition
5672 * Opaque handler containing the parameters to perform an animated
5673 * transition of the layout the box uses.
5675 * @see elm_box_transition_new()
5676 * @see elm_box_layout_set()
5677 * @see elm_box_layout_transition()
5679 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5682 * Add a new box to the parent
5684 * By default, the box will be in vertical mode and non-homogeneous.
5686 * @param parent The parent object
5687 * @return The new object or NULL if it cannot be created
5689 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5691 * Set the horizontal orientation
5693 * By default, box object arranges their contents vertically from top to
5695 * By calling this function with @p horizontal as EINA_TRUE, the box will
5696 * become horizontal, arranging contents from left to right.
5698 * @note This flag is ignored if a custom layout function is set.
5700 * @param obj The box object
5701 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5702 * EINA_FALSE = vertical)
5704 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5706 * Get the horizontal orientation
5708 * @param obj The box object
5709 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5711 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5713 * Set the box to arrange its children homogeneously
5715 * If enabled, homogeneous layout makes all items the same size, according
5716 * to the size of the largest of its children.
5718 * @note This flag is ignored if a custom layout function is set.
5720 * @param obj The box object
5721 * @param homogeneous The homogeneous flag
5723 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5725 * Get whether the box is using homogeneous mode or not
5727 * @param obj The box object
5728 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5730 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5731 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5732 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5734 * Add an object to the beginning of the pack list
5736 * Pack @p subobj into the box @p obj, placing it first in the list of
5737 * children objects. The actual position the object will get on screen
5738 * depends on the layout used. If no custom layout is set, it will be at
5739 * the top or left, depending if the box is vertical or horizontal,
5742 * @param obj The box object
5743 * @param subobj The object to add to the box
5745 * @see elm_box_pack_end()
5746 * @see elm_box_pack_before()
5747 * @see elm_box_pack_after()
5748 * @see elm_box_unpack()
5749 * @see elm_box_unpack_all()
5750 * @see elm_box_clear()
5752 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5754 * Add an object at the end of the pack list
5756 * Pack @p subobj into the box @p obj, placing it last in the list of
5757 * children objects. The actual position the object will get on screen
5758 * depends on the layout used. If no custom layout is set, it will be at
5759 * the bottom or right, depending if the box is vertical or horizontal,
5762 * @param obj The box object
5763 * @param subobj The object to add to the box
5765 * @see elm_box_pack_start()
5766 * @see elm_box_pack_before()
5767 * @see elm_box_pack_after()
5768 * @see elm_box_unpack()
5769 * @see elm_box_unpack_all()
5770 * @see elm_box_clear()
5772 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5774 * Adds an object to the box before the indicated object
5776 * This will add the @p subobj to the box indicated before the object
5777 * indicated with @p before. If @p before is not already in the box, results
5778 * are undefined. Before means either to the left of the indicated object or
5779 * above it depending on orientation.
5781 * @param obj The box object
5782 * @param subobj The object to add to the box
5783 * @param before The object before which to add it
5785 * @see elm_box_pack_start()
5786 * @see elm_box_pack_end()
5787 * @see elm_box_pack_after()
5788 * @see elm_box_unpack()
5789 * @see elm_box_unpack_all()
5790 * @see elm_box_clear()
5792 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5794 * Adds an object to the box after the indicated object
5796 * This will add the @p subobj to the box indicated after the object
5797 * indicated with @p after. If @p after is not already in the box, results
5798 * are undefined. After means either to the right of the indicated object or
5799 * below it depending on orientation.
5801 * @param obj The box object
5802 * @param subobj The object to add to the box
5803 * @param after The object after which to add it
5805 * @see elm_box_pack_start()
5806 * @see elm_box_pack_end()
5807 * @see elm_box_pack_before()
5808 * @see elm_box_unpack()
5809 * @see elm_box_unpack_all()
5810 * @see elm_box_clear()
5812 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5814 * Clear the box of all children
5816 * Remove all the elements contained by the box, deleting the respective
5819 * @param obj The box object
5821 * @see elm_box_unpack()
5822 * @see elm_box_unpack_all()
5824 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5828 * Remove the object given by @p subobj from the box @p obj without
5831 * @param obj The box object
5833 * @see elm_box_unpack_all()
5834 * @see elm_box_clear()
5836 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5838 * Remove all items from the box, without deleting them
5840 * Clear the box from all children, but don't delete the respective objects.
5841 * If no other references of the box children exist, the objects will never
5842 * be deleted, and thus the application will leak the memory. Make sure
5843 * when using this function that you hold a reference to all the objects
5844 * in the box @p obj.
5846 * @param obj The box object
5848 * @see elm_box_clear()
5849 * @see elm_box_unpack()
5851 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5853 * Retrieve a list of the objects packed into the box
5855 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5856 * The order of the list corresponds to the packing order the box uses.
5858 * You must free this list with eina_list_free() once you are done with it.
5860 * @param obj The box object
5862 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5864 * Set the space (padding) between the box's elements.
5866 * Extra space in pixels that will be added between a box child and its
5867 * neighbors after its containing cell has been calculated. This padding
5868 * is set for all elements in the box, besides any possible padding that
5869 * individual elements may have through their size hints.
5871 * @param obj The box object
5872 * @param horizontal The horizontal space between elements
5873 * @param vertical The vertical space between elements
5875 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5877 * Get the space (padding) between the box's elements.
5879 * @param obj The box object
5880 * @param horizontal The horizontal space between elements
5881 * @param vertical The vertical space between elements
5883 * @see elm_box_padding_set()
5885 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5887 * Set the alignment of the whole bouding box of contents.
5889 * Sets how the bounding box containing all the elements of the box, after
5890 * their sizes and position has been calculated, will be aligned within
5891 * the space given for the whole box widget.
5893 * @param obj The box object
5894 * @param horizontal The horizontal alignment of elements
5895 * @param vertical The vertical alignment of elements
5897 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5899 * Get the alignment of the whole bouding box of contents.
5901 * @param obj The box object
5902 * @param horizontal The horizontal alignment of elements
5903 * @param vertical The vertical alignment of elements
5905 * @see elm_box_align_set()
5907 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5910 * Force the box to recalculate its children packing.
5912 * If any children was added or removed, box will not calculate the
5913 * values immediately rather leaving it to the next main loop
5914 * iteration. While this is great as it would save lots of
5915 * recalculation, whenever you need to get the position of a just
5916 * added item you must force recalculate before doing so.
5918 * @param obj The box object.
5920 EAPI void elm_box_recalculate(Evas_Object *obj);
5923 * Set the layout defining function to be used by the box
5925 * Whenever anything changes that requires the box in @p obj to recalculate
5926 * the size and position of its elements, the function @p cb will be called
5927 * to determine what the layout of the children will be.
5929 * Once a custom function is set, everything about the children layout
5930 * is defined by it. The flags set by elm_box_horizontal_set() and
5931 * elm_box_homogeneous_set() no longer have any meaning, and the values
5932 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5933 * layout function to decide if they are used and how. These last two
5934 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5935 * passed to @p cb. The @c Evas_Object the function receives is not the
5936 * Elementary widget, but the internal Evas Box it uses, so none of the
5937 * functions described here can be used on it.
5939 * Any of the layout functions in @c Evas can be used here, as well as the
5940 * special elm_box_layout_transition().
5942 * The final @p data argument received by @p cb is the same @p data passed
5943 * here, and the @p free_data function will be called to free it
5944 * whenever the box is destroyed or another layout function is set.
5946 * Setting @p cb to NULL will revert back to the default layout function.
5948 * @param obj The box object
5949 * @param cb The callback function used for layout
5950 * @param data Data that will be passed to layout function
5951 * @param free_data Function called to free @p data
5953 * @see elm_box_layout_transition()
5955 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);
5957 * Special layout function that animates the transition from one layout to another
5959 * Normally, when switching the layout function for a box, this will be
5960 * reflected immediately on screen on the next render, but it's also
5961 * possible to do this through an animated transition.
5963 * This is done by creating an ::Elm_Box_Transition and setting the box
5964 * layout to this function.
5968 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5969 * evas_object_box_layout_vertical, // start
5970 * NULL, // data for initial layout
5971 * NULL, // free function for initial data
5972 * evas_object_box_layout_horizontal, // end
5973 * NULL, // data for final layout
5974 * NULL, // free function for final data
5975 * anim_end, // will be called when animation ends
5976 * NULL); // data for anim_end function\
5977 * elm_box_layout_set(box, elm_box_layout_transition, t,
5978 * elm_box_transition_free);
5981 * @note This function can only be used with elm_box_layout_set(). Calling
5982 * it directly will not have the expected results.
5984 * @see elm_box_transition_new
5985 * @see elm_box_transition_free
5986 * @see elm_box_layout_set
5988 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5990 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5992 * If you want to animate the change from one layout to another, you need
5993 * to set the layout function of the box to elm_box_layout_transition(),
5994 * passing as user data to it an instance of ::Elm_Box_Transition with the
5995 * necessary information to perform this animation. The free function to
5996 * set for the layout is elm_box_transition_free().
5998 * The parameters to create an ::Elm_Box_Transition sum up to how long
5999 * will it be, in seconds, a layout function to describe the initial point,
6000 * another for the final position of the children and one function to be
6001 * called when the whole animation ends. This last function is useful to
6002 * set the definitive layout for the box, usually the same as the end
6003 * layout for the animation, but could be used to start another transition.
6005 * @param start_layout The layout function that will be used to start the animation
6006 * @param start_layout_data The data to be passed the @p start_layout function
6007 * @param start_layout_free_data Function to free @p start_layout_data
6008 * @param end_layout The layout function that will be used to end the animation
6009 * @param end_layout_free_data The data to be passed the @p end_layout function
6010 * @param end_layout_free_data Function to free @p end_layout_data
6011 * @param transition_end_cb Callback function called when animation ends
6012 * @param transition_end_data Data to be passed to @p transition_end_cb
6013 * @return An instance of ::Elm_Box_Transition
6015 * @see elm_box_transition_new
6016 * @see elm_box_layout_transition
6018 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);
6020 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6022 * This function is mostly useful as the @c free_data parameter in
6023 * elm_box_layout_set() when elm_box_layout_transition().
6025 * @param data The Elm_Box_Transition instance to be freed.
6027 * @see elm_box_transition_new
6028 * @see elm_box_layout_transition
6030 EAPI void elm_box_transition_free(void *data);
6037 * @defgroup Button Button
6039 * @image html img/widget/button/preview-00.png
6040 * @image latex img/widget/button/preview-00.eps
6041 * @image html img/widget/button/preview-01.png
6042 * @image latex img/widget/button/preview-01.eps
6043 * @image html img/widget/button/preview-02.png
6044 * @image latex img/widget/button/preview-02.eps
6046 * This is a push-button. Press it and run some function. It can contain
6047 * a simple label and icon object and it also has an autorepeat feature.
6049 * This widgets emits the following signals:
6050 * @li "clicked": the user clicked the button (press/release).
6051 * @li "repeated": the user pressed the button without releasing it.
6052 * @li "pressed": button was pressed.
6053 * @li "unpressed": button was released after being pressed.
6054 * In all three cases, the @c event parameter of the callback will be
6057 * Also, defined in the default theme, the button has the following styles
6059 * @li default: a normal button.
6060 * @li anchor: Like default, but the button fades away when the mouse is not
6061 * over it, leaving only the text or icon.
6062 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6063 * continuous look across its options.
6064 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6066 * Default contents parts of the button widget that you can use for are:
6067 * @li "icon" - A icon of the button
6069 * Default text parts of the button widget that you can use for are:
6070 * @li "default" - Label of the button
6072 * Follow through a complete example @ref button_example_01 "here".
6076 * Add a new button to the parent's canvas
6078 * @param parent The parent object
6079 * @return The new object or NULL if it cannot be created
6081 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6083 * Set the label used in the button
6085 * The passed @p label can be NULL to clean any existing text in it and
6086 * leave the button as an icon only object.
6088 * @param obj The button object
6089 * @param label The text will be written on the button
6090 * @deprecated use elm_object_text_set() instead.
6092 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6094 * Get the label set for the button
6096 * The string returned is an internal pointer and should not be freed or
6097 * altered. It will also become invalid when the button is destroyed.
6098 * The string returned, if not NULL, is a stringshare, so if you need to
6099 * keep it around even after the button is destroyed, you can use
6100 * eina_stringshare_ref().
6102 * @param obj The button object
6103 * @return The text set to the label, or NULL if nothing is set
6104 * @deprecated use elm_object_text_set() instead.
6106 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6108 * Set the icon used for the button
6110 * Setting a new icon will delete any other that was previously set, making
6111 * any reference to them invalid. If you need to maintain the previous
6112 * object alive, unset it first with elm_button_icon_unset().
6114 * @param obj The button object
6115 * @param icon The icon object for the button
6116 * @deprecated use elm_object_content_part_set() instead.
6118 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6120 * Get the icon used for the button
6122 * Return the icon object which is set for this widget. If the button is
6123 * destroyed or another icon is set, the returned object will be deleted
6124 * and any reference to it will be invalid.
6126 * @param obj The button object
6127 * @return The icon object that is being used
6129 * @deprecated use elm_object_content_part_get() instead
6131 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6133 * Remove the icon set without deleting it and return the object
6135 * This function drops the reference the button holds of the icon object
6136 * and returns this last object. It is used in case you want to remove any
6137 * icon, or set another one, without deleting the actual object. The button
6138 * will be left without an icon set.
6140 * @param obj The button object
6141 * @return The icon object that was being used
6142 * @deprecated use elm_object_content_part_unset() instead.
6144 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6146 * Turn on/off the autorepeat event generated when the button is kept pressed
6148 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6149 * signal when they are clicked.
6151 * When on, keeping a button pressed will continuously emit a @c repeated
6152 * signal until the button is released. The time it takes until it starts
6153 * emitting the signal is given by
6154 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6155 * new emission by elm_button_autorepeat_gap_timeout_set().
6157 * @param obj The button object
6158 * @param on A bool to turn on/off the event
6160 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6162 * Get whether the autorepeat feature is enabled
6164 * @param obj The button object
6165 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6167 * @see elm_button_autorepeat_set()
6169 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6171 * Set the initial timeout before the autorepeat event is generated
6173 * Sets the timeout, in seconds, since the button is pressed until the
6174 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6175 * won't be any delay and the even will be fired the moment the button is
6178 * @param obj The button object
6179 * @param t Timeout in seconds
6181 * @see elm_button_autorepeat_set()
6182 * @see elm_button_autorepeat_gap_timeout_set()
6184 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6186 * Get the initial timeout before the autorepeat event is generated
6188 * @param obj The button object
6189 * @return Timeout in seconds
6191 * @see elm_button_autorepeat_initial_timeout_set()
6193 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195 * Set the interval between each generated autorepeat event
6197 * After the first @c repeated event is fired, all subsequent ones will
6198 * follow after a delay of @p t seconds for each.
6200 * @param obj The button object
6201 * @param t Interval in seconds
6203 * @see elm_button_autorepeat_initial_timeout_set()
6205 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6207 * Get the interval between each generated autorepeat event
6209 * @param obj The button object
6210 * @return Interval in seconds
6212 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6218 * @defgroup File_Selector_Button File Selector Button
6220 * @image html img/widget/fileselector_button/preview-00.png
6221 * @image latex img/widget/fileselector_button/preview-00.eps
6222 * @image html img/widget/fileselector_button/preview-01.png
6223 * @image latex img/widget/fileselector_button/preview-01.eps
6224 * @image html img/widget/fileselector_button/preview-02.png
6225 * @image latex img/widget/fileselector_button/preview-02.eps
6227 * This is a button that, when clicked, creates an Elementary
6228 * window (or inner window) <b> with a @ref Fileselector "file
6229 * selector widget" within</b>. When a file is chosen, the (inner)
6230 * window is closed and the button emits a signal having the
6231 * selected file as it's @c event_info.
6233 * This widget encapsulates operations on its internal file
6234 * selector on its own API. There is less control over its file
6235 * selector than that one would have instatiating one directly.
6237 * The following styles are available for this button:
6240 * @li @c "hoversel_vertical"
6241 * @li @c "hoversel_vertical_entry"
6243 * Smart callbacks one can register to:
6244 * - @c "file,chosen" - the user has selected a path, whose string
6245 * pointer comes as the @c event_info data (a stringshared
6248 * Here is an example on its usage:
6249 * @li @ref fileselector_button_example
6251 * @see @ref File_Selector_Entry for a similar widget.
6256 * Add a new file selector button widget to the given parent
6257 * Elementary (container) object
6259 * @param parent The parent object
6260 * @return a new file selector button widget handle or @c NULL, on
6263 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6266 * Set the label for a given file selector button widget
6268 * @param obj The file selector button widget
6269 * @param label The text label to be displayed on @p obj
6271 * @deprecated use elm_object_text_set() instead.
6273 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6276 * Get the label set for a given file selector button widget
6278 * @param obj The file selector button widget
6279 * @return The button label
6281 * @deprecated use elm_object_text_set() instead.
6283 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6286 * Set the icon on a given file selector button widget
6288 * @param obj The file selector button widget
6289 * @param icon The icon object for the button
6291 * Once the icon object is set, a previously set one will be
6292 * deleted. If you want to keep the latter, use the
6293 * elm_fileselector_button_icon_unset() function.
6295 * @see elm_fileselector_button_icon_get()
6297 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6300 * Get the icon set for a given file selector button widget
6302 * @param obj The file selector button widget
6303 * @return The icon object currently set on @p obj or @c NULL, if
6306 * @see elm_fileselector_button_icon_set()
6308 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6311 * Unset the icon used in a given file selector button widget
6313 * @param obj The file selector button widget
6314 * @return The icon object that was being used on @p obj or @c
6317 * Unparent and return the icon object which was set for this
6320 * @see elm_fileselector_button_icon_set()
6322 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6325 * Set the title for a given file selector button widget's window
6327 * @param obj The file selector button widget
6328 * @param title The title string
6330 * This will change the window's title, when the file selector pops
6331 * out after a click on the button. Those windows have the default
6332 * (unlocalized) value of @c "Select a file" as titles.
6334 * @note It will only take any effect if the file selector
6335 * button widget is @b not under "inwin mode".
6337 * @see elm_fileselector_button_window_title_get()
6339 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6342 * Get the title set for a given file selector button widget's
6345 * @param obj The file selector button widget
6346 * @return Title of the file selector button's window
6348 * @see elm_fileselector_button_window_title_get() for more details
6350 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6353 * Set the size of a given file selector button widget's window,
6354 * holding the file selector itself.
6356 * @param obj The file selector button widget
6357 * @param width The window's width
6358 * @param height The window's height
6360 * @note it will only take any effect if the file selector button
6361 * widget is @b not under "inwin mode". The default size for the
6362 * window (when applicable) is 400x400 pixels.
6364 * @see elm_fileselector_button_window_size_get()
6366 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6369 * Get the size of a given file selector button widget's window,
6370 * holding the file selector itself.
6372 * @param obj The file selector button widget
6373 * @param width Pointer into which to store the width value
6374 * @param height Pointer into which to store the height value
6376 * @note Use @c NULL pointers on the size values you're not
6377 * interested in: they'll be ignored by the function.
6379 * @see elm_fileselector_button_window_size_set(), for more details
6381 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6384 * Set the initial file system path for a given file selector
6387 * @param obj The file selector button widget
6388 * @param path The path string
6390 * It must be a <b>directory</b> path, which will have the contents
6391 * displayed initially in the file selector's view, when invoked
6392 * from @p obj. The default initial path is the @c "HOME"
6393 * environment variable's value.
6395 * @see elm_fileselector_button_path_get()
6397 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6400 * Get the initial file system path set for a given file selector
6403 * @param obj The file selector button widget
6404 * @return path The path string
6406 * @see elm_fileselector_button_path_set() for more details
6408 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6411 * Enable/disable a tree view in the given file selector button
6412 * widget's internal file selector
6414 * @param obj The file selector button widget
6415 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6418 * This has the same effect as elm_fileselector_expandable_set(),
6419 * but now applied to a file selector button's internal file
6422 * @note There's no way to put a file selector button's internal
6423 * file selector in "grid mode", as one may do with "pure" file
6426 * @see elm_fileselector_expandable_get()
6428 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6431 * Get whether tree view is enabled for the given file selector
6432 * button widget's internal file selector
6434 * @param obj The file selector button widget
6435 * @return @c EINA_TRUE if @p obj widget's internal file selector
6436 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6438 * @see elm_fileselector_expandable_set() for more details
6440 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6443 * Set whether a given file selector button widget's internal file
6444 * selector is to display folders only or the directory contents,
6447 * @param obj The file selector button widget
6448 * @param only @c EINA_TRUE to make @p obj widget's internal file
6449 * selector only display directories, @c EINA_FALSE to make files
6450 * to be displayed in it too
6452 * This has the same effect as elm_fileselector_folder_only_set(),
6453 * but now applied to a file selector button's internal file
6456 * @see elm_fileselector_folder_only_get()
6458 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6461 * Get whether a given file selector button widget's internal file
6462 * selector is displaying folders only or the directory contents,
6465 * @param obj The file selector button widget
6466 * @return @c EINA_TRUE if @p obj widget's internal file
6467 * selector is only displaying directories, @c EINA_FALSE if files
6468 * are being displayed in it too (and on errors)
6470 * @see elm_fileselector_button_folder_only_set() for more details
6472 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6475 * Enable/disable the file name entry box where the user can type
6476 * in a name for a file, in a given file selector button widget's
6477 * internal file selector.
6479 * @param obj The file selector button widget
6480 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6481 * file selector a "saving dialog", @c EINA_FALSE otherwise
6483 * This has the same effect as elm_fileselector_is_save_set(),
6484 * but now applied to a file selector button's internal file
6487 * @see elm_fileselector_is_save_get()
6489 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6492 * Get whether the given file selector button widget's internal
6493 * file selector is in "saving dialog" mode
6495 * @param obj The file selector button widget
6496 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6497 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6500 * @see elm_fileselector_button_is_save_set() for more details
6502 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6505 * Set whether a given file selector button widget's internal file
6506 * selector will raise an Elementary "inner window", instead of a
6507 * dedicated Elementary window. By default, it won't.
6509 * @param obj The file selector button widget
6510 * @param value @c EINA_TRUE to make it use an inner window, @c
6511 * EINA_TRUE to make it use a dedicated window
6513 * @see elm_win_inwin_add() for more information on inner windows
6514 * @see elm_fileselector_button_inwin_mode_get()
6516 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6519 * Get whether a given file selector button widget's internal file
6520 * selector will raise an Elementary "inner window", instead of a
6521 * dedicated Elementary window.
6523 * @param obj The file selector button widget
6524 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6525 * if it will use a dedicated window
6527 * @see elm_fileselector_button_inwin_mode_set() for more details
6529 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6536 * @defgroup File_Selector_Entry File Selector Entry
6538 * @image html img/widget/fileselector_entry/preview-00.png
6539 * @image latex img/widget/fileselector_entry/preview-00.eps
6541 * This is an entry made to be filled with or display a <b>file
6542 * system path string</b>. Besides the entry itself, the widget has
6543 * a @ref File_Selector_Button "file selector button" on its side,
6544 * which will raise an internal @ref Fileselector "file selector widget",
6545 * when clicked, for path selection aided by file system
6548 * This file selector may appear in an Elementary window or in an
6549 * inner window. When a file is chosen from it, the (inner) window
6550 * is closed and the selected file's path string is exposed both as
6551 * an smart event and as the new text on the entry.
6553 * This widget encapsulates operations on its internal file
6554 * selector on its own API. There is less control over its file
6555 * selector than that one would have instatiating one directly.
6557 * Smart callbacks one can register to:
6558 * - @c "changed" - The text within the entry was changed
6559 * - @c "activated" - The entry has had editing finished and
6560 * changes are to be "committed"
6561 * - @c "press" - The entry has been clicked
6562 * - @c "longpressed" - The entry has been clicked (and held) for a
6564 * - @c "clicked" - The entry has been clicked
6565 * - @c "clicked,double" - The entry has been double clicked
6566 * - @c "focused" - The entry has received focus
6567 * - @c "unfocused" - The entry has lost focus
6568 * - @c "selection,paste" - A paste action has occurred on the
6570 * - @c "selection,copy" - A copy action has occurred on the entry
6571 * - @c "selection,cut" - A cut action has occurred on the entry
6572 * - @c "unpressed" - The file selector entry's button was released
6573 * after being pressed.
6574 * - @c "file,chosen" - The user has selected a path via the file
6575 * selector entry's internal file selector, whose string pointer
6576 * comes as the @c event_info data (a stringshared string)
6578 * Here is an example on its usage:
6579 * @li @ref fileselector_entry_example
6581 * @see @ref File_Selector_Button for a similar widget.
6586 * Add a new file selector entry widget to the given parent
6587 * Elementary (container) object
6589 * @param parent The parent object
6590 * @return a new file selector entry widget handle or @c NULL, on
6593 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6596 * Set the label for a given file selector entry widget's button
6598 * @param obj The file selector entry widget
6599 * @param label The text label to be displayed on @p obj widget's
6602 * @deprecated use elm_object_text_set() instead.
6604 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6607 * Get the label set for a given file selector entry widget's button
6609 * @param obj The file selector entry widget
6610 * @return The widget button's label
6612 * @deprecated use elm_object_text_set() instead.
6614 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6617 * Set the icon on a given file selector entry widget's button
6619 * @param obj The file selector entry widget
6620 * @param icon The icon object for the entry's button
6622 * Once the icon object is set, a previously set one will be
6623 * deleted. If you want to keep the latter, use the
6624 * elm_fileselector_entry_button_icon_unset() function.
6626 * @see elm_fileselector_entry_button_icon_get()
6628 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6631 * Get the icon set for a given file selector entry widget's button
6633 * @param obj The file selector entry widget
6634 * @return The icon object currently set on @p obj widget's button
6635 * or @c NULL, if none is
6637 * @see elm_fileselector_entry_button_icon_set()
6639 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6642 * Unset the icon used in a given file selector entry widget's
6645 * @param obj The file selector entry widget
6646 * @return The icon object that was being used on @p obj widget's
6647 * button or @c NULL, on errors
6649 * Unparent and return the icon object which was set for this
6652 * @see elm_fileselector_entry_button_icon_set()
6654 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6657 * Set the title for a given file selector entry widget's window
6659 * @param obj The file selector entry widget
6660 * @param title The title string
6662 * This will change the window's title, when the file selector pops
6663 * out after a click on the entry's button. Those windows have the
6664 * default (unlocalized) value of @c "Select a file" as titles.
6666 * @note It will only take any effect if the file selector
6667 * entry widget is @b not under "inwin mode".
6669 * @see elm_fileselector_entry_window_title_get()
6671 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6674 * Get the title set for a given file selector entry widget's
6677 * @param obj The file selector entry widget
6678 * @return Title of the file selector entry's window
6680 * @see elm_fileselector_entry_window_title_get() for more details
6682 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6685 * Set the size of a given file selector entry widget's window,
6686 * holding the file selector itself.
6688 * @param obj The file selector entry widget
6689 * @param width The window's width
6690 * @param height The window's height
6692 * @note it will only take any effect if the file selector entry
6693 * widget is @b not under "inwin mode". The default size for the
6694 * window (when applicable) is 400x400 pixels.
6696 * @see elm_fileselector_entry_window_size_get()
6698 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6701 * Get the size of a given file selector entry widget's window,
6702 * holding the file selector itself.
6704 * @param obj The file selector entry widget
6705 * @param width Pointer into which to store the width value
6706 * @param height Pointer into which to store the height value
6708 * @note Use @c NULL pointers on the size values you're not
6709 * interested in: they'll be ignored by the function.
6711 * @see elm_fileselector_entry_window_size_set(), for more details
6713 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6716 * Set the initial file system path and the entry's path string for
6717 * a given file selector entry widget
6719 * @param obj The file selector entry widget
6720 * @param path The path string
6722 * It must be a <b>directory</b> path, which will have the contents
6723 * displayed initially in the file selector's view, when invoked
6724 * from @p obj. The default initial path is the @c "HOME"
6725 * environment variable's value.
6727 * @see elm_fileselector_entry_path_get()
6729 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6732 * Get the entry's path string for a given file selector entry
6735 * @param obj The file selector entry widget
6736 * @return path The path string
6738 * @see elm_fileselector_entry_path_set() for more details
6740 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6743 * Enable/disable a tree view in the given file selector entry
6744 * widget's internal file selector
6746 * @param obj The file selector entry widget
6747 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6750 * This has the same effect as elm_fileselector_expandable_set(),
6751 * but now applied to a file selector entry's internal file
6754 * @note There's no way to put a file selector entry's internal
6755 * file selector in "grid mode", as one may do with "pure" file
6758 * @see elm_fileselector_expandable_get()
6760 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6763 * Get whether tree view is enabled for the given file selector
6764 * entry widget's internal file selector
6766 * @param obj The file selector entry widget
6767 * @return @c EINA_TRUE if @p obj widget's internal file selector
6768 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6770 * @see elm_fileselector_expandable_set() for more details
6772 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6775 * Set whether a given file selector entry widget's internal file
6776 * selector is to display folders only or the directory contents,
6779 * @param obj The file selector entry widget
6780 * @param only @c EINA_TRUE to make @p obj widget's internal file
6781 * selector only display directories, @c EINA_FALSE to make files
6782 * to be displayed in it too
6784 * This has the same effect as elm_fileselector_folder_only_set(),
6785 * but now applied to a file selector entry's internal file
6788 * @see elm_fileselector_folder_only_get()
6790 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6793 * Get whether a given file selector entry widget's internal file
6794 * selector is displaying folders only or the directory contents,
6797 * @param obj The file selector entry widget
6798 * @return @c EINA_TRUE if @p obj widget's internal file
6799 * selector is only displaying directories, @c EINA_FALSE if files
6800 * are being displayed in it too (and on errors)
6802 * @see elm_fileselector_entry_folder_only_set() for more details
6804 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6807 * Enable/disable the file name entry box where the user can type
6808 * in a name for a file, in a given file selector entry widget's
6809 * internal file selector.
6811 * @param obj The file selector entry widget
6812 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6813 * file selector a "saving dialog", @c EINA_FALSE otherwise
6815 * This has the same effect as elm_fileselector_is_save_set(),
6816 * but now applied to a file selector entry's internal file
6819 * @see elm_fileselector_is_save_get()
6821 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6824 * Get whether the given file selector entry widget's internal
6825 * file selector is in "saving dialog" mode
6827 * @param obj The file selector entry widget
6828 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6829 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6832 * @see elm_fileselector_entry_is_save_set() for more details
6834 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6837 * Set whether a given file selector entry widget's internal file
6838 * selector will raise an Elementary "inner window", instead of a
6839 * dedicated Elementary window. By default, it won't.
6841 * @param obj The file selector entry widget
6842 * @param value @c EINA_TRUE to make it use an inner window, @c
6843 * EINA_TRUE to make it use a dedicated window
6845 * @see elm_win_inwin_add() for more information on inner windows
6846 * @see elm_fileselector_entry_inwin_mode_get()
6848 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6851 * Get whether a given file selector entry widget's internal file
6852 * selector will raise an Elementary "inner window", instead of a
6853 * dedicated Elementary window.
6855 * @param obj The file selector entry widget
6856 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6857 * if it will use a dedicated window
6859 * @see elm_fileselector_entry_inwin_mode_set() for more details
6861 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6864 * Set the initial file system path for a given file selector entry
6867 * @param obj The file selector entry widget
6868 * @param path The path string
6870 * It must be a <b>directory</b> path, which will have the contents
6871 * displayed initially in the file selector's view, when invoked
6872 * from @p obj. The default initial path is the @c "HOME"
6873 * environment variable's value.
6875 * @see elm_fileselector_entry_path_get()
6877 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6880 * Get the parent directory's path to the latest file selection on
6881 * a given filer selector entry widget
6883 * @param obj The file selector object
6884 * @return The (full) path of the directory of the last selection
6885 * on @p obj widget, a @b stringshared string
6887 * @see elm_fileselector_entry_path_set()
6889 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6896 * @defgroup Scroller Scroller
6898 * A scroller holds a single object and "scrolls it around". This means that
6899 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6900 * region around, allowing to move through a much larger object that is
6901 * contained in the scroller. The scroller will always have a small minimum
6902 * size by default as it won't be limited by the contents of the scroller.
6904 * Signals that you can add callbacks for are:
6905 * @li "edge,left" - the left edge of the content has been reached
6906 * @li "edge,right" - the right edge of the content has been reached
6907 * @li "edge,top" - the top edge of the content has been reached
6908 * @li "edge,bottom" - the bottom edge of the content has been reached
6909 * @li "scroll" - the content has been scrolled (moved)
6910 * @li "scroll,anim,start" - scrolling animation has started
6911 * @li "scroll,anim,stop" - scrolling animation has stopped
6912 * @li "scroll,drag,start" - dragging the contents around has started
6913 * @li "scroll,drag,stop" - dragging the contents around has stopped
6914 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6917 * @note When Elemementary is in embedded mode the scrollbars will not be
6918 * dragable, they appear merely as indicators of how much has been scrolled.
6919 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6920 * fingerscroll) won't work.
6922 * Default contents parts of the scroller widget that you can use for are:
6923 * @li "default" - A content of the scroller
6925 * In @ref tutorial_scroller you'll find an example of how to use most of
6930 * @brief Type that controls when scrollbars should appear.
6932 * @see elm_scroller_policy_set()
6934 typedef enum _Elm_Scroller_Policy
6936 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6937 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6938 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6939 ELM_SCROLLER_POLICY_LAST
6940 } Elm_Scroller_Policy;
6942 * @brief Add a new scroller to the parent
6944 * @param parent The parent object
6945 * @return The new object or NULL if it cannot be created
6947 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6949 * @brief Set the content of the scroller widget (the object to be scrolled around).
6951 * @param obj The scroller object
6952 * @param content The new content object
6954 * Once the content object is set, a previously set one will be deleted.
6955 * If you want to keep that old content object, use the
6956 * elm_scroller_content_unset() function.
6957 * @deprecated use elm_object_content_set() instead
6959 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6961 * @brief Get the content of the scroller widget
6963 * @param obj The slider object
6964 * @return The content that is being used
6966 * Return the content object which is set for this widget
6968 * @see elm_scroller_content_set()
6969 * @deprecated use elm_object_content_get() instead.
6971 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6973 * @brief Unset the content of the scroller widget
6975 * @param obj The slider object
6976 * @return The content that was being used
6978 * Unparent and return the content object which was set for this widget
6980 * @see elm_scroller_content_set()
6981 * @deprecated use elm_object_content_unset() instead.
6983 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6985 * @brief Set custom theme elements for the scroller
6987 * @param obj The scroller object
6988 * @param widget The widget name to use (default is "scroller")
6989 * @param base The base name to use (default is "base")
6991 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6993 * @brief Make the scroller minimum size limited to the minimum size of the content
6995 * @param obj The scroller object
6996 * @param w Enable limiting minimum size horizontally
6997 * @param h Enable limiting minimum size vertically
6999 * By default the scroller will be as small as its design allows,
7000 * irrespective of its content. This will make the scroller minimum size the
7001 * right size horizontally and/or vertically to perfectly fit its content in
7004 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7006 * @brief Show a specific virtual region within the scroller content object
7008 * @param obj The scroller object
7009 * @param x X coordinate of the region
7010 * @param y Y coordinate of the region
7011 * @param w Width of the region
7012 * @param h Height of the region
7014 * This will ensure all (or part if it does not fit) of the designated
7015 * region in the virtual content object (0, 0 starting at the top-left of the
7016 * virtual content object) is shown within the scroller.
7018 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);
7020 * @brief Set the scrollbar visibility policy
7022 * @param obj The scroller object
7023 * @param policy_h Horizontal scrollbar policy
7024 * @param policy_v Vertical scrollbar policy
7026 * This sets the scrollbar visibility policy for the given scroller.
7027 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7028 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7029 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7030 * respectively for the horizontal and vertical scrollbars.
7032 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7034 * @brief Gets scrollbar visibility policy
7036 * @param obj The scroller object
7037 * @param policy_h Horizontal scrollbar policy
7038 * @param policy_v Vertical scrollbar policy
7040 * @see elm_scroller_policy_set()
7042 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7044 * @brief Get the currently visible content region
7046 * @param obj The scroller object
7047 * @param x X coordinate of the region
7048 * @param y Y coordinate of the region
7049 * @param w Width of the region
7050 * @param h Height of the region
7052 * This gets the current region in the content object that is visible through
7053 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7054 * w, @p h values pointed to.
7056 * @note All coordinates are relative to the content.
7058 * @see elm_scroller_region_show()
7060 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);
7062 * @brief Get the size of the content object
7064 * @param obj The scroller object
7065 * @param w Width of the content object.
7066 * @param h Height of the content object.
7068 * This gets the size of the content object of the scroller.
7070 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7072 * @brief Set bouncing behavior
7074 * @param obj The scroller object
7075 * @param h_bounce Allow bounce horizontally
7076 * @param v_bounce Allow bounce vertically
7078 * When scrolling, the scroller may "bounce" when reaching an edge of the
7079 * content object. This is a visual way to indicate the end has been reached.
7080 * This is enabled by default for both axis. This API will set if it is enabled
7081 * for the given axis with the boolean parameters for each axis.
7083 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7085 * @brief Get the bounce behaviour
7087 * @param obj The Scroller object
7088 * @param h_bounce Will the scroller bounce horizontally or not
7089 * @param v_bounce Will the scroller bounce vertically or not
7091 * @see elm_scroller_bounce_set()
7093 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7095 * @brief Set scroll page size relative to viewport size.
7097 * @param obj The scroller object
7098 * @param h_pagerel The horizontal page relative size
7099 * @param v_pagerel The vertical page relative size
7101 * The scroller is capable of limiting scrolling by the user to "pages". That
7102 * is to jump by and only show a "whole page" at a time as if the continuous
7103 * area of the scroller content is split into page sized pieces. This sets
7104 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7105 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7106 * axis. This is mutually exclusive with page size
7107 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7108 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7109 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7112 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7114 * @brief Set scroll page size.
7116 * @param obj The scroller object
7117 * @param h_pagesize The horizontal page size
7118 * @param v_pagesize The vertical page size
7120 * This sets the page size to an absolute fixed value, with 0 turning it off
7123 * @see elm_scroller_page_relative_set()
7125 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7127 * @brief Get scroll current page number.
7129 * @param obj The scroller object
7130 * @param h_pagenumber The horizontal page number
7131 * @param v_pagenumber The vertical page number
7133 * The page number starts from 0. 0 is the first page.
7134 * Current page means the page which meets the top-left of the viewport.
7135 * If there are two or more pages in the viewport, it returns the number of the page
7136 * which meets the top-left of the viewport.
7138 * @see elm_scroller_last_page_get()
7139 * @see elm_scroller_page_show()
7140 * @see elm_scroller_page_brint_in()
7142 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7144 * @brief Get scroll last page number.
7146 * @param obj The scroller object
7147 * @param h_pagenumber The horizontal page number
7148 * @param v_pagenumber The vertical page number
7150 * The page number starts from 0. 0 is the first page.
7151 * This returns the last page number among the pages.
7153 * @see elm_scroller_current_page_get()
7154 * @see elm_scroller_page_show()
7155 * @see elm_scroller_page_brint_in()
7157 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7159 * Show a specific virtual region within the scroller content object by page number.
7161 * @param obj The scroller object
7162 * @param h_pagenumber The horizontal page number
7163 * @param v_pagenumber The vertical page number
7165 * 0, 0 of the indicated page is located at the top-left of the viewport.
7166 * This will jump to the page directly without animation.
7171 * sc = elm_scroller_add(win);
7172 * elm_scroller_content_set(sc, content);
7173 * elm_scroller_page_relative_set(sc, 1, 0);
7174 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7175 * elm_scroller_page_show(sc, h_page + 1, v_page);
7178 * @see elm_scroller_page_bring_in()
7180 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7182 * Show a specific virtual region within the scroller content object by page number.
7184 * @param obj The scroller object
7185 * @param h_pagenumber The horizontal page number
7186 * @param v_pagenumber The vertical page number
7188 * 0, 0 of the indicated page is located at the top-left of the viewport.
7189 * This will slide to the page with animation.
7194 * sc = elm_scroller_add(win);
7195 * elm_scroller_content_set(sc, content);
7196 * elm_scroller_page_relative_set(sc, 1, 0);
7197 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7198 * elm_scroller_page_bring_in(sc, h_page, v_page);
7201 * @see elm_scroller_page_show()
7203 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7205 * @brief Show a specific virtual region within the scroller content object.
7207 * @param obj The scroller object
7208 * @param x X coordinate of the region
7209 * @param y Y coordinate of the region
7210 * @param w Width of the region
7211 * @param h Height of the region
7213 * This will ensure all (or part if it does not fit) of the designated
7214 * region in the virtual content object (0, 0 starting at the top-left of the
7215 * virtual content object) is shown within the scroller. Unlike
7216 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7217 * to this location (if configuration in general calls for transitions). It
7218 * may not jump immediately to the new location and make take a while and
7219 * show other content along the way.
7221 * @see elm_scroller_region_show()
7223 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);
7225 * @brief Set event propagation on a scroller
7227 * @param obj The scroller object
7228 * @param propagation If propagation is enabled or not
7230 * This enables or disabled event propagation from the scroller content to
7231 * the scroller and its parent. By default event propagation is disabled.
7233 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7235 * @brief Get event propagation for a scroller
7237 * @param obj The scroller object
7238 * @return The propagation state
7240 * This gets the event propagation for a scroller.
7242 * @see elm_scroller_propagate_events_set()
7244 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7246 * @brief Set scrolling gravity on a scroller
7248 * @param obj The scroller object
7249 * @param x The scrolling horizontal gravity
7250 * @param y The scrolling vertical gravity
7252 * The gravity, defines how the scroller will adjust its view
7253 * when the size of the scroller contents increase.
7255 * The scroller will adjust the view to glue itself as follows.
7257 * x=0.0, for showing the left most region of the content.
7258 * x=1.0, for showing the right most region of the content.
7259 * y=0.0, for showing the bottom most region of the content.
7260 * y=1.0, for showing the top most region of the content.
7262 * Default values for x and y are 0.0
7264 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7266 * @brief Get scrolling gravity values for a scroller
7268 * @param obj The scroller object
7269 * @param x The scrolling horizontal gravity
7270 * @param y The scrolling vertical gravity
7272 * This gets gravity values for a scroller.
7274 * @see elm_scroller_gravity_set()
7277 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7283 * @defgroup Label Label
7285 * @image html img/widget/label/preview-00.png
7286 * @image latex img/widget/label/preview-00.eps
7288 * @brief Widget to display text, with simple html-like markup.
7290 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7291 * text doesn't fit the geometry of the label it will be ellipsized or be
7292 * cut. Elementary provides several themes for this widget:
7293 * @li default - No animation
7294 * @li marker - Centers the text in the label and make it bold by default
7295 * @li slide_long - The entire text appears from the right of the screen and
7296 * slides until it disappears in the left of the screen(reappering on the
7298 * @li slide_short - The text appears in the left of the label and slides to
7299 * the right to show the overflow. When all of the text has been shown the
7300 * position is reset.
7301 * @li slide_bounce - The text appears in the left of the label and slides to
7302 * the right to show the overflow. When all of the text has been shown the
7303 * animation reverses, moving the text to the left.
7305 * Custom themes can of course invent new markup tags and style them any way
7308 * The following signals may be emitted by the label widget:
7309 * @li "language,changed": The program's language changed.
7311 * See @ref tutorial_label for a demonstration of how to use a label widget.
7315 * @brief Add a new label to the parent
7317 * @param parent The parent object
7318 * @return The new object or NULL if it cannot be created
7320 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7322 * @brief Set the label on the label object
7324 * @param obj The label object
7325 * @param label The label will be used on the label object
7326 * @deprecated See elm_object_text_set()
7328 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 */
7330 * @brief Get the label used on the label object
7332 * @param obj The label object
7333 * @return The string inside the label
7334 * @deprecated See elm_object_text_get()
7336 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7338 * @brief Set the wrapping behavior of the label
7340 * @param obj The label object
7341 * @param wrap To wrap text or not
7343 * By default no wrapping is done. Possible values for @p wrap are:
7344 * @li ELM_WRAP_NONE - No wrapping
7345 * @li ELM_WRAP_CHAR - wrap between characters
7346 * @li ELM_WRAP_WORD - wrap between words
7347 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7349 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7351 * @brief Get the wrapping behavior of the label
7353 * @param obj The label object
7356 * @see elm_label_line_wrap_set()
7358 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7360 * @brief Set wrap width of the label
7362 * @param obj The label object
7363 * @param w The wrap width in pixels at a minimum where words need to wrap
7365 * This function sets the maximum width size hint of the label.
7367 * @warning This is only relevant if the label is inside a container.
7369 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7371 * @brief Get wrap width of the label
7373 * @param obj The label object
7374 * @return The wrap width in pixels at a minimum where words need to wrap
7376 * @see elm_label_wrap_width_set()
7378 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7380 * @brief Set wrap height of the label
7382 * @param obj The label object
7383 * @param h The wrap height in pixels at a minimum where words need to wrap
7385 * This function sets the maximum height size hint of the label.
7387 * @warning This is only relevant if the label is inside a container.
7389 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7391 * @brief get wrap width of the label
7393 * @param obj The label object
7394 * @return The wrap height in pixels at a minimum where words need to wrap
7396 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7398 * @brief Set the font size on the label object.
7400 * @param obj The label object
7401 * @param size font size
7403 * @warning NEVER use this. It is for hyper-special cases only. use styles
7404 * instead. e.g. "big", "medium", "small" - or better name them by use:
7405 * "title", "footnote", "quote" etc.
7407 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7409 * @brief Set the text color on the label object
7411 * @param obj The label object
7412 * @param r Red property background color of The label object
7413 * @param g Green property background color of The label object
7414 * @param b Blue property background color of The label object
7415 * @param a Alpha property background color of The label object
7417 * @warning NEVER use this. It is for hyper-special cases only. use styles
7418 * instead. e.g. "big", "medium", "small" - or better name them by use:
7419 * "title", "footnote", "quote" etc.
7421 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);
7423 * @brief Set the text align on the label object
7425 * @param obj The label object
7426 * @param align align mode ("left", "center", "right")
7428 * @warning NEVER use this. It is for hyper-special cases only. use styles
7429 * instead. e.g. "big", "medium", "small" - or better name them by use:
7430 * "title", "footnote", "quote" etc.
7432 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7434 * @brief Set background color of the label
7436 * @param obj The label object
7437 * @param r Red property background color of The label object
7438 * @param g Green property background color of The label object
7439 * @param b Blue property background color of The label object
7440 * @param a Alpha property background alpha of The label object
7442 * @warning NEVER use this. It is for hyper-special cases only. use styles
7443 * instead. e.g. "big", "medium", "small" - or better name them by use:
7444 * "title", "footnote", "quote" etc.
7446 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);
7448 * @brief Set the ellipsis behavior of the label
7450 * @param obj The label object
7451 * @param ellipsis To ellipsis text or not
7453 * If set to true and the text doesn't fit in the label an ellipsis("...")
7454 * will be shown at the end of the widget.
7456 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7457 * choosen wrap method was ELM_WRAP_WORD.
7459 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7461 * @brief Set the text slide of the label
7463 * @param obj The label object
7464 * @param slide To start slide or stop
7466 * If set to true, the text of the label will slide/scroll through the length of
7469 * @warning This only works with the themes "slide_short", "slide_long" and
7472 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7474 * @brief Get the text slide mode of the label
7476 * @param obj The label object
7477 * @return slide slide mode value
7479 * @see elm_label_slide_set()
7481 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7483 * @brief Set the slide duration(speed) of the label
7485 * @param obj The label object
7486 * @return The duration in seconds in moving text from slide begin position
7487 * to slide end position
7489 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7491 * @brief Get the slide duration(speed) of the label
7493 * @param obj The label object
7494 * @return The duration time in moving text from slide begin position to slide end position
7496 * @see elm_label_slide_duration_set()
7498 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7504 * @defgroup Toggle Toggle
7506 * @image html img/widget/toggle/preview-00.png
7507 * @image latex img/widget/toggle/preview-00.eps
7509 * @brief A toggle is a slider which can be used to toggle between
7510 * two values. It has two states: on and off.
7512 * This widget is deprecated. Please use elm_check_add() instead using the
7513 * toggle style like:
7516 * obj = elm_check_add(parent);
7517 * elm_object_style_set(obj, "toggle");
7518 * elm_object_part_text_set(obj, "on", "ON");
7519 * elm_object_part_text_set(obj, "off", "OFF");
7522 * Signals that you can add callbacks for are:
7523 * @li "changed" - Whenever the toggle value has been changed. Is not called
7524 * until the toggle is released by the cursor (assuming it
7525 * has been triggered by the cursor in the first place).
7527 * Default contents parts of the toggle widget that you can use for are:
7528 * @li "icon" - A icon of the toggle
7530 * Default text parts of the toggle widget that you can use for are:
7531 * @li "elm.text" - Label of the toggle
7533 * @ref tutorial_toggle show how to use a toggle.
7537 * @brief Add a toggle to @p parent.
7539 * @param parent The parent object
7541 * @return The toggle object
7543 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7545 * @brief Sets the label to be displayed with the toggle.
7547 * @param obj The toggle object
7548 * @param label The label to be displayed
7550 * @deprecated use elm_object_text_set() instead.
7552 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7554 * @brief Gets the label of the toggle
7556 * @param obj toggle object
7557 * @return The label of the toggle
7559 * @deprecated use elm_object_text_get() instead.
7561 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7563 * @brief Set the icon used for the toggle
7565 * @param obj The toggle object
7566 * @param icon The icon object for the button
7568 * Once the icon object is set, a previously set one will be deleted
7569 * If you want to keep that old content object, use the
7570 * elm_toggle_icon_unset() function.
7572 * @deprecated use elm_object_content_part_set() instead.
7574 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7576 * @brief Get the icon used for the toggle
7578 * @param obj The toggle object
7579 * @return The icon object that is being used
7581 * Return the icon object which is set for this widget.
7583 * @see elm_toggle_icon_set()
7585 * @deprecated use elm_object_content_part_get() instead.
7587 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7589 * @brief Unset the icon used for the toggle
7591 * @param obj The toggle object
7592 * @return The icon object that was being used
7594 * Unparent and return the icon object which was set for this widget.
7596 * @see elm_toggle_icon_set()
7598 * @deprecated use elm_object_content_part_unset() instead.
7600 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7602 * @brief Sets the labels to be associated with the on and off states of the toggle.
7604 * @param obj The toggle object
7605 * @param onlabel The label displayed when the toggle is in the "on" state
7606 * @param offlabel The label displayed when the toggle is in the "off" state
7608 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7611 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7613 * @brief Gets the labels associated with the on and off states of the
7616 * @param obj The toggle object
7617 * @param onlabel A char** to place the onlabel of @p obj into
7618 * @param offlabel A char** to place the offlabel of @p obj into
7620 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7623 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7625 * @brief Sets the state of the toggle to @p state.
7627 * @param obj The toggle object
7628 * @param state The state of @p obj
7630 * @deprecated use elm_check_state_set() instead.
7632 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7634 * @brief Gets the state of the toggle to @p state.
7636 * @param obj The toggle object
7637 * @return The state of @p obj
7639 * @deprecated use elm_check_state_get() instead.
7641 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7643 * @brief Sets the state pointer of the toggle to @p statep.
7645 * @param obj The toggle object
7646 * @param statep The state pointer of @p obj
7648 * @deprecated use elm_check_state_pointer_set() instead.
7650 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7656 * @defgroup Frame Frame
7658 * @image html img/widget/frame/preview-00.png
7659 * @image latex img/widget/frame/preview-00.eps
7661 * @brief Frame is a widget that holds some content and has a title.
7663 * The default look is a frame with a title, but Frame supports multple
7671 * @li outdent_bottom
7673 * Of all this styles only default shows the title. Frame emits no signals.
7675 * Default contents parts of the frame widget that you can use for are:
7676 * @li "default" - A content of the frame
7678 * Default text parts of the frame widget that you can use for are:
7679 * @li "elm.text" - Label of the frame
7681 * For a detailed example see the @ref tutorial_frame.
7686 * @brief Add a new frame to the parent
7688 * @param parent The parent object
7689 * @return The new object or NULL if it cannot be created
7691 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7693 * @brief Set the frame label
7695 * @param obj The frame object
7696 * @param label The label of this frame object
7698 * @deprecated use elm_object_text_set() instead.
7700 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7702 * @brief Get the frame label
7704 * @param obj The frame object
7706 * @return The label of this frame objet or NULL if unable to get frame
7708 * @deprecated use elm_object_text_get() instead.
7710 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7712 * @brief Set the content of the frame widget
7714 * Once the content object is set, a previously set one will be deleted.
7715 * If you want to keep that old content object, use the
7716 * elm_frame_content_unset() function.
7718 * @param obj The frame object
7719 * @param content The content will be filled in this frame object
7721 * @deprecated use elm_object_content_set() instead.
7723 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7725 * @brief Get the content of the frame widget
7727 * Return the content object which is set for this widget
7729 * @param obj The frame object
7730 * @return The content that is being used
7732 * @deprecated use elm_object_content_get() instead.
7734 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7736 * @brief Unset the content of the frame widget
7738 * Unparent and return the content object which was set for this widget
7740 * @param obj The frame object
7741 * @return The content that was being used
7743 * @deprecated use elm_object_content_unset() instead.
7745 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7751 * @defgroup Table Table
7753 * A container widget to arrange other widgets in a table where items can
7754 * also span multiple columns or rows - even overlap (and then be raised or
7755 * lowered accordingly to adjust stacking if they do overlap).
7757 * For a Table widget the row/column count is not fixed.
7758 * The table widget adjusts itself when subobjects are added to it dynamically.
7760 * The followin are examples of how to use a table:
7761 * @li @ref tutorial_table_01
7762 * @li @ref tutorial_table_02
7767 * @brief Add a new table to the parent
7769 * @param parent The parent object
7770 * @return The new object or NULL if it cannot be created
7772 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7774 * @brief Set the homogeneous layout in the table
7776 * @param obj The layout object
7777 * @param homogeneous A boolean to set if the layout is homogeneous in the
7778 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7780 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7782 * @brief Get the current table homogeneous mode.
7784 * @param obj The table object
7785 * @return A boolean to indicating if the layout is homogeneous in the table
7786 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7788 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7790 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7792 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7794 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7796 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7798 * @brief Set padding between cells.
7800 * @param obj The layout object.
7801 * @param horizontal set the horizontal padding.
7802 * @param vertical set the vertical padding.
7804 * Default value is 0.
7806 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7808 * @brief Get padding between cells.
7810 * @param obj The layout object.
7811 * @param horizontal set the horizontal padding.
7812 * @param vertical set the vertical padding.
7814 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7816 * @brief Add a subobject on the table with the coordinates passed
7818 * @param obj The table object
7819 * @param subobj The subobject to be added to the table
7820 * @param x Row number
7821 * @param y Column number
7825 * @note All positioning inside the table is relative to rows and columns, so
7826 * a value of 0 for x and y, means the top left cell of the table, and a
7827 * value of 1 for w and h means @p subobj only takes that 1 cell.
7829 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7831 * @brief Remove child from table.
7833 * @param obj The table object
7834 * @param subobj The subobject
7836 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7838 * @brief Faster way to remove all child objects from a table object.
7840 * @param obj The table object
7841 * @param clear If true, will delete children, else just remove from table.
7843 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7845 * @brief Set the packing location of an existing child of the table
7847 * @param subobj The subobject to be modified in the table
7848 * @param x Row number
7849 * @param y Column number
7853 * Modifies the position of an object already in the table.
7855 * @note All positioning inside the table is relative to rows and columns, so
7856 * a value of 0 for x and y, means the top left cell of the table, and a
7857 * value of 1 for w and h means @p subobj only takes that 1 cell.
7859 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7861 * @brief Get the packing location of an existing child of the table
7863 * @param subobj The subobject to be modified in the table
7864 * @param x Row number
7865 * @param y Column number
7869 * @see elm_table_pack_set()
7871 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7876 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7877 typedef struct Elm_Gen_Item Elm_Gen_Item;
7878 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7879 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7880 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7881 typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7882 typedef Eina_Bool (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7883 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7884 struct _Elm_Gen_Item_Class
7886 const char *item_style;
7887 struct _Elm_Gen_Item_Class_Func
7889 Elm_Gen_Item_Label_Get_Cb label_get;
7890 Elm_Gen_Item_Content_Get_Cb content_get;
7891 Elm_Gen_Item_State_Get_Cb state_get;
7892 Elm_Gen_Item_Del_Cb del;
7895 EAPI void elm_gen_clear(Evas_Object *obj);
7896 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7897 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7898 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7899 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7900 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7901 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7902 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7903 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7904 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7905 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7906 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7907 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7908 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7909 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7910 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7911 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7912 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7913 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7914 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7915 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7918 * @defgroup Gengrid Gengrid (Generic grid)
7920 * This widget aims to position objects in a grid layout while
7921 * actually creating and rendering only the visible ones, using the
7922 * same idea as the @ref Genlist "genlist": the user defines a @b
7923 * class for each item, specifying functions that will be called at
7924 * object creation, deletion, etc. When those items are selected by
7925 * the user, a callback function is issued. Users may interact with
7926 * a gengrid via the mouse (by clicking on items to select them and
7927 * clicking on the grid's viewport and swiping to pan the whole
7928 * view) or via the keyboard, navigating through item with the
7931 * @section Gengrid_Layouts Gengrid layouts
7933 * Gengrid may layout its items in one of two possible layouts:
7937 * When in "horizontal mode", items will be placed in @b columns,
7938 * from top to bottom and, when the space for a column is filled,
7939 * another one is started on the right, thus expanding the grid
7940 * horizontally, making for horizontal scrolling. When in "vertical
7941 * mode" , though, items will be placed in @b rows, from left to
7942 * right and, when the space for a row is filled, another one is
7943 * started below, thus expanding the grid vertically (and making
7944 * for vertical scrolling).
7946 * @section Gengrid_Items Gengrid items
7948 * An item in a gengrid can have 0 or more text labels (they can be
7949 * regular text or textblock Evas objects - that's up to the style
7950 * to determine), 0 or more icons (which are simply objects
7951 * swallowed into the gengrid item's theming Edje object) and 0 or
7952 * more <b>boolean states</b>, which have the behavior left to the
7953 * user to define. The Edje part names for each of these properties
7954 * will be looked up, in the theme file for the gengrid, under the
7955 * Edje (string) data items named @c "labels", @c "icons" and @c
7956 * "states", respectively. For each of those properties, if more
7957 * than one part is provided, they must have names listed separated
7958 * by spaces in the data fields. For the default gengrid item
7959 * theme, we have @b one label part (@c "elm.text"), @b two icon
7960 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7963 * A gengrid item may be at one of several styles. Elementary
7964 * provides one by default - "default", but this can be extended by
7965 * system or application custom themes/overlays/extensions (see
7966 * @ref Theme "themes" for more details).
7968 * @section Gengrid_Item_Class Gengrid item classes
7970 * In order to have the ability to add and delete items on the fly,
7971 * gengrid implements a class (callback) system where the
7972 * application provides a structure with information about that
7973 * type of item (gengrid may contain multiple different items with
7974 * different classes, states and styles). Gengrid will call the
7975 * functions in this struct (methods) when an item is "realized"
7976 * (i.e., created dynamically, while the user is scrolling the
7977 * grid). All objects will simply be deleted when no longer needed
7978 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7979 * contains the following members:
7980 * - @c item_style - This is a constant string and simply defines
7981 * the name of the item style. It @b must be specified and the
7982 * default should be @c "default".
7983 * - @c func.label_get - This function is called when an item
7984 * object is actually created. The @c data parameter will point to
7985 * the same data passed to elm_gengrid_item_append() and related
7986 * item creation functions. The @c obj parameter is the gengrid
7987 * object itself, while the @c part one is the name string of one
7988 * of the existing text parts in the Edje group implementing the
7989 * item's theme. This function @b must return a strdup'()ed string,
7990 * as the caller will free() it when done. See
7991 * #Elm_Gengrid_Item_Label_Get_Cb.
7992 * - @c func.content_get - This function is called when an item object
7993 * is actually created. The @c data parameter will point to the
7994 * same data passed to elm_gengrid_item_append() and related item
7995 * creation functions. The @c obj parameter is the gengrid object
7996 * itself, while the @c part one is the name string of one of the
7997 * existing (content) swallow parts in the Edje group implementing the
7998 * item's theme. It must return @c NULL, when no content is desired,
7999 * or a valid object handle, otherwise. The object will be deleted
8000 * by the gengrid on its deletion or when the item is "unrealized".
8001 * See #Elm_Gengrid_Item_Content_Get_Cb.
8002 * - @c func.state_get - This function is called when an item
8003 * object is actually created. The @c data parameter will point to
8004 * the same data passed to elm_gengrid_item_append() and related
8005 * item creation functions. The @c obj parameter is the gengrid
8006 * object itself, while the @c part one is the name string of one
8007 * of the state parts in the Edje group implementing the item's
8008 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8009 * true/on. Gengrids will emit a signal to its theming Edje object
8010 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8011 * "source" arguments, respectively, when the state is true (the
8012 * default is false), where @c XXX is the name of the (state) part.
8013 * See #Elm_Gengrid_Item_State_Get_Cb.
8014 * - @c func.del - This is called when elm_gengrid_item_del() is
8015 * called on an item or elm_gengrid_clear() is called on the
8016 * gengrid. This is intended for use when gengrid items are
8017 * deleted, so any data attached to the item (e.g. its data
8018 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8020 * @section Gengrid_Usage_Hints Usage hints
8022 * If the user wants to have multiple items selected at the same
8023 * time, elm_gengrid_multi_select_set() will permit it. If the
8024 * gengrid is single-selection only (the default), then
8025 * elm_gengrid_select_item_get() will return the selected item or
8026 * @c NULL, if none is selected. If the gengrid is under
8027 * multi-selection, then elm_gengrid_selected_items_get() will
8028 * return a list (that is only valid as long as no items are
8029 * modified (added, deleted, selected or unselected) of child items
8032 * If an item changes (internal (boolean) state, label or content
8033 * changes), then use elm_gengrid_item_update() to have gengrid
8034 * update the item with the new state. A gengrid will re-"realize"
8035 * the item, thus calling the functions in the
8036 * #Elm_Gengrid_Item_Class set for that item.
8038 * To programmatically (un)select an item, use
8039 * elm_gengrid_item_selected_set(). To get its selected state use
8040 * elm_gengrid_item_selected_get(). To make an item disabled
8041 * (unable to be selected and appear differently) use
8042 * elm_gengrid_item_disabled_set() to set this and
8043 * elm_gengrid_item_disabled_get() to get the disabled state.
8045 * Grid cells will only have their selection smart callbacks called
8046 * when firstly getting selected. Any further clicks will do
8047 * nothing, unless you enable the "always select mode", with
8048 * elm_gengrid_always_select_mode_set(), thus making every click to
8049 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8050 * turn off the ability to select items entirely in the widget and
8051 * they will neither appear selected nor call the selection smart
8054 * Remember that you can create new styles and add your own theme
8055 * augmentation per application with elm_theme_extension_add(). If
8056 * you absolutely must have a specific style that overrides any
8057 * theme the user or system sets up you can use
8058 * elm_theme_overlay_add() to add such a file.
8060 * @section Gengrid_Smart_Events Gengrid smart events
8062 * Smart events that you can add callbacks for are:
8063 * - @c "activated" - The user has double-clicked or pressed
8064 * (enter|return|spacebar) on an item. The @c event_info parameter
8065 * is the gengrid item that was activated.
8066 * - @c "clicked,double" - The user has double-clicked an item.
8067 * The @c event_info parameter is the gengrid item that was double-clicked.
8068 * - @c "longpressed" - This is called when the item is pressed for a certain
8069 * amount of time. By default it's 1 second.
8070 * - @c "selected" - The user has made an item selected. The
8071 * @c event_info parameter is the gengrid item that was selected.
8072 * - @c "unselected" - The user has made an item unselected. The
8073 * @c event_info parameter is the gengrid item that was unselected.
8074 * - @c "realized" - This is called when the item in the gengrid
8075 * has its implementing Evas object instantiated, de facto. @c
8076 * event_info is the gengrid item that was created. The object
8077 * may be deleted at any time, so it is highly advised to the
8078 * caller @b not to use the object pointer returned from
8079 * elm_gengrid_item_object_get(), because it may point to freed
8081 * - @c "unrealized" - This is called when the implementing Evas
8082 * object for this item is deleted. @c event_info is the gengrid
8083 * item that was deleted.
8084 * - @c "changed" - Called when an item is added, removed, resized
8085 * or moved and when the gengrid is resized or gets "horizontal"
8087 * - @c "scroll,anim,start" - This is called when scrolling animation has
8089 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8091 * - @c "drag,start,up" - Called when the item in the gengrid has
8092 * been dragged (not scrolled) up.
8093 * - @c "drag,start,down" - Called when the item in the gengrid has
8094 * been dragged (not scrolled) down.
8095 * - @c "drag,start,left" - Called when the item in the gengrid has
8096 * been dragged (not scrolled) left.
8097 * - @c "drag,start,right" - Called when the item in the gengrid has
8098 * been dragged (not scrolled) right.
8099 * - @c "drag,stop" - Called when the item in the gengrid has
8100 * stopped being dragged.
8101 * - @c "drag" - Called when the item in the gengrid is being
8103 * - @c "scroll" - called when the content has been scrolled
8105 * - @c "scroll,drag,start" - called when dragging the content has
8107 * - @c "scroll,drag,stop" - called when dragging the content has
8109 * - @c "edge,top" - This is called when the gengrid is scrolled until
8111 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8112 * until the bottom edge.
8113 * - @c "edge,left" - This is called when the gengrid is scrolled
8114 * until the left edge.
8115 * - @c "edge,right" - This is called when the gengrid is scrolled
8116 * until the right edge.
8118 * List of gengrid examples:
8119 * @li @ref gengrid_example
8123 * @addtogroup Gengrid
8127 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8128 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8129 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8130 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8131 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8133 * Label fetching class function for Elm_Gen_Item_Class.
8134 * @param data The data passed in the item creation function
8135 * @param obj The base widget object
8136 * @param part The part name of the swallow
8137 * @return The allocated (NOT stringshared) string to set as the label
8139 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8141 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8142 * @param data The data passed in the item creation function
8143 * @param obj The base widget object
8144 * @param part The part name of the swallow
8145 * @return The content object to swallow
8147 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8149 * State fetching class function for Elm_Gen_Item_Class.
8150 * @param data The data passed in the item creation function
8151 * @param obj The base widget object
8152 * @param part The part name of the swallow
8153 * @return The hell if I know
8155 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8157 * Deletion class function for Elm_Gen_Item_Class.
8158 * @param data The data passed in the item creation function
8159 * @param obj The base widget object
8161 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8164 * @struct _Elm_Gengrid_Item_Class
8166 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8169 struct _Elm_Gengrid_Item_Class
8171 const char *item_style;
8172 struct _Elm_Gengrid_Item_Class_Func
8174 Elm_Gengrid_Item_Label_Get_Cb label_get;
8175 Elm_Gengrid_Item_Content_Get_Cb content_get;
8176 Elm_Gengrid_Item_State_Get_Cb state_get;
8177 Elm_Gengrid_Item_Del_Cb del;
8179 }; /**< #Elm_Gengrid_Item_Class member definitions */
8180 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8182 * Add a new gengrid widget to the given parent Elementary
8183 * (container) object
8185 * @param parent The parent object
8186 * @return a new gengrid widget handle or @c NULL, on errors
8188 * This function inserts a new gengrid widget on the canvas.
8190 * @see elm_gengrid_item_size_set()
8191 * @see elm_gengrid_group_item_size_set()
8192 * @see elm_gengrid_horizontal_set()
8193 * @see elm_gengrid_item_append()
8194 * @see elm_gengrid_item_del()
8195 * @see elm_gengrid_clear()
8199 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8202 * Set the size for the items of a given gengrid widget
8204 * @param obj The gengrid object.
8205 * @param w The items' width.
8206 * @param h The items' height;
8208 * A gengrid, after creation, has still no information on the size
8209 * to give to each of its cells. So, you most probably will end up
8210 * with squares one @ref Fingers "finger" wide, the default
8211 * size. Use this function to force a custom size for you items,
8212 * making them as big as you wish.
8214 * @see elm_gengrid_item_size_get()
8218 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8221 * Get the size set for the items of a given gengrid widget
8223 * @param obj The gengrid object.
8224 * @param w Pointer to a variable where to store the items' width.
8225 * @param h Pointer to a variable where to store the items' height.
8227 * @note Use @c NULL pointers on the size values you're not
8228 * interested in: they'll be ignored by the function.
8230 * @see elm_gengrid_item_size_get() for more details
8234 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8237 * Set the size for the group items of a given gengrid widget
8239 * @param obj The gengrid object.
8240 * @param w The group items' width.
8241 * @param h The group items' height;
8243 * A gengrid, after creation, has still no information on the size
8244 * to give to each of its cells. So, you most probably will end up
8245 * with squares one @ref Fingers "finger" wide, the default
8246 * size. Use this function to force a custom size for you group items,
8247 * making them as big as you wish.
8249 * @see elm_gengrid_group_item_size_get()
8253 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8256 * Get the size set for the group items of a given gengrid widget
8258 * @param obj The gengrid object.
8259 * @param w Pointer to a variable where to store the group items' width.
8260 * @param h Pointer to a variable where to store the group items' height.
8262 * @note Use @c NULL pointers on the size values you're not
8263 * interested in: they'll be ignored by the function.
8265 * @see elm_gengrid_group_item_size_get() for more details
8269 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8272 * Set the items grid's alignment within a given gengrid widget
8274 * @param obj The gengrid object.
8275 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8276 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8278 * This sets the alignment of the whole grid of items of a gengrid
8279 * within its given viewport. By default, those values are both
8280 * 0.5, meaning that the gengrid will have its items grid placed
8281 * exactly in the middle of its viewport.
8283 * @note If given alignment values are out of the cited ranges,
8284 * they'll be changed to the nearest boundary values on the valid
8287 * @see elm_gengrid_align_get()
8291 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8294 * Get the items grid's alignment values within a given gengrid
8297 * @param obj The gengrid object.
8298 * @param align_x Pointer to a variable where to store the
8299 * horizontal alignment.
8300 * @param align_y Pointer to a variable where to store the vertical
8303 * @note Use @c NULL pointers on the alignment values you're not
8304 * interested in: they'll be ignored by the function.
8306 * @see elm_gengrid_align_set() for more details
8310 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8313 * Set whether a given gengrid widget is or not able have items
8316 * @param obj The gengrid object
8317 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8318 * @c EINA_FALSE to turn it off
8320 * If a gengrid is set to allow reordering, a click held for more
8321 * than 0.5 over a given item will highlight it specially,
8322 * signalling the gengrid has entered the reordering state. From
8323 * that time on, the user will be able to, while still holding the
8324 * mouse button down, move the item freely in the gengrid's
8325 * viewport, replacing to said item to the locations it goes to.
8326 * The replacements will be animated and, whenever the user
8327 * releases the mouse button, the item being replaced gets a new
8328 * definitive place in the grid.
8330 * @see elm_gengrid_reorder_mode_get()
8334 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8337 * Get whether a given gengrid widget is or not able have items
8340 * @param obj The gengrid object
8341 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8344 * @see elm_gengrid_reorder_mode_set() for more details
8348 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8351 * Append a new item in a given gengrid widget.
8353 * @param obj The gengrid object.
8354 * @param gic The item class for the item.
8355 * @param data The item data.
8356 * @param func Convenience function called when the item is
8358 * @param func_data Data to be passed to @p func.
8359 * @return A handle to the item added or @c NULL, on errors.
8361 * This adds an item to the beginning of the gengrid.
8363 * @see elm_gengrid_item_prepend()
8364 * @see elm_gengrid_item_insert_before()
8365 * @see elm_gengrid_item_insert_after()
8366 * @see elm_gengrid_item_del()
8370 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);
8373 * Prepend a new item in a given gengrid widget.
8375 * @param obj The gengrid object.
8376 * @param gic The item class for the item.
8377 * @param data The item data.
8378 * @param func Convenience function called when the item is
8380 * @param func_data Data to be passed to @p func.
8381 * @return A handle to the item added or @c NULL, on errors.
8383 * This adds an item to the end of the gengrid.
8385 * @see elm_gengrid_item_append()
8386 * @see elm_gengrid_item_insert_before()
8387 * @see elm_gengrid_item_insert_after()
8388 * @see elm_gengrid_item_del()
8392 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);
8395 * Insert an item before another in a gengrid widget
8397 * @param obj The gengrid object.
8398 * @param gic The item class for the item.
8399 * @param data The item data.
8400 * @param relative The item to place this new one before.
8401 * @param func Convenience function called when the item is
8403 * @param func_data Data to be passed to @p func.
8404 * @return A handle to the item added or @c NULL, on errors.
8406 * This inserts an item before another in the gengrid.
8408 * @see elm_gengrid_item_append()
8409 * @see elm_gengrid_item_prepend()
8410 * @see elm_gengrid_item_insert_after()
8411 * @see elm_gengrid_item_del()
8415 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);
8418 * Insert an item after another in a gengrid widget
8420 * @param obj The gengrid object.
8421 * @param gic The item class for the item.
8422 * @param data The item data.
8423 * @param relative The item to place this new one after.
8424 * @param func Convenience function called when the item is
8426 * @param func_data Data to be passed to @p func.
8427 * @return A handle to the item added or @c NULL, on errors.
8429 * This inserts an item after another in the gengrid.
8431 * @see elm_gengrid_item_append()
8432 * @see elm_gengrid_item_prepend()
8433 * @see elm_gengrid_item_insert_after()
8434 * @see elm_gengrid_item_del()
8438 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);
8441 * Insert an item in a gengrid widget using a user-defined sort function.
8443 * @param obj The gengrid object.
8444 * @param gic The item class for the item.
8445 * @param data The item data.
8446 * @param comp User defined comparison function that defines the sort order based on
8447 * Elm_Gen_Item and its data param.
8448 * @param func Convenience function called when the item is selected.
8449 * @param func_data Data to be passed to @p func.
8450 * @return A handle to the item added or @c NULL, on errors.
8452 * This inserts an item in the gengrid based on user defined comparison function.
8454 * @see elm_gengrid_item_append()
8455 * @see elm_gengrid_item_prepend()
8456 * @see elm_gengrid_item_insert_after()
8457 * @see elm_gengrid_item_del()
8458 * @see elm_gengrid_item_direct_sorted_insert()
8462 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);
8465 * Insert an item in a gengrid widget using a user-defined sort function.
8467 * @param obj The gengrid object.
8468 * @param gic The item class for the item.
8469 * @param data The item data.
8470 * @param comp User defined comparison function that defines the sort order based on
8472 * @param func Convenience function called when the item is selected.
8473 * @param func_data Data to be passed to @p func.
8474 * @return A handle to the item added or @c NULL, on errors.
8476 * This inserts an item in the gengrid based on user defined comparison function.
8478 * @see elm_gengrid_item_append()
8479 * @see elm_gengrid_item_prepend()
8480 * @see elm_gengrid_item_insert_after()
8481 * @see elm_gengrid_item_del()
8482 * @see elm_gengrid_item_sorted_insert()
8486 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);
8489 * Set whether items on a given gengrid widget are to get their
8490 * selection callbacks issued for @b every subsequent selection
8491 * click on them or just for the first click.
8493 * @param obj The gengrid object
8494 * @param always_select @c EINA_TRUE to make items "always
8495 * selected", @c EINA_FALSE, otherwise
8497 * By default, grid items will only call their selection callback
8498 * function when firstly getting selected, any subsequent further
8499 * clicks will do nothing. With this call, you make those
8500 * subsequent clicks also to issue the selection callbacks.
8502 * @note <b>Double clicks</b> will @b always be reported on items.
8504 * @see elm_gengrid_always_select_mode_get()
8508 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8511 * Get whether items on a given gengrid widget have their selection
8512 * callbacks issued for @b every subsequent selection click on them
8513 * or just for the first click.
8515 * @param obj The gengrid object.
8516 * @return @c EINA_TRUE if the gengrid items are "always selected",
8517 * @c EINA_FALSE, otherwise
8519 * @see elm_gengrid_always_select_mode_set() for more details
8523 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8526 * Set whether items on a given gengrid widget can be selected or not.
8528 * @param obj The gengrid object
8529 * @param no_select @c EINA_TRUE to make items selectable,
8530 * @c EINA_FALSE otherwise
8532 * This will make items in @p obj selectable or not. In the latter
8533 * case, any user interaction on the gengrid items will neither make
8534 * them appear selected nor them call their selection callback
8537 * @see elm_gengrid_no_select_mode_get()
8541 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8544 * Get whether items on a given gengrid widget can be selected or
8547 * @param obj The gengrid object
8548 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8551 * @see elm_gengrid_no_select_mode_set() for more details
8555 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8558 * Enable or disable multi-selection in a given gengrid widget
8560 * @param obj The gengrid object.
8561 * @param multi @c EINA_TRUE, to enable multi-selection,
8562 * @c EINA_FALSE to disable it.
8564 * Multi-selection is the ability to have @b more than one
8565 * item selected, on a given gengrid, simultaneously. When it is
8566 * enabled, a sequence of clicks on different items will make them
8567 * all selected, progressively. A click on an already selected item
8568 * will unselect it. If interacting via the keyboard,
8569 * multi-selection is enabled while holding the "Shift" key.
8571 * @note By default, multi-selection is @b disabled on gengrids
8573 * @see elm_gengrid_multi_select_get()
8577 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8580 * Get whether multi-selection is enabled or disabled for a given
8583 * @param obj The gengrid object.
8584 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8585 * EINA_FALSE otherwise
8587 * @see elm_gengrid_multi_select_set() for more details
8591 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8594 * Enable or disable bouncing effect for a given gengrid widget
8596 * @param obj The gengrid object
8597 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8598 * @c EINA_FALSE to disable it
8599 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8600 * @c EINA_FALSE to disable it
8602 * The bouncing effect occurs whenever one reaches the gengrid's
8603 * edge's while panning it -- it will scroll past its limits a
8604 * little bit and return to the edge again, in a animated for,
8607 * @note By default, gengrids have bouncing enabled on both axis
8609 * @see elm_gengrid_bounce_get()
8613 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8616 * Get whether bouncing effects are enabled or disabled, for a
8617 * given gengrid widget, on each axis
8619 * @param obj The gengrid object
8620 * @param h_bounce Pointer to a variable where to store the
8621 * horizontal bouncing flag.
8622 * @param v_bounce Pointer to a variable where to store the
8623 * vertical bouncing flag.
8625 * @see elm_gengrid_bounce_set() for more details
8629 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8632 * Set a given gengrid widget's scrolling page size, relative to
8633 * its viewport size.
8635 * @param obj The gengrid object
8636 * @param h_pagerel The horizontal page (relative) size
8637 * @param v_pagerel The vertical page (relative) size
8639 * The gengrid's scroller is capable of binding scrolling by the
8640 * user to "pages". It means that, while scrolling and, specially
8641 * after releasing the mouse button, the grid will @b snap to the
8642 * nearest displaying page's area. When page sizes are set, the
8643 * grid's continuous content area is split into (equal) page sized
8646 * This function sets the size of a page <b>relatively to the
8647 * viewport dimensions</b> of the gengrid, for each axis. A value
8648 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8649 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8650 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8651 * 1.0. Values beyond those will make it behave behave
8652 * inconsistently. If you only want one axis to snap to pages, use
8653 * the value @c 0.0 for the other one.
8655 * There is a function setting page size values in @b absolute
8656 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8657 * is mutually exclusive to this one.
8659 * @see elm_gengrid_page_relative_get()
8663 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8666 * Get a given gengrid widget's scrolling page size, relative to
8667 * its viewport size.
8669 * @param obj The gengrid object
8670 * @param h_pagerel Pointer to a variable where to store the
8671 * horizontal page (relative) size
8672 * @param v_pagerel Pointer to a variable where to store the
8673 * vertical page (relative) size
8675 * @see elm_gengrid_page_relative_set() for more details
8679 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8682 * Set a given gengrid widget's scrolling page size
8684 * @param obj The gengrid object
8685 * @param h_pagerel The horizontal page size, in pixels
8686 * @param v_pagerel The vertical page size, in pixels
8688 * The gengrid's scroller is capable of binding scrolling by the
8689 * user to "pages". It means that, while scrolling and, specially
8690 * after releasing the mouse button, the grid will @b snap to the
8691 * nearest displaying page's area. When page sizes are set, the
8692 * grid's continuous content area is split into (equal) page sized
8695 * This function sets the size of a page of the gengrid, in pixels,
8696 * for each axis. Sane usable values are, between @c 0 and the
8697 * dimensions of @p obj, for each axis. Values beyond those will
8698 * make it behave behave inconsistently. If you only want one axis
8699 * to snap to pages, use the value @c 0 for the other one.
8701 * There is a function setting page size values in @b relative
8702 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8703 * use is mutually exclusive to this one.
8707 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8710 * @brief Get gengrid current page number.
8712 * @param obj The gengrid object
8713 * @param h_pagenumber The horizontal page number
8714 * @param v_pagenumber The vertical page number
8716 * The page number starts from 0. 0 is the first page.
8717 * Current page means the page which meet the top-left of the viewport.
8718 * If there are two or more pages in the viewport, it returns the number of page
8719 * which meet the top-left of the viewport.
8721 * @see elm_gengrid_last_page_get()
8722 * @see elm_gengrid_page_show()
8723 * @see elm_gengrid_page_brint_in()
8725 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8728 * @brief Get scroll last page number.
8730 * @param obj The gengrid object
8731 * @param h_pagenumber The horizontal page number
8732 * @param v_pagenumber The vertical page number
8734 * The page number starts from 0. 0 is the first page.
8735 * This returns the last page number among the pages.
8737 * @see elm_gengrid_current_page_get()
8738 * @see elm_gengrid_page_show()
8739 * @see elm_gengrid_page_brint_in()
8741 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8744 * Show a specific virtual region within the gengrid content object by page number.
8746 * @param obj The gengrid object
8747 * @param h_pagenumber The horizontal page number
8748 * @param v_pagenumber The vertical page number
8750 * 0, 0 of the indicated page is located at the top-left of the viewport.
8751 * This will jump to the page directly without animation.
8756 * sc = elm_gengrid_add(win);
8757 * elm_gengrid_content_set(sc, content);
8758 * elm_gengrid_page_relative_set(sc, 1, 0);
8759 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8760 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8763 * @see elm_gengrid_page_bring_in()
8765 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8768 * Show a specific virtual region within the gengrid content object by page number.
8770 * @param obj The gengrid object
8771 * @param h_pagenumber The horizontal page number
8772 * @param v_pagenumber The vertical page number
8774 * 0, 0 of the indicated page is located at the top-left of the viewport.
8775 * This will slide to the page with animation.
8780 * sc = elm_gengrid_add(win);
8781 * elm_gengrid_content_set(sc, content);
8782 * elm_gengrid_page_relative_set(sc, 1, 0);
8783 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8784 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8787 * @see elm_gengrid_page_show()
8789 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8792 * Set the direction in which a given gengrid widget will expand while
8793 * placing its items.
8795 * @param obj The gengrid object.
8796 * @param setting @c EINA_TRUE to make the gengrid expand
8797 * horizontally, @c EINA_FALSE to expand vertically.
8799 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8800 * in @b columns, from top to bottom and, when the space for a
8801 * column is filled, another one is started on the right, thus
8802 * expanding the grid horizontally. When in "vertical mode"
8803 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8804 * to right and, when the space for a row is filled, another one is
8805 * started below, thus expanding the grid vertically.
8807 * @see elm_gengrid_horizontal_get()
8811 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8814 * Get for what direction a given gengrid widget will expand while
8815 * placing its items.
8817 * @param obj The gengrid object.
8818 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8819 * @c EINA_FALSE if it's set to expand vertically.
8821 * @see elm_gengrid_horizontal_set() for more detais
8825 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8828 * Get the first item in a given gengrid widget
8830 * @param obj The gengrid object
8831 * @return The first item's handle or @c NULL, if there are no
8832 * items in @p obj (and on errors)
8834 * This returns the first item in the @p obj's internal list of
8837 * @see elm_gengrid_last_item_get()
8841 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8844 * Get the last item in a given gengrid widget
8846 * @param obj The gengrid object
8847 * @return The last item's handle or @c NULL, if there are no
8848 * items in @p obj (and on errors)
8850 * This returns the last item in the @p obj's internal list of
8853 * @see elm_gengrid_first_item_get()
8857 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8860 * Get the @b next item in a gengrid widget's internal list of items,
8861 * given a handle to one of those items.
8863 * @param item The gengrid item to fetch next from
8864 * @return The item after @p item, or @c NULL if there's none (and
8867 * This returns the item placed after the @p item, on the container
8870 * @see elm_gengrid_item_prev_get()
8874 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8877 * Get the @b previous item in a gengrid widget's internal list of items,
8878 * given a handle to one of those items.
8880 * @param item The gengrid item to fetch previous from
8881 * @return The item before @p item, or @c NULL if there's none (and
8884 * This returns the item placed before the @p item, on the container
8887 * @see elm_gengrid_item_next_get()
8891 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8894 * Get the gengrid object's handle which contains a given gengrid
8897 * @param item The item to fetch the container from
8898 * @return The gengrid (parent) object
8900 * This returns the gengrid object itself that an item belongs to.
8904 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8907 * Remove a gengrid item from its parent, deleting it.
8909 * @param item The item to be removed.
8910 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8912 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8917 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8920 * Update the contents of a given gengrid item
8922 * @param item The gengrid item
8924 * This updates an item by calling all the item class functions
8925 * again to get the contents, labels and states. Use this when the
8926 * original item data has changed and you want the changes to be
8931 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8934 * Get the Gengrid Item class for the given Gengrid Item.
8936 * @param item The gengrid item
8938 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8939 * the function pointers and item_style.
8943 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8946 * Get the Gengrid Item class for the given Gengrid Item.
8948 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8949 * the function pointers and item_style.
8951 * @param item The gengrid item
8952 * @param gic The gengrid item class describing the function pointers and the item style.
8956 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8959 * Return the data associated to a given gengrid item
8961 * @param item The gengrid item.
8962 * @return the data associated with this item.
8964 * This returns the @c data value passed on the
8965 * elm_gengrid_item_append() and related item addition calls.
8967 * @see elm_gengrid_item_append()
8968 * @see elm_gengrid_item_data_set()
8972 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8975 * Set the data associated with a given gengrid item
8977 * @param item The gengrid item
8978 * @param data The data pointer to set on it
8980 * This @b overrides the @c data value passed on the
8981 * elm_gengrid_item_append() and related item addition calls. This
8982 * function @b won't call elm_gengrid_item_update() automatically,
8983 * so you'd issue it afterwards if you want to have the item
8984 * updated to reflect the new data.
8986 * @see elm_gengrid_item_data_get()
8987 * @see elm_gengrid_item_update()
8991 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8994 * Get a given gengrid item's position, relative to the whole
8995 * gengrid's grid area.
8997 * @param item The Gengrid item.
8998 * @param x Pointer to variable to store the item's <b>row number</b>.
8999 * @param y Pointer to variable to store the item's <b>column number</b>.
9001 * This returns the "logical" position of the item within the
9002 * gengrid. For example, @c (0, 1) would stand for first row,
9007 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9010 * Set whether a given gengrid item is selected or not
9012 * @param item The gengrid item
9013 * @param selected Use @c EINA_TRUE, to make it selected, @c
9014 * EINA_FALSE to make it unselected
9016 * This sets the selected state of an item. If multi-selection is
9017 * not enabled on the containing gengrid and @p selected is @c
9018 * EINA_TRUE, any other previously selected items will get
9019 * unselected in favor of this new one.
9021 * @see elm_gengrid_item_selected_get()
9025 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9028 * Get whether a given gengrid item is selected or not
9030 * @param item The gengrid item
9031 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9033 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9035 * @see elm_gengrid_item_selected_set() for more details
9039 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9042 * Get the real Evas object created to implement the view of a
9043 * given gengrid item
9045 * @param item The gengrid item.
9046 * @return the Evas object implementing this item's view.
9048 * This returns the actual Evas object used to implement the
9049 * specified gengrid item's view. This may be @c NULL, as it may
9050 * not have been created or may have been deleted, at any time, by
9051 * the gengrid. <b>Do not modify this object</b> (move, resize,
9052 * show, hide, etc.), as the gengrid is controlling it. This
9053 * function is for querying, emitting custom signals or hooking
9054 * lower level callbacks for events on that object. Do not delete
9055 * this object under any circumstances.
9057 * @see elm_gengrid_item_data_get()
9061 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9064 * Show the portion of a gengrid's internal grid containing a given
9065 * item, @b immediately.
9067 * @param item The item to display
9069 * This causes gengrid to @b redraw its viewport's contents to the
9070 * region contining the given @p item item, if it is not fully
9073 * @see elm_gengrid_item_bring_in()
9077 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9080 * Animatedly bring in, to the visible area of a gengrid, a given
9083 * @param item The gengrid item to display
9085 * This causes gengrid to jump to the given @p item and show
9086 * it (by scrolling), if it is not fully visible. This will use
9087 * animation to do so and take a period of time to complete.
9089 * @see elm_gengrid_item_show()
9093 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9096 * Set whether a given gengrid item is disabled or not.
9098 * @param item The gengrid item
9099 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9100 * to enable it back.
9102 * A disabled item cannot be selected or unselected. It will also
9103 * change its appearance, to signal the user it's disabled.
9105 * @see elm_gengrid_item_disabled_get()
9109 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9112 * Get whether a given gengrid item is disabled or not.
9114 * @param item The gengrid item
9115 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9118 * @see elm_gengrid_item_disabled_set() for more details
9122 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9125 * Set the text to be shown in a given gengrid item's tooltips.
9127 * @param item The gengrid item
9128 * @param text The text to set in the content
9130 * This call will setup the text to be used as tooltip to that item
9131 * (analogous to elm_object_tooltip_text_set(), but being item
9132 * tooltips with higher precedence than object tooltips). It can
9133 * have only one tooltip at a time, so any previous tooltip data
9138 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9141 * Set the content to be shown in a given gengrid item's tooltip
9143 * @param item The gengrid item.
9144 * @param func The function returning the tooltip contents.
9145 * @param data What to provide to @a func as callback data/context.
9146 * @param del_cb Called when data is not needed anymore, either when
9147 * another callback replaces @p func, the tooltip is unset with
9148 * elm_gengrid_item_tooltip_unset() or the owner @p item
9149 * dies. This callback receives as its first parameter the
9150 * given @p data, being @c event_info the item handle.
9152 * This call will setup the tooltip's contents to @p item
9153 * (analogous to elm_object_tooltip_content_cb_set(), but being
9154 * item tooltips with higher precedence than object tooltips). It
9155 * can have only one tooltip at a time, so any previous tooltip
9156 * content will get removed. @p func (with @p data) will be called
9157 * every time Elementary needs to show the tooltip and it should
9158 * return a valid Evas object, which will be fully managed by the
9159 * tooltip system, getting deleted when the tooltip is gone.
9163 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);
9166 * Unset a tooltip from a given gengrid item
9168 * @param item gengrid item to remove a previously set tooltip from.
9170 * This call removes any tooltip set on @p item. The callback
9171 * provided as @c del_cb to
9172 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9173 * notify it is not used anymore (and have resources cleaned, if
9176 * @see elm_gengrid_item_tooltip_content_cb_set()
9180 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9183 * Set a different @b style for a given gengrid item's tooltip.
9185 * @param item gengrid item with tooltip set
9186 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9187 * "default", @c "transparent", etc)
9189 * Tooltips can have <b>alternate styles</b> to be displayed on,
9190 * which are defined by the theme set on Elementary. This function
9191 * works analogously as elm_object_tooltip_style_set(), but here
9192 * applied only to gengrid item objects. The default style for
9193 * tooltips is @c "default".
9195 * @note before you set a style you should define a tooltip with
9196 * elm_gengrid_item_tooltip_content_cb_set() or
9197 * elm_gengrid_item_tooltip_text_set()
9199 * @see elm_gengrid_item_tooltip_style_get()
9203 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9206 * Get the style set a given gengrid item's tooltip.
9208 * @param item gengrid item with tooltip already set on.
9209 * @return style the theme style in use, which defaults to
9210 * "default". If the object does not have a tooltip set,
9211 * then @c NULL is returned.
9213 * @see elm_gengrid_item_tooltip_style_set() for more details
9217 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9219 * @brief Disable size restrictions on an object's tooltip
9220 * @param item The tooltip's anchor object
9221 * @param disable If EINA_TRUE, size restrictions are disabled
9222 * @return EINA_FALSE on failure, EINA_TRUE on success
9224 * This function allows a tooltip to expand beyond its parant window's canvas.
9225 * It will instead be limited only by the size of the display.
9227 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9229 * @brief Retrieve size restriction state of an object's tooltip
9230 * @param item The tooltip's anchor object
9231 * @return If EINA_TRUE, size restrictions are disabled
9233 * This function returns whether a tooltip is allowed to expand beyond
9234 * its parant window's canvas.
9235 * It will instead be limited only by the size of the display.
9237 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9239 * Set the type of mouse pointer/cursor decoration to be shown,
9240 * when the mouse pointer is over the given gengrid widget item
9242 * @param item gengrid item to customize cursor on
9243 * @param cursor the cursor type's name
9245 * This function works analogously as elm_object_cursor_set(), but
9246 * here the cursor's changing area is restricted to the item's
9247 * area, and not the whole widget's. Note that that item cursors
9248 * have precedence over widget cursors, so that a mouse over @p
9249 * item will always show cursor @p type.
9251 * If this function is called twice for an object, a previously set
9252 * cursor will be unset on the second call.
9254 * @see elm_object_cursor_set()
9255 * @see elm_gengrid_item_cursor_get()
9256 * @see elm_gengrid_item_cursor_unset()
9260 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9263 * Get the type of mouse pointer/cursor decoration set to be shown,
9264 * when the mouse pointer is over the given gengrid widget item
9266 * @param item gengrid item with custom cursor set
9267 * @return the cursor type's name or @c NULL, if no custom cursors
9268 * were set to @p item (and on errors)
9270 * @see elm_object_cursor_get()
9271 * @see elm_gengrid_item_cursor_set() for more details
9272 * @see elm_gengrid_item_cursor_unset()
9276 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9279 * Unset any custom mouse pointer/cursor decoration set to be
9280 * shown, when the mouse pointer is over the given gengrid widget
9281 * item, thus making it show the @b default cursor again.
9283 * @param item a gengrid item
9285 * Use this call to undo any custom settings on this item's cursor
9286 * decoration, bringing it back to defaults (no custom style set).
9288 * @see elm_object_cursor_unset()
9289 * @see elm_gengrid_item_cursor_set() for more details
9293 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9296 * Set a different @b style for a given custom cursor set for a
9299 * @param item gengrid item with custom cursor set
9300 * @param style the <b>theme style</b> to use (e.g. @c "default",
9301 * @c "transparent", etc)
9303 * This function only makes sense when one is using custom mouse
9304 * cursor decorations <b>defined in a theme file</b> , which can
9305 * have, given a cursor name/type, <b>alternate styles</b> on
9306 * it. It works analogously as elm_object_cursor_style_set(), but
9307 * here applied only to gengrid item objects.
9309 * @warning Before you set a cursor style you should have defined a
9310 * custom cursor previously on the item, with
9311 * elm_gengrid_item_cursor_set()
9313 * @see elm_gengrid_item_cursor_engine_only_set()
9314 * @see elm_gengrid_item_cursor_style_get()
9318 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9321 * Get the current @b style set for a given gengrid item's custom
9324 * @param item gengrid item with custom cursor set.
9325 * @return style the cursor style in use. If the object does not
9326 * have a cursor set, then @c NULL is returned.
9328 * @see elm_gengrid_item_cursor_style_set() for more details
9332 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9335 * Set if the (custom) cursor for a given gengrid item should be
9336 * searched in its theme, also, or should only rely on the
9339 * @param item item with custom (custom) cursor already set on
9340 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9341 * only on those provided by the rendering engine, @c EINA_FALSE to
9342 * have them searched on the widget's theme, as well.
9344 * @note This call is of use only if you've set a custom cursor
9345 * for gengrid items, with elm_gengrid_item_cursor_set().
9347 * @note By default, cursors will only be looked for between those
9348 * provided by the rendering engine.
9352 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9355 * Get if the (custom) cursor for a given gengrid item is being
9356 * searched in its theme, also, or is only relying on the rendering
9359 * @param item a gengrid item
9360 * @return @c EINA_TRUE, if cursors are being looked for only on
9361 * those provided by the rendering engine, @c EINA_FALSE if they
9362 * are being searched on the widget's theme, as well.
9364 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9368 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9371 * Remove all items from a given gengrid widget
9373 * @param obj The gengrid object.
9375 * This removes (and deletes) all items in @p obj, leaving it
9378 * @see elm_gengrid_item_del(), to remove just one item.
9382 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9385 * Get the selected item in a given gengrid widget
9387 * @param obj The gengrid object.
9388 * @return The selected item's handleor @c NULL, if none is
9389 * selected at the moment (and on errors)
9391 * This returns the selected item in @p obj. If multi selection is
9392 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9393 * the first item in the list is selected, which might not be very
9394 * useful. For that case, see elm_gengrid_selected_items_get().
9398 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9401 * Get <b>a list</b> of selected items in a given gengrid
9403 * @param obj The gengrid object.
9404 * @return The list of selected items or @c NULL, if none is
9405 * selected at the moment (and on errors)
9407 * This returns a list of the selected items, in the order that
9408 * they appear in the grid. This list is only valid as long as no
9409 * more items are selected or unselected (or unselected implictly
9410 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9413 * @see elm_gengrid_selected_item_get()
9417 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9424 * @defgroup Clock Clock
9426 * @image html img/widget/clock/preview-00.png
9427 * @image latex img/widget/clock/preview-00.eps
9429 * This is a @b digital clock widget. In its default theme, it has a
9430 * vintage "flipping numbers clock" appearance, which will animate
9431 * sheets of individual algarisms individually as time goes by.
9433 * A newly created clock will fetch system's time (already
9434 * considering local time adjustments) to start with, and will tick
9435 * accondingly. It may or may not show seconds.
9437 * Clocks have an @b edition mode. When in it, the sheets will
9438 * display extra arrow indications on the top and bottom and the
9439 * user may click on them to raise or lower the time values. After
9440 * it's told to exit edition mode, it will keep ticking with that
9441 * new time set (it keeps the difference from local time).
9443 * Also, when under edition mode, user clicks on the cited arrows
9444 * which are @b held for some time will make the clock to flip the
9445 * sheet, thus editing the time, continuosly and automatically for
9446 * the user. The interval between sheet flips will keep growing in
9447 * time, so that it helps the user to reach a time which is distant
9450 * The time display is, by default, in military mode (24h), but an
9451 * am/pm indicator may be optionally shown, too, when it will
9454 * Smart callbacks one can register to:
9455 * - "changed" - the clock's user changed the time
9457 * Here is an example on its usage:
9458 * @li @ref clock_example
9467 * Identifiers for which clock digits should be editable, when a
9468 * clock widget is in edition mode. Values may be ORed together to
9469 * make a mask, naturally.
9471 * @see elm_clock_edit_set()
9472 * @see elm_clock_digit_edit_set()
9474 typedef enum _Elm_Clock_Digedit
9476 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9477 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9478 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9479 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9480 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9481 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9482 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9483 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9484 } Elm_Clock_Digedit;
9487 * Add a new clock widget to the given parent Elementary
9488 * (container) object
9490 * @param parent The parent object
9491 * @return a new clock widget handle or @c NULL, on errors
9493 * This function inserts a new clock widget on the canvas.
9497 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9500 * Set a clock widget's time, programmatically
9502 * @param obj The clock widget object
9503 * @param hrs The hours to set
9504 * @param min The minutes to set
9505 * @param sec The secondes to set
9507 * This function updates the time that is showed by the clock
9510 * Values @b must be set within the following ranges:
9511 * - 0 - 23, for hours
9512 * - 0 - 59, for minutes
9513 * - 0 - 59, for seconds,
9515 * even if the clock is not in "military" mode.
9517 * @warning The behavior for values set out of those ranges is @b
9522 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9525 * Get a clock widget's time values
9527 * @param obj The clock object
9528 * @param[out] hrs Pointer to the variable to get the hours value
9529 * @param[out] min Pointer to the variable to get the minutes value
9530 * @param[out] sec Pointer to the variable to get the seconds value
9532 * This function gets the time set for @p obj, returning
9533 * it on the variables passed as the arguments to function
9535 * @note Use @c NULL pointers on the time values you're not
9536 * interested in: they'll be ignored by the function.
9540 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9543 * Set whether a given clock widget is under <b>edition mode</b> or
9544 * under (default) displaying-only mode.
9546 * @param obj The clock object
9547 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9548 * put it back to "displaying only" mode
9550 * This function makes a clock's time to be editable or not <b>by
9551 * user interaction</b>. When in edition mode, clocks @b stop
9552 * ticking, until one brings them back to canonical mode. The
9553 * elm_clock_digit_edit_set() function will influence which digits
9554 * of the clock will be editable. By default, all of them will be
9555 * (#ELM_CLOCK_NONE).
9557 * @note am/pm sheets, if being shown, will @b always be editable
9558 * under edition mode.
9560 * @see elm_clock_edit_get()
9564 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9567 * Retrieve whether a given clock widget is under <b>edition
9568 * mode</b> or under (default) displaying-only mode.
9570 * @param obj The clock object
9571 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9574 * This function retrieves whether the clock's time can be edited
9575 * or not by user interaction.
9577 * @see elm_clock_edit_set() for more details
9581 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9584 * Set what digits of the given clock widget should be editable
9585 * when in edition mode.
9587 * @param obj The clock object
9588 * @param digedit Bit mask indicating the digits to be editable
9589 * (values in #Elm_Clock_Digedit).
9591 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9592 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9595 * @see elm_clock_digit_edit_get()
9599 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9602 * Retrieve what digits of the given clock widget should be
9603 * editable when in edition mode.
9605 * @param obj The clock object
9606 * @return Bit mask indicating the digits to be editable
9607 * (values in #Elm_Clock_Digedit).
9609 * @see elm_clock_digit_edit_set() for more details
9613 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9616 * Set if the given clock widget must show hours in military or
9619 * @param obj The clock object
9620 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9623 * This function sets if the clock must show hours in military or
9624 * am/pm mode. In some countries like Brazil the military mode
9625 * (00-24h-format) is used, in opposition to the USA, where the
9626 * am/pm mode is more commonly used.
9628 * @see elm_clock_show_am_pm_get()
9632 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9635 * Get if the given clock widget shows hours in military or am/pm
9638 * @param obj The clock object
9639 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9642 * This function gets if the clock shows hours in military or am/pm
9645 * @see elm_clock_show_am_pm_set() for more details
9649 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9652 * Set if the given clock widget must show time with seconds or not
9654 * @param obj The clock object
9655 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9657 * This function sets if the given clock must show or not elapsed
9658 * seconds. By default, they are @b not shown.
9660 * @see elm_clock_show_seconds_get()
9664 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9667 * Get whether the given clock widget is showing time with seconds
9670 * @param obj The clock object
9671 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9673 * This function gets whether @p obj is showing or not the elapsed
9676 * @see elm_clock_show_seconds_set()
9680 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9683 * Set the interval on time updates for an user mouse button hold
9684 * on clock widgets' time edition.
9686 * @param obj The clock object
9687 * @param interval The (first) interval value in seconds
9689 * This interval value is @b decreased while the user holds the
9690 * mouse pointer either incrementing or decrementing a given the
9691 * clock digit's value.
9693 * This helps the user to get to a given time distant from the
9694 * current one easier/faster, as it will start to flip quicker and
9695 * quicker on mouse button holds.
9697 * The calculation for the next flip interval value, starting from
9698 * the one set with this call, is the previous interval divided by
9699 * 1.05, so it decreases a little bit.
9701 * The default starting interval value for automatic flips is
9704 * @see elm_clock_interval_get()
9708 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9711 * Get the interval on time updates for an user mouse button hold
9712 * on clock widgets' time edition.
9714 * @param obj The clock object
9715 * @return The (first) interval value, in seconds, set on it
9717 * @see elm_clock_interval_set() for more details
9721 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9728 * @defgroup Layout Layout
9730 * @image html img/widget/layout/preview-00.png
9731 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9733 * @image html img/layout-predefined.png
9734 * @image latex img/layout-predefined.eps width=\textwidth
9736 * This is a container widget that takes a standard Edje design file and
9737 * wraps it very thinly in a widget.
9739 * An Edje design (theme) file has a very wide range of possibilities to
9740 * describe the behavior of elements added to the Layout. Check out the Edje
9741 * documentation and the EDC reference to get more information about what can
9742 * be done with Edje.
9744 * Just like @ref List, @ref Box, and other container widgets, any
9745 * object added to the Layout will become its child, meaning that it will be
9746 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9748 * The Layout widget can contain as many Contents, Boxes or Tables as
9749 * described in its theme file. For instance, objects can be added to
9750 * different Tables by specifying the respective Table part names. The same
9751 * is valid for Content and Box.
9753 * The objects added as child of the Layout will behave as described in the
9754 * part description where they were added. There are 3 possible types of
9755 * parts where a child can be added:
9757 * @section secContent Content (SWALLOW part)
9759 * Only one object can be added to the @c SWALLOW part (but you still can
9760 * have many @c SWALLOW parts and one object on each of them). Use the @c
9761 * elm_object_content_set/get/unset functions to set, retrieve and unset
9762 * objects as content of the @c SWALLOW. After being set to this part, the
9763 * object size, position, visibility, clipping and other description
9764 * properties will be totally controled by the description of the given part
9765 * (inside the Edje theme file).
9767 * One can use @c evas_object_size_hint_* functions on the child to have some
9768 * kind of control over its behavior, but the resulting behavior will still
9769 * depend heavily on the @c SWALLOW part description.
9771 * The Edje theme also can change the part description, based on signals or
9772 * scripts running inside the theme. This change can also be animated. All of
9773 * this will affect the child object set as content accordingly. The object
9774 * size will be changed if the part size is changed, it will animate move if
9775 * the part is moving, and so on.
9777 * The following picture demonstrates a Layout widget with a child object
9778 * added to its @c SWALLOW:
9780 * @image html layout_swallow.png
9781 * @image latex layout_swallow.eps width=\textwidth
9783 * @section secBox Box (BOX part)
9785 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9786 * allows one to add objects to the box and have them distributed along its
9787 * area, accordingly to the specified @a layout property (now by @a layout we
9788 * mean the chosen layouting design of the Box, not the Layout widget
9791 * A similar effect for having a box with its position, size and other things
9792 * controled by the Layout theme would be to create an Elementary @ref Box
9793 * widget and add it as a Content in the @c SWALLOW part.
9795 * The main difference of using the Layout Box is that its behavior, the box
9796 * properties like layouting format, padding, align, etc. will be all
9797 * controled by the theme. This means, for example, that a signal could be
9798 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9799 * handled the signal by changing the box padding, or align, or both. Using
9800 * the Elementary @ref Box widget is not necessarily harder or easier, it
9801 * just depends on the circunstances and requirements.
9803 * The Layout Box can be used through the @c elm_layout_box_* set of
9806 * The following picture demonstrates a Layout widget with many child objects
9807 * added to its @c BOX part:
9809 * @image html layout_box.png
9810 * @image latex layout_box.eps width=\textwidth
9812 * @section secTable Table (TABLE part)
9814 * Just like the @ref secBox, the Layout Table is very similar to the
9815 * Elementary @ref Table widget. It allows one to add objects to the Table
9816 * specifying the row and column where the object should be added, and any
9817 * column or row span if necessary.
9819 * Again, we could have this design by adding a @ref Table widget to the @c
9820 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9821 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9822 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9824 * The Layout Table can be used through the @c elm_layout_table_* set of
9827 * The following picture demonstrates a Layout widget with many child objects
9828 * added to its @c TABLE part:
9830 * @image html layout_table.png
9831 * @image latex layout_table.eps width=\textwidth
9833 * @section secPredef Predefined Layouts
9835 * Another interesting thing about the Layout widget is that it offers some
9836 * predefined themes that come with the default Elementary theme. These
9837 * themes can be set by the call elm_layout_theme_set(), and provide some
9838 * basic functionality depending on the theme used.
9840 * Most of them already send some signals, some already provide a toolbar or
9841 * back and next buttons.
9843 * These are available predefined theme layouts. All of them have class = @c
9844 * layout, group = @c application, and style = one of the following options:
9846 * @li @c toolbar-content - application with toolbar and main content area
9847 * @li @c toolbar-content-back - application with toolbar and main content
9848 * area with a back button and title area
9849 * @li @c toolbar-content-back-next - application with toolbar and main
9850 * content area with a back and next buttons and title area
9851 * @li @c content-back - application with a main content area with a back
9852 * button and title area
9853 * @li @c content-back-next - application with a main content area with a
9854 * back and next buttons and title area
9855 * @li @c toolbar-vbox - application with toolbar and main content area as a
9857 * @li @c toolbar-table - application with toolbar and main content area as a
9860 * @section secExamples Examples
9862 * Some examples of the Layout widget can be found here:
9863 * @li @ref layout_example_01
9864 * @li @ref layout_example_02
9865 * @li @ref layout_example_03
9866 * @li @ref layout_example_edc
9871 * Add a new layout to the parent
9873 * @param parent The parent object
9874 * @return The new object or NULL if it cannot be created
9876 * @see elm_layout_file_set()
9877 * @see elm_layout_theme_set()
9881 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9883 * Set the file that will be used as layout
9885 * @param obj The layout object
9886 * @param file The path to file (edj) that will be used as layout
9887 * @param group The group that the layout belongs in edje file
9889 * @return (1 = success, 0 = error)
9893 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9895 * Set the edje group from the elementary theme that will be used as layout
9897 * @param obj The layout object
9898 * @param clas the clas of the group
9899 * @param group the group
9900 * @param style the style to used
9902 * @return (1 = success, 0 = error)
9906 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9908 * Set the layout content.
9910 * @param obj The layout object
9911 * @param swallow The swallow part name in the edje file
9912 * @param content The child that will be added in this layout object
9914 * Once the content object is set, a previously set one will be deleted.
9915 * If you want to keep that old content object, use the
9916 * elm_object_content_part_unset() function.
9918 * @note In an Edje theme, the part used as a content container is called @c
9919 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9920 * expected to be a part name just like the second parameter of
9921 * elm_layout_box_append().
9923 * @see elm_layout_box_append()
9924 * @see elm_object_content_part_get()
9925 * @see elm_object_content_part_unset()
9927 * @deprecated use elm_object_content_part_set() instead
9931 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9933 * Get the child object in the given content part.
9935 * @param obj The layout object
9936 * @param swallow The SWALLOW part to get its content
9938 * @return The swallowed object or NULL if none or an error occurred
9940 * @deprecated use elm_object_content_part_get() instead
9944 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9946 * Unset the layout content.
9948 * @param obj The layout object
9949 * @param swallow The swallow part name in the edje file
9950 * @return The content that was being used
9952 * Unparent and return the content object which was set for this part.
9954 * @deprecated use elm_object_content_part_unset() instead
9958 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9960 * Set the text of the given part
9962 * @param obj The layout object
9963 * @param part The TEXT part where to set the text
9964 * @param text The text to set
9967 * @deprecated use elm_object_part_text_set() instead.
9969 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9971 * Get the text set in the given part
9973 * @param obj The layout object
9974 * @param part The TEXT part to retrieve the text off
9976 * @return The text set in @p part
9979 * @deprecated use elm_object_part_text_get() instead.
9981 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9983 * Append child to layout box part.
9985 * @param obj the layout object
9986 * @param part the box part to which the object will be appended.
9987 * @param child the child object to append to box.
9989 * Once the object is appended, it will become child of the layout. Its
9990 * lifetime will be bound to the layout, whenever the layout dies the child
9991 * will be deleted automatically. One should use elm_layout_box_remove() to
9992 * make this layout forget about the object.
9994 * @see elm_layout_box_prepend()
9995 * @see elm_layout_box_insert_before()
9996 * @see elm_layout_box_insert_at()
9997 * @see elm_layout_box_remove()
10001 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10003 * Prepend child to layout box part.
10005 * @param obj the layout object
10006 * @param part the box part to prepend.
10007 * @param child the child object to prepend to box.
10009 * Once the object is prepended, it will become child of the layout. Its
10010 * lifetime will be bound to the layout, whenever the layout dies the child
10011 * will be deleted automatically. One should use elm_layout_box_remove() to
10012 * make this layout forget about the object.
10014 * @see elm_layout_box_append()
10015 * @see elm_layout_box_insert_before()
10016 * @see elm_layout_box_insert_at()
10017 * @see elm_layout_box_remove()
10021 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10023 * Insert child to layout box part before a reference object.
10025 * @param obj the layout object
10026 * @param part the box part to insert.
10027 * @param child the child object to insert into box.
10028 * @param reference another reference object to insert before in box.
10030 * Once the object is inserted, it will become child of the layout. Its
10031 * lifetime will be bound to the layout, whenever the layout dies the child
10032 * will be deleted automatically. One should use elm_layout_box_remove() to
10033 * make this layout forget about the object.
10035 * @see elm_layout_box_append()
10036 * @see elm_layout_box_prepend()
10037 * @see elm_layout_box_insert_before()
10038 * @see elm_layout_box_remove()
10042 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10044 * Insert child to layout box part at a given position.
10046 * @param obj the layout object
10047 * @param part the box part to insert.
10048 * @param child the child object to insert into box.
10049 * @param pos the numeric position >=0 to insert the child.
10051 * Once the object is inserted, it will become child of the layout. Its
10052 * lifetime will be bound to the layout, whenever the layout dies the child
10053 * will be deleted automatically. One should use elm_layout_box_remove() to
10054 * make this layout forget about the object.
10056 * @see elm_layout_box_append()
10057 * @see elm_layout_box_prepend()
10058 * @see elm_layout_box_insert_before()
10059 * @see elm_layout_box_remove()
10063 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10065 * Remove a child of the given part box.
10067 * @param obj The layout object
10068 * @param part The box part name to remove child.
10069 * @param child The object to remove from box.
10070 * @return The object that was being used, or NULL if not found.
10072 * The object will be removed from the box part and its lifetime will
10073 * not be handled by the layout anymore. This is equivalent to
10074 * elm_object_content_part_unset() for box.
10076 * @see elm_layout_box_append()
10077 * @see elm_layout_box_remove_all()
10081 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10083 * Remove all child of the given part box.
10085 * @param obj The layout object
10086 * @param part The box part name to remove child.
10087 * @param clear If EINA_TRUE, then all objects will be deleted as
10088 * well, otherwise they will just be removed and will be
10089 * dangling on the canvas.
10091 * The objects will be removed from the box part and their lifetime will
10092 * not be handled by the layout anymore. This is equivalent to
10093 * elm_layout_box_remove() for all box children.
10095 * @see elm_layout_box_append()
10096 * @see elm_layout_box_remove()
10100 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10102 * Insert child to layout table part.
10104 * @param obj the layout object
10105 * @param part the box part to pack child.
10106 * @param child_obj the child object to pack into table.
10107 * @param col the column to which the child should be added. (>= 0)
10108 * @param row the row to which the child should be added. (>= 0)
10109 * @param colspan how many columns should be used to store this object. (>=
10111 * @param rowspan how many rows should be used to store this object. (>= 1)
10113 * Once the object is inserted, it will become child of the table. Its
10114 * lifetime will be bound to the layout, and whenever the layout dies the
10115 * child will be deleted automatically. One should use
10116 * elm_layout_table_remove() to make this layout forget about the object.
10118 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10119 * more space than a single cell. For instance, the following code:
10121 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10124 * Would result in an object being added like the following picture:
10126 * @image html layout_colspan.png
10127 * @image latex layout_colspan.eps width=\textwidth
10129 * @see elm_layout_table_unpack()
10130 * @see elm_layout_table_clear()
10134 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);
10136 * Unpack (remove) a child of the given part table.
10138 * @param obj The layout object
10139 * @param part The table part name to remove child.
10140 * @param child_obj The object to remove from table.
10141 * @return The object that was being used, or NULL if not found.
10143 * The object will be unpacked from the table part and its lifetime
10144 * will not be handled by the layout anymore. This is equivalent to
10145 * elm_object_content_part_unset() for table.
10147 * @see elm_layout_table_pack()
10148 * @see elm_layout_table_clear()
10152 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10154 * Remove all child of the given part table.
10156 * @param obj The layout object
10157 * @param part The table part name to remove child.
10158 * @param clear If EINA_TRUE, then all objects will be deleted as
10159 * well, otherwise they will just be removed and will be
10160 * dangling on the canvas.
10162 * The objects will be removed from the table part and their lifetime will
10163 * not be handled by the layout anymore. This is equivalent to
10164 * elm_layout_table_unpack() for all table children.
10166 * @see elm_layout_table_pack()
10167 * @see elm_layout_table_unpack()
10171 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10173 * Get the edje layout
10175 * @param obj The layout object
10177 * @return A Evas_Object with the edje layout settings loaded
10178 * with function elm_layout_file_set
10180 * This returns the edje object. It is not expected to be used to then
10181 * swallow objects via edje_object_part_swallow() for example. Use
10182 * elm_object_content_part_set() instead so child object handling and sizing is
10185 * @note This function should only be used if you really need to call some
10186 * low level Edje function on this edje object. All the common stuff (setting
10187 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10188 * with proper elementary functions.
10190 * @see elm_object_signal_callback_add()
10191 * @see elm_object_signal_emit()
10192 * @see elm_object_part_text_set()
10193 * @see elm_object_content_part_set()
10194 * @see elm_layout_box_append()
10195 * @see elm_layout_table_pack()
10196 * @see elm_layout_data_get()
10200 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10202 * Get the edje data from the given layout
10204 * @param obj The layout object
10205 * @param key The data key
10207 * @return The edje data string
10209 * This function fetches data specified inside the edje theme of this layout.
10210 * This function return NULL if data is not found.
10212 * In EDC this comes from a data block within the group block that @p
10213 * obj was loaded from. E.g.
10220 * item: "key1" "value1";
10221 * item: "key2" "value2";
10229 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10233 * @param obj The layout object
10235 * Manually forces a sizing re-evaluation. This is useful when the minimum
10236 * size required by the edje theme of this layout has changed. The change on
10237 * the minimum size required by the edje theme is not immediately reported to
10238 * the elementary layout, so one needs to call this function in order to tell
10239 * the widget (layout) that it needs to reevaluate its own size.
10241 * The minimum size of the theme is calculated based on minimum size of
10242 * parts, the size of elements inside containers like box and table, etc. All
10243 * of this can change due to state changes, and that's when this function
10244 * should be called.
10246 * Also note that a standard signal of "size,eval" "elm" emitted from the
10247 * edje object will cause this to happen too.
10251 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10254 * Sets a specific cursor for an edje part.
10256 * @param obj The layout object.
10257 * @param part_name a part from loaded edje group.
10258 * @param cursor cursor name to use, see Elementary_Cursor.h
10260 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10261 * part not exists or it has "mouse_events: 0".
10265 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10268 * Get the cursor to be shown when mouse is over an edje part
10270 * @param obj The layout object.
10271 * @param part_name a part from loaded edje group.
10272 * @return the cursor name.
10276 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10279 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10281 * @param obj The layout object.
10282 * @param part_name a part from loaded edje group, that had a cursor set
10283 * with elm_layout_part_cursor_set().
10287 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10290 * Sets a specific cursor style for an edje part.
10292 * @param obj The layout object.
10293 * @param part_name a part from loaded edje group.
10294 * @param style the theme style to use (default, transparent, ...)
10296 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10297 * part not exists or it did not had a cursor set.
10301 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10304 * Gets a specific cursor style for an edje part.
10306 * @param obj The layout object.
10307 * @param part_name a part from loaded edje group.
10309 * @return the theme style in use, defaults to "default". If the
10310 * object does not have a cursor set, then NULL is returned.
10314 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10317 * Sets if the cursor set should be searched on the theme or should use
10318 * the provided by the engine, only.
10320 * @note before you set if should look on theme you should define a
10321 * cursor with elm_layout_part_cursor_set(). By default it will only
10322 * look for cursors provided by the engine.
10324 * @param obj The layout object.
10325 * @param part_name a part from loaded edje group.
10326 * @param engine_only if cursors should be just provided by the engine
10327 * or should also search on widget's theme as well
10329 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10330 * part not exists or it did not had a cursor set.
10334 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);
10337 * Gets a specific cursor engine_only for an edje part.
10339 * @param obj The layout object.
10340 * @param part_name a part from loaded edje group.
10342 * @return whenever the cursor is just provided by engine or also from theme.
10346 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10349 * @def elm_layout_icon_set
10350 * Convienience macro to set the icon object in a layout that follows the
10351 * Elementary naming convention for its parts.
10355 #define elm_layout_icon_set(_ly, _obj) \
10358 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10359 if ((_obj)) sig = "elm,state,icon,visible"; \
10360 else sig = "elm,state,icon,hidden"; \
10361 elm_object_signal_emit((_ly), sig, "elm"); \
10365 * @def elm_layout_icon_get
10366 * Convienience macro to get the icon object from a layout that follows the
10367 * Elementary naming convention for its parts.
10371 #define elm_layout_icon_get(_ly) \
10372 elm_object_content_part_get((_ly), "elm.swallow.icon")
10375 * @def elm_layout_end_set
10376 * Convienience macro to set the end object in a layout that follows the
10377 * Elementary naming convention for its parts.
10381 #define elm_layout_end_set(_ly, _obj) \
10384 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10385 if ((_obj)) sig = "elm,state,end,visible"; \
10386 else sig = "elm,state,end,hidden"; \
10387 elm_object_signal_emit((_ly), sig, "elm"); \
10391 * @def elm_layout_end_get
10392 * Convienience macro to get the end object in a layout that follows the
10393 * Elementary naming convention for its parts.
10397 #define elm_layout_end_get(_ly) \
10398 elm_object_content_part_get((_ly), "elm.swallow.end")
10401 * @def elm_layout_label_set
10402 * Convienience macro to set the label in a layout that follows the
10403 * Elementary naming convention for its parts.
10406 * @deprecated use elm_object_text_set() instead.
10408 #define elm_layout_label_set(_ly, _txt) \
10409 elm_layout_text_set((_ly), "elm.text", (_txt))
10412 * @def elm_layout_label_get
10413 * Convenience macro to get the label in a layout that follows the
10414 * Elementary naming convention for its parts.
10417 * @deprecated use elm_object_text_set() instead.
10419 #define elm_layout_label_get(_ly) \
10420 elm_layout_text_get((_ly), "elm.text")
10422 /* smart callbacks called:
10423 * "theme,changed" - when elm theme is changed.
10427 * @defgroup Notify Notify
10429 * @image html img/widget/notify/preview-00.png
10430 * @image latex img/widget/notify/preview-00.eps
10432 * Display a container in a particular region of the parent(top, bottom,
10433 * etc). A timeout can be set to automatically hide the notify. This is so
10434 * that, after an evas_object_show() on a notify object, if a timeout was set
10435 * on it, it will @b automatically get hidden after that time.
10437 * Signals that you can add callbacks for are:
10438 * @li "timeout" - when timeout happens on notify and it's hidden
10439 * @li "block,clicked" - when a click outside of the notify happens
10441 * Default contents parts of the notify widget that you can use for are:
10442 * @li "default" - A content of the notify
10444 * @ref tutorial_notify show usage of the API.
10449 * @brief Possible orient values for notify.
10451 * This values should be used in conjunction to elm_notify_orient_set() to
10452 * set the position in which the notify should appear(relative to its parent)
10453 * and in conjunction with elm_notify_orient_get() to know where the notify
10456 typedef enum _Elm_Notify_Orient
10458 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10459 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10460 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10461 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10462 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10463 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10464 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10465 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10466 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10467 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10468 } Elm_Notify_Orient;
10470 * @brief Add a new notify to the parent
10472 * @param parent The parent object
10473 * @return The new object or NULL if it cannot be created
10475 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10477 * @brief Set the content of the notify widget
10479 * @param obj The notify object
10480 * @param content The content will be filled in this notify object
10482 * Once the content object is set, a previously set one will be deleted. If
10483 * you want to keep that old content object, use the
10484 * elm_notify_content_unset() function.
10486 * @deprecated use elm_object_content_set() instead
10489 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10491 * @brief Unset the content of the notify widget
10493 * @param obj The notify object
10494 * @return The content that was being used
10496 * Unparent and return the content object which was set for this widget
10498 * @see elm_notify_content_set()
10499 * @deprecated use elm_object_content_unset() instead
10502 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10504 * @brief Return the content of the notify widget
10506 * @param obj The notify object
10507 * @return The content that is being used
10509 * @see elm_notify_content_set()
10510 * @deprecated use elm_object_content_get() instead
10513 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10515 * @brief Set the notify parent
10517 * @param obj The notify object
10518 * @param content The new parent
10520 * Once the parent object is set, a previously set one will be disconnected
10523 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10525 * @brief Get the notify parent
10527 * @param obj The notify object
10528 * @return The parent
10530 * @see elm_notify_parent_set()
10532 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10534 * @brief Set the orientation
10536 * @param obj The notify object
10537 * @param orient The new orientation
10539 * Sets the position in which the notify will appear in its parent.
10541 * @see @ref Elm_Notify_Orient for possible values.
10543 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10545 * @brief Return the orientation
10546 * @param obj The notify object
10547 * @return The orientation of the notification
10549 * @see elm_notify_orient_set()
10550 * @see Elm_Notify_Orient
10552 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10554 * @brief Set the time interval after which the notify window is going to be
10557 * @param obj The notify object
10558 * @param time The timeout in seconds
10560 * This function sets a timeout and starts the timer controlling when the
10561 * notify is hidden. Since calling evas_object_show() on a notify restarts
10562 * the timer controlling when the notify is hidden, setting this before the
10563 * notify is shown will in effect mean starting the timer when the notify is
10566 * @note Set a value <= 0.0 to disable a running timer.
10568 * @note If the value > 0.0 and the notify is previously visible, the
10569 * timer will be started with this value, canceling any running timer.
10571 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10573 * @brief Return the timeout value (in seconds)
10574 * @param obj the notify object
10576 * @see elm_notify_timeout_set()
10578 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10580 * @brief Sets whether events should be passed to by a click outside
10583 * @param obj The notify object
10584 * @param repeats EINA_TRUE Events are repeats, else no
10586 * When true if the user clicks outside the window the events will be caught
10587 * by the others widgets, else the events are blocked.
10589 * @note The default value is EINA_TRUE.
10591 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10593 * @brief Return true if events are repeat below the notify object
10594 * @param obj the notify object
10596 * @see elm_notify_repeat_events_set()
10598 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10604 * @defgroup Hover Hover
10606 * @image html img/widget/hover/preview-00.png
10607 * @image latex img/widget/hover/preview-00.eps
10609 * A Hover object will hover over its @p parent object at the @p target
10610 * location. Anything in the background will be given a darker coloring to
10611 * indicate that the hover object is on top (at the default theme). When the
10612 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10613 * clicked that @b doesn't cause the hover to be dismissed.
10615 * A Hover object has two parents. One parent that owns it during creation
10616 * and the other parent being the one over which the hover object spans.
10619 * @note The hover object will take up the entire space of @p target
10622 * Elementary has the following styles for the hover widget:
10626 * @li hoversel_vertical
10628 * The following are the available position for content:
10640 * Signals that you can add callbacks for are:
10641 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10642 * @li "smart,changed" - a content object placed under the "smart"
10643 * policy was replaced to a new slot direction.
10645 * See @ref tutorial_hover for more information.
10649 typedef enum _Elm_Hover_Axis
10651 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10652 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10653 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10654 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10657 * @brief Adds a hover object to @p parent
10659 * @param parent The parent object
10660 * @return The hover object or NULL if one could not be created
10662 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10664 * @brief Sets the target object for the hover.
10666 * @param obj The hover object
10667 * @param target The object to center the hover onto. The hover
10669 * This function will cause the hover to be centered on the target object.
10671 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10673 * @brief Gets the target object for the hover.
10675 * @param obj The hover object
10676 * @param parent The object to locate the hover over.
10678 * @see elm_hover_target_set()
10680 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10682 * @brief Sets the parent object for the hover.
10684 * @param obj The hover object
10685 * @param parent The object to locate the hover over.
10687 * This function will cause the hover to take up the entire space that the
10688 * parent object fills.
10690 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10692 * @brief Gets the parent object for the hover.
10694 * @param obj The hover object
10695 * @return The parent object to locate the hover over.
10697 * @see elm_hover_parent_set()
10699 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10701 * @brief Sets the content of the hover object and the direction in which it
10704 * @param obj The hover object
10705 * @param swallow The direction that the object will be displayed
10706 * at. Accepted values are "left", "top-left", "top", "top-right",
10707 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10709 * @param content The content to place at @p swallow
10711 * Once the content object is set for a given direction, a previously
10712 * set one (on the same direction) will be deleted. If you want to
10713 * keep that old content object, use the elm_hover_content_unset()
10716 * All directions may have contents at the same time, except for
10717 * "smart". This is a special placement hint and its use case
10718 * independs of the calculations coming from
10719 * elm_hover_best_content_location_get(). Its use is for cases when
10720 * one desires only one hover content, but with a dinamic special
10721 * placement within the hover area. The content's geometry, whenever
10722 * it changes, will be used to decide on a best location not
10723 * extrapolating the hover's parent object view to show it in (still
10724 * being the hover's target determinant of its medium part -- move and
10725 * resize it to simulate finger sizes, for example). If one of the
10726 * directions other than "smart" are used, a previously content set
10727 * using it will be deleted, and vice-versa.
10729 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10731 * @brief Get the content of the hover object, in a given direction.
10733 * Return the content object which was set for this widget in the
10734 * @p swallow direction.
10736 * @param obj The hover object
10737 * @param swallow The direction that the object was display at.
10738 * @return The content that was being used
10740 * @see elm_hover_content_set()
10742 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10744 * @brief Unset the content of the hover object, in a given direction.
10746 * Unparent and return the content object set at @p swallow direction.
10748 * @param obj The hover object
10749 * @param swallow The direction that the object was display at.
10750 * @return The content that was being used.
10752 * @see elm_hover_content_set()
10754 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10756 * @brief Returns the best swallow location for content in the hover.
10758 * @param obj The hover object
10759 * @param pref_axis The preferred orientation axis for the hover object to use
10760 * @return The edje location to place content into the hover or @c
10763 * Best is defined here as the location at which there is the most available
10766 * @p pref_axis may be one of
10767 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10768 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10769 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10770 * - @c ELM_HOVER_AXIS_BOTH -- both
10772 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10773 * nescessarily be along the horizontal axis("left" or "right"). If
10774 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10775 * be along the vertical axis("top" or "bottom"). Chossing
10776 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10777 * returned position may be in either axis.
10779 * @see elm_hover_content_set()
10781 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10788 * @defgroup Entry Entry
10790 * @image html img/widget/entry/preview-00.png
10791 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10792 * @image html img/widget/entry/preview-01.png
10793 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10794 * @image html img/widget/entry/preview-02.png
10795 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10796 * @image html img/widget/entry/preview-03.png
10797 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10799 * An entry is a convenience widget which shows a box that the user can
10800 * enter text into. Entries by default don't scroll, so they grow to
10801 * accomodate the entire text, resizing the parent window as needed. This
10802 * can be changed with the elm_entry_scrollable_set() function.
10804 * They can also be single line or multi line (the default) and when set
10805 * to multi line mode they support text wrapping in any of the modes
10806 * indicated by #Elm_Wrap_Type.
10808 * Other features include password mode, filtering of inserted text with
10809 * elm_entry_text_filter_append() and related functions, inline "items" and
10810 * formatted markup text.
10812 * @section entry-markup Formatted text
10814 * The markup tags supported by the Entry are defined by the theme, but
10815 * even when writing new themes or extensions it's a good idea to stick to
10816 * a sane default, to maintain coherency and avoid application breakages.
10817 * Currently defined by the default theme are the following tags:
10818 * @li \<br\>: Inserts a line break.
10819 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10821 * @li \<tab\>: Inserts a tab.
10822 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10824 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10825 * @li \<link\>...\</link\>: Underlines the enclosed text.
10826 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10828 * @section entry-special Special markups
10830 * Besides those used to format text, entries support two special markup
10831 * tags used to insert clickable portions of text or items inlined within
10834 * @subsection entry-anchors Anchors
10836 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10837 * \</a\> tags and an event will be generated when this text is clicked,
10841 * This text is outside <a href=anc-01>but this one is an anchor</a>
10844 * The @c href attribute in the opening tag gives the name that will be
10845 * used to identify the anchor and it can be any valid utf8 string.
10847 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10848 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10849 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10850 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10853 * @subsection entry-items Items
10855 * Inlined in the text, any other @c Evas_Object can be inserted by using
10856 * \<item\> tags this way:
10859 * <item size=16x16 vsize=full href=emoticon/haha></item>
10862 * Just like with anchors, the @c href identifies each item, but these need,
10863 * in addition, to indicate their size, which is done using any one of
10864 * @c size, @c absize or @c relsize attributes. These attributes take their
10865 * value in the WxH format, where W is the width and H the height of the
10868 * @li absize: Absolute pixel size for the item. Whatever value is set will
10869 * be the item's size regardless of any scale value the object may have
10870 * been set to. The final line height will be adjusted to fit larger items.
10871 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10873 * @li relsize: Size is adjusted for the item to fit within the current
10876 * Besides their size, items are specificed a @c vsize value that affects
10877 * how their final size and position are calculated. The possible values
10879 * @li ascent: Item will be placed within the line's baseline and its
10880 * ascent. That is, the height between the line where all characters are
10881 * positioned and the highest point in the line. For @c size and @c absize
10882 * items, the descent value will be added to the total line height to make
10883 * them fit. @c relsize items will be adjusted to fit within this space.
10884 * @li full: Items will be placed between the descent and ascent, or the
10885 * lowest point in the line and its highest.
10887 * The next image shows different configurations of items and how they
10888 * are the previously mentioned options affect their sizes. In all cases,
10889 * the green line indicates the ascent, blue for the baseline and red for
10892 * @image html entry_item.png
10893 * @image latex entry_item.eps width=\textwidth
10895 * And another one to show how size differs from absize. In the first one,
10896 * the scale value is set to 1.0, while the second one is using one of 2.0.
10898 * @image html entry_item_scale.png
10899 * @image latex entry_item_scale.eps width=\textwidth
10901 * After the size for an item is calculated, the entry will request an
10902 * object to place in its space. For this, the functions set with
10903 * elm_entry_item_provider_append() and related functions will be called
10904 * in order until one of them returns a @c non-NULL value. If no providers
10905 * are available, or all of them return @c NULL, then the entry falls back
10906 * to one of the internal defaults, provided the name matches with one of
10909 * All of the following are currently supported:
10912 * - emoticon/angry-shout
10913 * - emoticon/crazy-laugh
10914 * - emoticon/evil-laugh
10916 * - emoticon/goggle-smile
10917 * - emoticon/grumpy
10918 * - emoticon/grumpy-smile
10919 * - emoticon/guilty
10920 * - emoticon/guilty-smile
10922 * - emoticon/half-smile
10923 * - emoticon/happy-panting
10925 * - emoticon/indifferent
10927 * - emoticon/knowing-grin
10929 * - emoticon/little-bit-sorry
10930 * - emoticon/love-lots
10932 * - emoticon/minimal-smile
10933 * - emoticon/not-happy
10934 * - emoticon/not-impressed
10936 * - emoticon/opensmile
10939 * - emoticon/squint-laugh
10940 * - emoticon/surprised
10941 * - emoticon/suspicious
10942 * - emoticon/tongue-dangling
10943 * - emoticon/tongue-poke
10945 * - emoticon/unhappy
10946 * - emoticon/very-sorry
10949 * - emoticon/worried
10952 * Alternatively, an item may reference an image by its path, using
10953 * the URI form @c file:///path/to/an/image.png and the entry will then
10954 * use that image for the item.
10956 * @section entry-files Loading and saving files
10958 * Entries have convinience functions to load text from a file and save
10959 * changes back to it after a short delay. The automatic saving is enabled
10960 * by default, but can be disabled with elm_entry_autosave_set() and files
10961 * can be loaded directly as plain text or have any markup in them
10962 * recognized. See elm_entry_file_set() for more details.
10964 * @section entry-signals Emitted signals
10966 * This widget emits the following signals:
10968 * @li "changed": The text within the entry was changed.
10969 * @li "changed,user": The text within the entry was changed because of user interaction.
10970 * @li "activated": The enter key was pressed on a single line entry.
10971 * @li "press": A mouse button has been pressed on the entry.
10972 * @li "longpressed": A mouse button has been pressed and held for a couple
10974 * @li "clicked": The entry has been clicked (mouse press and release).
10975 * @li "clicked,double": The entry has been double clicked.
10976 * @li "clicked,triple": The entry has been triple clicked.
10977 * @li "focused": The entry has received focus.
10978 * @li "unfocused": The entry has lost focus.
10979 * @li "selection,paste": A paste of the clipboard contents was requested.
10980 * @li "selection,copy": A copy of the selected text into the clipboard was
10982 * @li "selection,cut": A cut of the selected text into the clipboard was
10984 * @li "selection,start": A selection has begun and no previous selection
10986 * @li "selection,changed": The current selection has changed.
10987 * @li "selection,cleared": The current selection has been cleared.
10988 * @li "cursor,changed": The cursor has changed position.
10989 * @li "anchor,clicked": An anchor has been clicked. The event_info
10990 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10991 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10992 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10993 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10994 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10995 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10996 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10997 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10998 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10999 * @li "preedit,changed": The preedit string has changed.
11000 * @li "language,changed": Program language changed.
11002 * @section entry-examples
11004 * An overview of the Entry API can be seen in @ref entry_example_01
11009 * @typedef Elm_Entry_Anchor_Info
11011 * The info sent in the callback for the "anchor,clicked" signals emitted
11014 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11016 * @struct _Elm_Entry_Anchor_Info
11018 * The info sent in the callback for the "anchor,clicked" signals emitted
11021 struct _Elm_Entry_Anchor_Info
11023 const char *name; /**< The name of the anchor, as stated in its href */
11024 int button; /**< The mouse button used to click on it */
11025 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11026 y, /**< Anchor geometry, relative to canvas */
11027 w, /**< Anchor geometry, relative to canvas */
11028 h; /**< Anchor geometry, relative to canvas */
11031 * @typedef Elm_Entry_Filter_Cb
11032 * This callback type is used by entry filters to modify text.
11033 * @param data The data specified as the last param when adding the filter
11034 * @param entry The entry object
11035 * @param text A pointer to the location of the text being filtered. This data can be modified,
11036 * but any additional allocations must be managed by the user.
11037 * @see elm_entry_text_filter_append
11038 * @see elm_entry_text_filter_prepend
11040 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11043 * @typedef Elm_Entry_Change_Info
11044 * This corresponds to Edje_Entry_Change_Info. Includes information about
11045 * a change in the entry.
11047 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11051 * This adds an entry to @p parent object.
11053 * By default, entries are:
11057 * @li autosave is enabled
11059 * @param parent The parent object
11060 * @return The new object or NULL if it cannot be created
11062 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11064 * Sets the entry to single line mode.
11066 * In single line mode, entries don't ever wrap when the text reaches the
11067 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11068 * key will generate an @c "activate" event instead of adding a new line.
11070 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11071 * and pressing enter will break the text into a different line
11072 * without generating any events.
11074 * @param obj The entry object
11075 * @param single_line If true, the text in the entry
11076 * will be on a single line.
11078 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11080 * Gets whether the entry is set to be single line.
11082 * @param obj The entry object
11083 * @return single_line If true, the text in the entry is set to display
11084 * on a single line.
11086 * @see elm_entry_single_line_set()
11088 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11090 * Sets the entry to password mode.
11092 * In password mode, entries are implicitly single line and the display of
11093 * any text in them is replaced with asterisks (*).
11095 * @param obj The entry object
11096 * @param password If true, password mode is enabled.
11098 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11100 * Gets whether the entry is set to password mode.
11102 * @param obj The entry object
11103 * @return If true, the entry is set to display all characters
11104 * as asterisks (*).
11106 * @see elm_entry_password_set()
11108 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11110 * This sets the text displayed within the entry to @p entry.
11112 * @param obj The entry object
11113 * @param entry The text to be displayed
11115 * @deprecated Use elm_object_text_set() instead.
11116 * @note Using this function bypasses text filters
11118 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11120 * This returns the text currently shown in object @p entry.
11121 * See also elm_entry_entry_set().
11123 * @param obj The entry object
11124 * @return The currently displayed text or NULL on failure
11126 * @deprecated Use elm_object_text_get() instead.
11128 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11130 * Appends @p entry to the text of the entry.
11132 * Adds the text in @p entry to the end of any text already present in the
11135 * The appended text is subject to any filters set for the widget.
11137 * @param obj The entry object
11138 * @param entry The text to be displayed
11140 * @see elm_entry_text_filter_append()
11142 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11144 * Gets whether the entry is empty.
11146 * Empty means no text at all. If there are any markup tags, like an item
11147 * tag for which no provider finds anything, and no text is displayed, this
11148 * function still returns EINA_FALSE.
11150 * @param obj The entry object
11151 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11153 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11155 * Gets any selected text within the entry.
11157 * If there's any selected text in the entry, this function returns it as
11158 * a string in markup format. NULL is returned if no selection exists or
11159 * if an error occurred.
11161 * The returned value points to an internal string and should not be freed
11162 * or modified in any way. If the @p entry object is deleted or its
11163 * contents are changed, the returned pointer should be considered invalid.
11165 * @param obj The entry object
11166 * @return The selected text within the entry or NULL on failure
11168 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11170 * Returns the actual textblock object of the entry.
11172 * This function exposes the internal textblock object that actually
11173 * contains and draws the text. This should be used for low-level
11174 * manipulations that are otherwise not possible.
11176 * Changing the textblock directly from here will not notify edje/elm to
11177 * recalculate the textblock size automatically, so any modifications
11178 * done to the textblock returned by this function should be followed by
11179 * a call to elm_entry_calc_force().
11181 * The return value is marked as const as an additional warning.
11182 * One should not use the returned object with any of the generic evas
11183 * functions (geometry_get/resize/move and etc), but only with the textblock
11184 * functions; The former will either not work at all, or break the correct
11187 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11188 * the internal textblock object. Do NOT cache the returned object, and try
11189 * not to mix calls on this object with regular elm_entry calls (which may
11190 * change the internal textblock object). This applies to all cursors
11191 * returned from textblock calls, and all the other derivative values.
11193 * @param obj The entry object
11194 * @return The textblock object.
11196 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11198 * Forces calculation of the entry size and text layouting.
11200 * This should be used after modifying the textblock object directly. See
11201 * elm_entry_textblock_get() for more information.
11203 * @param obj The entry object
11205 * @see elm_entry_textblock_get()
11207 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11209 * Inserts the given text into the entry at the current cursor position.
11211 * This inserts text at the cursor position as if it was typed
11212 * by the user (note that this also allows markup which a user
11213 * can't just "type" as it would be converted to escaped text, so this
11214 * call can be used to insert things like emoticon items or bold push/pop
11215 * tags, other font and color change tags etc.)
11217 * If any selection exists, it will be replaced by the inserted text.
11219 * The inserted text is subject to any filters set for the widget.
11221 * @param obj The entry object
11222 * @param entry The text to insert
11224 * @see elm_entry_text_filter_append()
11226 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11228 * Set the line wrap type to use on multi-line entries.
11230 * Sets the wrap type used by the entry to any of the specified in
11231 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11232 * line (without inserting a line break or paragraph separator) when it
11233 * reaches the far edge of the widget.
11235 * Note that this only makes sense for multi-line entries. A widget set
11236 * to be single line will never wrap.
11238 * @param obj The entry object
11239 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11241 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11243 * Gets the wrap mode the entry was set to use.
11245 * @param obj The entry object
11246 * @return Wrap type
11248 * @see also elm_entry_line_wrap_set()
11250 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11252 * Sets if the entry is to be editable or not.
11254 * By default, entries are editable and when focused, any text input by the
11255 * user will be inserted at the current cursor position. But calling this
11256 * function with @p editable as EINA_FALSE will prevent the user from
11257 * inputting text into the entry.
11259 * The only way to change the text of a non-editable entry is to use
11260 * elm_object_text_set(), elm_entry_entry_insert() and other related
11263 * @param obj The entry object
11264 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11265 * if not, the entry is read-only and no user input is allowed.
11267 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11269 * Gets whether the entry is editable or not.
11271 * @param obj The entry object
11272 * @return If true, the entry is editable by the user.
11273 * If false, it is not editable by the user
11275 * @see elm_entry_editable_set()
11277 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11279 * This drops any existing text selection within the entry.
11281 * @param obj The entry object
11283 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11285 * This selects all text within the entry.
11287 * @param obj The entry object
11289 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11291 * This moves the cursor one place to the right within the entry.
11293 * @param obj The entry object
11294 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11296 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11298 * This moves the cursor one place to the left within the entry.
11300 * @param obj The entry object
11301 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11303 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11305 * This moves the cursor one line up within the entry.
11307 * @param obj The entry object
11308 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11310 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11312 * This moves the cursor one line down within the entry.
11314 * @param obj The entry object
11315 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11317 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11319 * This moves the cursor to the beginning of the entry.
11321 * @param obj The entry object
11323 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11325 * This moves the cursor to the end of the entry.
11327 * @param obj The entry object
11329 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11331 * This moves the cursor to the beginning of the current line.
11333 * @param obj The entry object
11335 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11337 * This moves the cursor to the end of the current line.
11339 * @param obj The entry object
11341 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11343 * This begins a selection within the entry as though
11344 * the user were holding down the mouse button to make a selection.
11346 * @param obj The entry object
11348 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11350 * This ends a selection within the entry as though
11351 * the user had just released the mouse button while making a selection.
11353 * @param obj The entry object
11355 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11357 * Gets whether a format node exists at the current cursor position.
11359 * A format node is anything that defines how the text is rendered. It can
11360 * be a visible format node, such as a line break or a paragraph separator,
11361 * or an invisible one, such as bold begin or end tag.
11362 * This function returns whether any format node exists at the current
11365 * @param obj The entry object
11366 * @return EINA_TRUE if the current cursor position contains a format node,
11367 * EINA_FALSE otherwise.
11369 * @see elm_entry_cursor_is_visible_format_get()
11371 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11373 * Gets if the current cursor position holds a visible format node.
11375 * @param obj The entry object
11376 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11377 * if it's an invisible one or no format exists.
11379 * @see elm_entry_cursor_is_format_get()
11381 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11383 * Gets the character pointed by the cursor at its current position.
11385 * This function returns a string with the utf8 character stored at the
11386 * current cursor position.
11387 * Only the text is returned, any format that may exist will not be part
11388 * of the return value.
11390 * @param obj The entry object
11391 * @return The text pointed by the cursors.
11393 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * This function returns the geometry of the cursor.
11397 * It's useful if you want to draw something on the cursor (or where it is),
11398 * or for example in the case of scrolled entry where you want to show the
11401 * @param obj The entry object
11402 * @param x returned geometry
11403 * @param y returned geometry
11404 * @param w returned geometry
11405 * @param h returned geometry
11406 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11408 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);
11410 * Sets the cursor position in the entry to the given value
11412 * The value in @p pos is the index of the character position within the
11413 * contents of the string as returned by elm_entry_cursor_pos_get().
11415 * @param obj The entry object
11416 * @param pos The position of the cursor
11418 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11420 * Retrieves the current position of the cursor in the entry
11422 * @param obj The entry object
11423 * @return The cursor position
11425 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11427 * This executes a "cut" action on the selected text in the entry.
11429 * @param obj The entry object
11431 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11433 * This executes a "copy" action on the selected text in the entry.
11435 * @param obj The entry object
11437 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11439 * This executes a "paste" action in the entry.
11441 * @param obj The entry object
11443 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11445 * This clears and frees the items in a entry's contextual (longpress)
11448 * @param obj The entry object
11450 * @see elm_entry_context_menu_item_add()
11452 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11454 * This adds an item to the entry's contextual menu.
11456 * A longpress on an entry will make the contextual menu show up, if this
11457 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11458 * By default, this menu provides a few options like enabling selection mode,
11459 * which is useful on embedded devices that need to be explicit about it,
11460 * and when a selection exists it also shows the copy and cut actions.
11462 * With this function, developers can add other options to this menu to
11463 * perform any action they deem necessary.
11465 * @param obj The entry object
11466 * @param label The item's text label
11467 * @param icon_file The item's icon file
11468 * @param icon_type The item's icon type
11469 * @param func The callback to execute when the item is clicked
11470 * @param data The data to associate with the item for related functions
11472 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);
11474 * This disables the entry's contextual (longpress) menu.
11476 * @param obj The entry object
11477 * @param disabled If true, the menu is disabled
11479 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11481 * This returns whether the entry's contextual (longpress) menu is
11484 * @param obj The entry object
11485 * @return If true, the menu is disabled
11487 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11489 * This appends a custom item provider to the list for that entry
11491 * This appends the given callback. The list is walked from beginning to end
11492 * with each function called given the item href string in the text. If the
11493 * function returns an object handle other than NULL (it should create an
11494 * object to do this), then this object is used to replace that item. If
11495 * not the next provider is called until one provides an item object, or the
11496 * default provider in entry does.
11498 * @param obj The entry object
11499 * @param func The function called to provide the item object
11500 * @param data The data passed to @p func
11502 * @see @ref entry-items
11504 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);
11506 * This prepends a custom item provider to the list for that entry
11508 * This prepends the given callback. See elm_entry_item_provider_append() for
11511 * @param obj The entry object
11512 * @param func The function called to provide the item object
11513 * @param data The data passed to @p func
11515 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);
11517 * This removes a custom item provider to the list for that entry
11519 * This removes the given callback. See elm_entry_item_provider_append() for
11522 * @param obj The entry object
11523 * @param func The function called to provide the item object
11524 * @param data The data passed to @p func
11526 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);
11528 * Append a filter function for text inserted in the entry
11530 * Append the given callback to the list. This functions will be called
11531 * whenever any text is inserted into the entry, with the text to be inserted
11532 * as a parameter. The callback function is free to alter the text in any way
11533 * it wants, but it must remember to free the given pointer and update it.
11534 * If the new text is to be discarded, the function can free it and set its
11535 * text parameter to NULL. This will also prevent any following filters from
11538 * @param obj The entry object
11539 * @param func The function to use as text filter
11540 * @param data User data to pass to @p func
11542 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11544 * Prepend a filter function for text insdrted in the entry
11546 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11547 * for more information
11549 * @param obj The entry object
11550 * @param func The function to use as text filter
11551 * @param data User data to pass to @p func
11553 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11555 * Remove a filter from the list
11557 * Removes the given callback from the filter list. See
11558 * elm_entry_text_filter_append() for more information.
11560 * @param obj The entry object
11561 * @param func The filter function to remove
11562 * @param data The user data passed when adding the function
11564 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11566 * This converts a markup (HTML-like) string into UTF-8.
11568 * The returned string is a malloc'ed buffer and it should be freed when
11569 * not needed anymore.
11571 * @param s The string (in markup) to be converted
11572 * @return The converted string (in UTF-8). It should be freed.
11574 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11576 * This converts a UTF-8 string into markup (HTML-like).
11578 * The returned string is a malloc'ed buffer and it should be freed when
11579 * not needed anymore.
11581 * @param s The string (in UTF-8) to be converted
11582 * @return The converted string (in markup). It should be freed.
11584 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11586 * This sets the file (and implicitly loads it) for the text to display and
11587 * then edit. All changes are written back to the file after a short delay if
11588 * the entry object is set to autosave (which is the default).
11590 * If the entry had any other file set previously, any changes made to it
11591 * will be saved if the autosave feature is enabled, otherwise, the file
11592 * will be silently discarded and any non-saved changes will be lost.
11594 * @param obj The entry object
11595 * @param file The path to the file to load and save
11596 * @param format The file format
11598 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11600 * Gets the file being edited by the entry.
11602 * This function can be used to retrieve any file set on the entry for
11603 * edition, along with the format used to load and save it.
11605 * @param obj The entry object
11606 * @param file The path to the file to load and save
11607 * @param format The file format
11609 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11611 * This function writes any changes made to the file set with
11612 * elm_entry_file_set()
11614 * @param obj The entry object
11616 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11618 * This sets the entry object to 'autosave' the loaded text file or not.
11620 * @param obj The entry object
11621 * @param autosave Autosave the loaded file or not
11623 * @see elm_entry_file_set()
11625 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11627 * This gets the entry object's 'autosave' status.
11629 * @param obj The entry object
11630 * @return Autosave the loaded file or not
11632 * @see elm_entry_file_set()
11634 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11636 * Control pasting of text and images for the widget.
11638 * Normally the entry allows both text and images to be pasted. By setting
11639 * textonly to be true, this prevents images from being pasted.
11641 * Note this only changes the behaviour of text.
11643 * @param obj The entry object
11644 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11645 * text+image+other.
11647 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11649 * Getting elm_entry text paste/drop mode.
11651 * In textonly mode, only text may be pasted or dropped into the widget.
11653 * @param obj The entry object
11654 * @return If the widget only accepts text from pastes.
11656 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11658 * Enable or disable scrolling in entry
11660 * Normally the entry is not scrollable unless you enable it with this call.
11662 * @param obj The entry object
11663 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11665 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11667 * Get the scrollable state of the entry
11669 * Normally the entry is not scrollable. This gets the scrollable state
11670 * of the entry. See elm_entry_scrollable_set() for more information.
11672 * @param obj The entry object
11673 * @return The scrollable state
11675 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11677 * This sets a widget to be displayed to the left of a scrolled entry.
11679 * @param obj The scrolled entry object
11680 * @param icon The widget to display on the left side of the scrolled
11683 * @note A previously set widget will be destroyed.
11684 * @note If the object being set does not have minimum size hints set,
11685 * it won't get properly displayed.
11687 * @see elm_entry_end_set()
11689 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11691 * Gets the leftmost widget of the scrolled entry. This object is
11692 * owned by the scrolled entry and should not be modified.
11694 * @param obj The scrolled entry object
11695 * @return the left widget inside the scroller
11697 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11699 * Unset the leftmost widget of the scrolled entry, unparenting and
11702 * @param obj The scrolled entry object
11703 * @return the previously set icon sub-object of this entry, on
11706 * @see elm_entry_icon_set()
11708 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11710 * Sets the visibility of the left-side widget of the scrolled entry,
11711 * set by elm_entry_icon_set().
11713 * @param obj The scrolled entry object
11714 * @param setting EINA_TRUE if the object should be displayed,
11715 * EINA_FALSE if not.
11717 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11719 * This sets a widget to be displayed to the end of a scrolled entry.
11721 * @param obj The scrolled entry object
11722 * @param end The widget to display on the right side of the scrolled
11725 * @note A previously set widget will be destroyed.
11726 * @note If the object being set does not have minimum size hints set,
11727 * it won't get properly displayed.
11729 * @see elm_entry_icon_set
11731 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11733 * Gets the endmost widget of the scrolled entry. This object is owned
11734 * by the scrolled entry and should not be modified.
11736 * @param obj The scrolled entry object
11737 * @return the right widget inside the scroller
11739 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11741 * Unset the endmost widget of the scrolled entry, unparenting and
11744 * @param obj The scrolled entry object
11745 * @return the previously set icon sub-object of this entry, on
11748 * @see elm_entry_icon_set()
11750 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11752 * Sets the visibility of the end widget of the scrolled entry, set by
11753 * elm_entry_end_set().
11755 * @param obj The scrolled entry object
11756 * @param setting EINA_TRUE if the object should be displayed,
11757 * EINA_FALSE if not.
11759 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11761 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11764 * Setting an entry to single-line mode with elm_entry_single_line_set()
11765 * will automatically disable the display of scrollbars when the entry
11766 * moves inside its scroller.
11768 * @param obj The scrolled entry object
11769 * @param h The horizontal scrollbar policy to apply
11770 * @param v The vertical scrollbar policy to apply
11772 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11774 * This enables/disables bouncing within the entry.
11776 * This function sets whether the entry will bounce when scrolling reaches
11777 * the end of the contained entry.
11779 * @param obj The scrolled entry object
11780 * @param h The horizontal bounce state
11781 * @param v The vertical bounce state
11783 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11785 * Get the bounce mode
11787 * @param obj The Entry object
11788 * @param h_bounce Allow bounce horizontally
11789 * @param v_bounce Allow bounce vertically
11791 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11793 /* pre-made filters for entries */
11795 * @typedef Elm_Entry_Filter_Limit_Size
11797 * Data for the elm_entry_filter_limit_size() entry filter.
11799 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11801 * @struct _Elm_Entry_Filter_Limit_Size
11803 * Data for the elm_entry_filter_limit_size() entry filter.
11805 struct _Elm_Entry_Filter_Limit_Size
11807 int max_char_count; /**< The maximum number of characters allowed. */
11808 int max_byte_count; /**< The maximum number of bytes allowed*/
11811 * Filter inserted text based on user defined character and byte limits
11813 * Add this filter to an entry to limit the characters that it will accept
11814 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11815 * The funtion works on the UTF-8 representation of the string, converting
11816 * it from the set markup, thus not accounting for any format in it.
11818 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11819 * it as data when setting the filter. In it, it's possible to set limits
11820 * by character count or bytes (any of them is disabled if 0), and both can
11821 * be set at the same time. In that case, it first checks for characters,
11824 * The function will cut the inserted text in order to allow only the first
11825 * number of characters that are still allowed. The cut is made in
11826 * characters, even when limiting by bytes, in order to always contain
11827 * valid ones and avoid half unicode characters making it in.
11829 * This filter, like any others, does not apply when setting the entry text
11830 * directly with elm_object_text_set() (or the deprecated
11831 * elm_entry_entry_set()).
11833 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11835 * @typedef Elm_Entry_Filter_Accept_Set
11837 * Data for the elm_entry_filter_accept_set() entry filter.
11839 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11841 * @struct _Elm_Entry_Filter_Accept_Set
11843 * Data for the elm_entry_filter_accept_set() entry filter.
11845 struct _Elm_Entry_Filter_Accept_Set
11847 const char *accepted; /**< Set of characters accepted in the entry. */
11848 const char *rejected; /**< Set of characters rejected from the entry. */
11851 * Filter inserted text based on accepted or rejected sets of characters
11853 * Add this filter to an entry to restrict the set of accepted characters
11854 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11855 * This structure contains both accepted and rejected sets, but they are
11856 * mutually exclusive.
11858 * The @c accepted set takes preference, so if it is set, the filter will
11859 * only work based on the accepted characters, ignoring anything in the
11860 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11862 * In both cases, the function filters by matching utf8 characters to the
11863 * raw markup text, so it can be used to remove formatting tags.
11865 * This filter, like any others, does not apply when setting the entry text
11866 * directly with elm_object_text_set() (or the deprecated
11867 * elm_entry_entry_set()).
11869 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11871 * Set the input panel layout of the entry
11873 * @param obj The entry object
11874 * @param layout layout type
11876 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11878 * Get the input panel layout of the entry
11880 * @param obj The entry object
11881 * @return layout type
11883 * @see elm_entry_input_panel_layout_set
11885 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11887 * Set the autocapitalization type on the immodule.
11889 * @param obj The entry object
11890 * @param autocapital_type The type of autocapitalization
11892 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11894 * Retrieve the autocapitalization type on the immodule.
11896 * @param obj The entry object
11897 * @return autocapitalization type
11899 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11901 * Sets the attribute to show the input panel automatically.
11903 * @param obj The entry object
11904 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11906 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11908 * Retrieve the attribute to show the input panel automatically.
11910 * @param obj The entry object
11911 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11913 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11919 /* composite widgets - these basically put together basic widgets above
11920 * in convenient packages that do more than basic stuff */
11924 * @defgroup Anchorview Anchorview
11926 * @image html img/widget/anchorview/preview-00.png
11927 * @image latex img/widget/anchorview/preview-00.eps
11929 * Anchorview is for displaying text that contains markup with anchors
11930 * like <c>\<a href=1234\>something\</\></c> in it.
11932 * Besides being styled differently, the anchorview widget provides the
11933 * necessary functionality so that clicking on these anchors brings up a
11934 * popup with user defined content such as "call", "add to contacts" or
11935 * "open web page". This popup is provided using the @ref Hover widget.
11937 * This widget is very similar to @ref Anchorblock, so refer to that
11938 * widget for an example. The only difference Anchorview has is that the
11939 * widget is already provided with scrolling functionality, so if the
11940 * text set to it is too large to fit in the given space, it will scroll,
11941 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11942 * text can be displayed.
11944 * This widget emits the following signals:
11945 * @li "anchor,clicked": will be called when an anchor is clicked. The
11946 * @p event_info parameter on the callback will be a pointer of type
11947 * ::Elm_Entry_Anchorview_Info.
11949 * See @ref Anchorblock for an example on how to use both of them.
11958 * @typedef Elm_Entry_Anchorview_Info
11960 * The info sent in the callback for "anchor,clicked" signals emitted by
11961 * the Anchorview widget.
11963 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11965 * @struct _Elm_Entry_Anchorview_Info
11967 * The info sent in the callback for "anchor,clicked" signals emitted by
11968 * the Anchorview widget.
11970 struct _Elm_Entry_Anchorview_Info
11972 const char *name; /**< Name of the anchor, as indicated in its href
11974 int button; /**< The mouse button used to click on it */
11975 Evas_Object *hover; /**< The hover object to use for the popup */
11977 Evas_Coord x, y, w, h;
11978 } anchor, /**< Geometry selection of text used as anchor */
11979 hover_parent; /**< Geometry of the object used as parent by the
11981 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11982 for content on the left side of
11983 the hover. Before calling the
11984 callback, the widget will make the
11985 necessary calculations to check
11986 which sides are fit to be set with
11987 content, based on the position the
11988 hover is activated and its distance
11989 to the edges of its parent object
11991 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11992 the right side of the hover.
11993 See @ref hover_left */
11994 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11995 of the hover. See @ref hover_left */
11996 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11997 below the hover. See @ref
12001 * Add a new Anchorview object
12003 * @param parent The parent object
12004 * @return The new object or NULL if it cannot be created
12006 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12008 * Set the text to show in the anchorview
12010 * Sets the text of the anchorview to @p text. This text can include markup
12011 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12012 * text that will be specially styled and react to click events, ended with
12013 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12014 * "anchor,clicked" signal that you can attach a callback to with
12015 * evas_object_smart_callback_add(). The name of the anchor given in the
12016 * event info struct will be the one set in the href attribute, in this
12017 * case, anchorname.
12019 * Other markup can be used to style the text in different ways, but it's
12020 * up to the style defined in the theme which tags do what.
12021 * @deprecated use elm_object_text_set() instead.
12023 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12025 * Get the markup text set for the anchorview
12027 * Retrieves the text set on the anchorview, with markup tags included.
12029 * @param obj The anchorview object
12030 * @return The markup text set or @c NULL if nothing was set or an error
12032 * @deprecated use elm_object_text_set() instead.
12034 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12036 * Set the parent of the hover popup
12038 * Sets the parent object to use by the hover created by the anchorview
12039 * when an anchor is clicked. See @ref Hover for more details on this.
12040 * If no parent is set, the same anchorview object will be used.
12042 * @param obj The anchorview object
12043 * @param parent The object to use as parent for the hover
12045 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12047 * Get the parent of the hover popup
12049 * Get the object used as parent for the hover created by the anchorview
12050 * widget. See @ref Hover for more details on this.
12052 * @param obj The anchorview object
12053 * @return The object used as parent for the hover, NULL if none is set.
12055 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12057 * Set the style that the hover should use
12059 * When creating the popup hover, anchorview will request that it's
12060 * themed according to @p style.
12062 * @param obj The anchorview object
12063 * @param style The style to use for the underlying hover
12065 * @see elm_object_style_set()
12067 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12069 * Get the style that the hover should use
12071 * Get the style the hover created by anchorview will use.
12073 * @param obj The anchorview object
12074 * @return The style to use by the hover. NULL means the default is used.
12076 * @see elm_object_style_set()
12078 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12080 * Ends the hover popup in the anchorview
12082 * When an anchor is clicked, the anchorview widget will create a hover
12083 * object to use as a popup with user provided content. This function
12084 * terminates this popup, returning the anchorview to its normal state.
12086 * @param obj The anchorview object
12088 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12090 * Set bouncing behaviour when the scrolled content reaches an edge
12092 * Tell the internal scroller object whether it should bounce or not
12093 * when it reaches the respective edges for each axis.
12095 * @param obj The anchorview object
12096 * @param h_bounce Whether to bounce or not in the horizontal axis
12097 * @param v_bounce Whether to bounce or not in the vertical axis
12099 * @see elm_scroller_bounce_set()
12101 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12103 * Get the set bouncing behaviour of the internal scroller
12105 * Get whether the internal scroller should bounce when the edge of each
12106 * axis is reached scrolling.
12108 * @param obj The anchorview object
12109 * @param h_bounce Pointer where to store the bounce state of the horizontal
12111 * @param v_bounce Pointer where to store the bounce state of the vertical
12114 * @see elm_scroller_bounce_get()
12116 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12118 * Appends a custom item provider to the given anchorview
12120 * Appends the given function to the list of items providers. This list is
12121 * called, one function at a time, with the given @p data pointer, the
12122 * anchorview object and, in the @p item parameter, the item name as
12123 * referenced in its href string. Following functions in the list will be
12124 * called in order until one of them returns something different to NULL,
12125 * which should be an Evas_Object which will be used in place of the item
12128 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12129 * href=item/name\>\</item\>
12131 * @param obj The anchorview object
12132 * @param func The function to add to the list of providers
12133 * @param data User data that will be passed to the callback function
12135 * @see elm_entry_item_provider_append()
12137 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);
12139 * Prepend a custom item provider to the given anchorview
12141 * Like elm_anchorview_item_provider_append(), but it adds the function
12142 * @p func to the beginning of the list, instead of the end.
12144 * @param obj The anchorview object
12145 * @param func The function to add to the list of providers
12146 * @param data User data that will be passed to the callback function
12148 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);
12150 * Remove a custom item provider from the list of the given anchorview
12152 * Removes the function and data pairing that matches @p func and @p data.
12153 * That is, unless the same function and same user data are given, the
12154 * function will not be removed from the list. This allows us to add the
12155 * same callback several times, with different @p data pointers and be
12156 * able to remove them later without conflicts.
12158 * @param obj The anchorview object
12159 * @param func The function to remove from the list
12160 * @param data The data matching the function to remove from the list
12162 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);
12169 * @defgroup Anchorblock Anchorblock
12171 * @image html img/widget/anchorblock/preview-00.png
12172 * @image latex img/widget/anchorblock/preview-00.eps
12174 * Anchorblock is for displaying text that contains markup with anchors
12175 * like <c>\<a href=1234\>something\</\></c> in it.
12177 * Besides being styled differently, the anchorblock widget provides the
12178 * necessary functionality so that clicking on these anchors brings up a
12179 * popup with user defined content such as "call", "add to contacts" or
12180 * "open web page". This popup is provided using the @ref Hover widget.
12182 * This widget emits the following signals:
12183 * @li "anchor,clicked": will be called when an anchor is clicked. The
12184 * @p event_info parameter on the callback will be a pointer of type
12185 * ::Elm_Entry_Anchorblock_Info.
12191 * Since examples are usually better than plain words, we might as well
12192 * try @ref tutorial_anchorblock_example "one".
12195 * @addtogroup Anchorblock
12199 * @typedef Elm_Entry_Anchorblock_Info
12201 * The info sent in the callback for "anchor,clicked" signals emitted by
12202 * the Anchorblock widget.
12204 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12206 * @struct _Elm_Entry_Anchorblock_Info
12208 * The info sent in the callback for "anchor,clicked" signals emitted by
12209 * the Anchorblock widget.
12211 struct _Elm_Entry_Anchorblock_Info
12213 const char *name; /**< Name of the anchor, as indicated in its href
12215 int button; /**< The mouse button used to click on it */
12216 Evas_Object *hover; /**< The hover object to use for the popup */
12218 Evas_Coord x, y, w, h;
12219 } anchor, /**< Geometry selection of text used as anchor */
12220 hover_parent; /**< Geometry of the object used as parent by the
12222 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12223 for content on the left side of
12224 the hover. Before calling the
12225 callback, the widget will make the
12226 necessary calculations to check
12227 which sides are fit to be set with
12228 content, based on the position the
12229 hover is activated and its distance
12230 to the edges of its parent object
12232 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12233 the right side of the hover.
12234 See @ref hover_left */
12235 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12236 of the hover. See @ref hover_left */
12237 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12238 below the hover. See @ref
12242 * Add a new Anchorblock object
12244 * @param parent The parent object
12245 * @return The new object or NULL if it cannot be created
12247 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12249 * Set the text to show in the anchorblock
12251 * Sets the text of the anchorblock to @p text. This text can include markup
12252 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12253 * of text that will be specially styled and react to click events, ended
12254 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12255 * "anchor,clicked" signal that you can attach a callback to with
12256 * evas_object_smart_callback_add(). The name of the anchor given in the
12257 * event info struct will be the one set in the href attribute, in this
12258 * case, anchorname.
12260 * Other markup can be used to style the text in different ways, but it's
12261 * up to the style defined in the theme which tags do what.
12262 * @deprecated use elm_object_text_set() instead.
12264 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12266 * Get the markup text set for the anchorblock
12268 * Retrieves the text set on the anchorblock, with markup tags included.
12270 * @param obj The anchorblock object
12271 * @return The markup text set or @c NULL if nothing was set or an error
12273 * @deprecated use elm_object_text_set() instead.
12275 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12277 * Set the parent of the hover popup
12279 * Sets the parent object to use by the hover created by the anchorblock
12280 * when an anchor is clicked. See @ref Hover for more details on this.
12282 * @param obj The anchorblock object
12283 * @param parent The object to use as parent for the hover
12285 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12287 * Get the parent of the hover popup
12289 * Get the object used as parent for the hover created by the anchorblock
12290 * widget. See @ref Hover for more details on this.
12291 * If no parent is set, the same anchorblock object will be used.
12293 * @param obj The anchorblock object
12294 * @return The object used as parent for the hover, NULL if none is set.
12296 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12298 * Set the style that the hover should use
12300 * When creating the popup hover, anchorblock will request that it's
12301 * themed according to @p style.
12303 * @param obj The anchorblock object
12304 * @param style The style to use for the underlying hover
12306 * @see elm_object_style_set()
12308 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12310 * Get the style that the hover should use
12312 * Get the style, the hover created by anchorblock will use.
12314 * @param obj The anchorblock object
12315 * @return The style to use by the hover. NULL means the default is used.
12317 * @see elm_object_style_set()
12319 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12321 * Ends the hover popup in the anchorblock
12323 * When an anchor is clicked, the anchorblock widget will create a hover
12324 * object to use as a popup with user provided content. This function
12325 * terminates this popup, returning the anchorblock to its normal state.
12327 * @param obj The anchorblock object
12329 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12331 * Appends a custom item provider to the given anchorblock
12333 * Appends the given function to the list of items providers. This list is
12334 * called, one function at a time, with the given @p data pointer, the
12335 * anchorblock object and, in the @p item parameter, the item name as
12336 * referenced in its href string. Following functions in the list will be
12337 * called in order until one of them returns something different to NULL,
12338 * which should be an Evas_Object which will be used in place of the item
12341 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12342 * href=item/name\>\</item\>
12344 * @param obj The anchorblock object
12345 * @param func The function to add to the list of providers
12346 * @param data User data that will be passed to the callback function
12348 * @see elm_entry_item_provider_append()
12350 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);
12352 * Prepend a custom item provider to the given anchorblock
12354 * Like elm_anchorblock_item_provider_append(), but it adds the function
12355 * @p func to the beginning of the list, instead of the end.
12357 * @param obj The anchorblock object
12358 * @param func The function to add to the list of providers
12359 * @param data User data that will be passed to the callback function
12361 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);
12363 * Remove a custom item provider from the list of the given anchorblock
12365 * Removes the function and data pairing that matches @p func and @p data.
12366 * That is, unless the same function and same user data are given, the
12367 * function will not be removed from the list. This allows us to add the
12368 * same callback several times, with different @p data pointers and be
12369 * able to remove them later without conflicts.
12371 * @param obj The anchorblock object
12372 * @param func The function to remove from the list
12373 * @param data The data matching the function to remove from the list
12375 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);
12381 * @defgroup Bubble Bubble
12383 * @image html img/widget/bubble/preview-00.png
12384 * @image latex img/widget/bubble/preview-00.eps
12385 * @image html img/widget/bubble/preview-01.png
12386 * @image latex img/widget/bubble/preview-01.eps
12387 * @image html img/widget/bubble/preview-02.png
12388 * @image latex img/widget/bubble/preview-02.eps
12390 * @brief The Bubble is a widget to show text similar to how speech is
12391 * represented in comics.
12393 * The bubble widget contains 5 important visual elements:
12394 * @li The frame is a rectangle with rounded edjes and an "arrow".
12395 * @li The @p icon is an image to which the frame's arrow points to.
12396 * @li The @p label is a text which appears to the right of the icon if the
12397 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12399 * @li The @p info is a text which appears to the right of the label. Info's
12400 * font is of a ligther color than label.
12401 * @li The @p content is an evas object that is shown inside the frame.
12403 * The position of the arrow, icon, label and info depends on which corner is
12404 * selected. The four available corners are:
12405 * @li "top_left" - Default
12407 * @li "bottom_left"
12408 * @li "bottom_right"
12410 * Signals that you can add callbacks for are:
12411 * @li "clicked" - This is called when a user has clicked the bubble.
12413 * Default contents parts of the bubble that you can use for are:
12414 * @li "default" - A content of the bubble
12415 * @li "icon" - An icon of the bubble
12417 * Default text parts of the button widget that you can use for are:
12418 * @li NULL - Label of the bubble
12420 * For an example of using a buble see @ref bubble_01_example_page "this".
12426 * Add a new bubble to the parent
12428 * @param parent The parent object
12429 * @return The new object or NULL if it cannot be created
12431 * This function adds a text bubble to the given parent evas object.
12433 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12435 * Set the label of the bubble
12437 * @param obj The bubble object
12438 * @param label The string to set in the label
12440 * This function sets the title of the bubble. Where this appears depends on
12441 * the selected corner.
12442 * @deprecated use elm_object_text_set() instead.
12444 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12446 * Get the label of the bubble
12448 * @param obj The bubble object
12449 * @return The string of set in the label
12451 * This function gets the title of the bubble.
12452 * @deprecated use elm_object_text_get() instead.
12454 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12456 * Set the info of the bubble
12458 * @param obj The bubble object
12459 * @param info The given info about the bubble
12461 * This function sets the info of the bubble. Where this appears depends on
12462 * the selected corner.
12463 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12465 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12467 * Get the info of the bubble
12469 * @param obj The bubble object
12471 * @return The "info" string of the bubble
12473 * This function gets the info text.
12474 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12476 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12478 * Set the content to be shown in the bubble
12480 * Once the content object is set, a previously set one will be deleted.
12481 * If you want to keep the old content object, use the
12482 * elm_bubble_content_unset() function.
12484 * @param obj The bubble object
12485 * @param content The given content of the bubble
12487 * This function sets the content shown on the middle of the bubble.
12489 * @deprecated use elm_object_content_set() instead
12492 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12494 * Get the content shown in the bubble
12496 * Return the content object which is set for this widget.
12498 * @param obj The bubble object
12499 * @return The content that is being used
12501 * @deprecated use elm_object_content_get() instead
12504 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12506 * Unset the content shown in the bubble
12508 * Unparent and return the content object which was set for this widget.
12510 * @param obj The bubble object
12511 * @return The content that was being used
12513 * @deprecated use elm_object_content_unset() instead
12516 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12518 * Set the icon of the bubble
12520 * Once the icon object is set, a previously set one will be deleted.
12521 * If you want to keep the old content object, use the
12522 * elm_icon_content_unset() function.
12524 * @param obj The bubble object
12525 * @param icon The given icon for the bubble
12527 * @deprecated use elm_object_content_part_set() instead
12530 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12532 * Get the icon of the bubble
12534 * @param obj The bubble object
12535 * @return The icon for the bubble
12537 * This function gets the icon shown on the top left of bubble.
12539 * @deprecated use elm_object_content_part_get() instead
12542 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12544 * Unset the icon of the bubble
12546 * Unparent and return the icon object which was set for this widget.
12548 * @param obj The bubble object
12549 * @return The icon that was being used
12551 * @deprecated use elm_object_content_part_unset() instead
12554 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12556 * Set the corner of the bubble
12558 * @param obj The bubble object.
12559 * @param corner The given corner for the bubble.
12561 * This function sets the corner of the bubble. The corner will be used to
12562 * determine where the arrow in the frame points to and where label, icon and
12565 * Possible values for corner are:
12566 * @li "top_left" - Default
12568 * @li "bottom_left"
12569 * @li "bottom_right"
12571 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12573 * Get the corner of the bubble
12575 * @param obj The bubble object.
12576 * @return The given corner for the bubble.
12578 * This function gets the selected corner of the bubble.
12580 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12586 * @defgroup Photo Photo
12588 * For displaying the photo of a person (contact). Simple, yet
12589 * with a very specific purpose.
12591 * Signals that you can add callbacks for are:
12593 * "clicked" - This is called when a user has clicked the photo
12594 * "drag,start" - Someone started dragging the image out of the object
12595 * "drag,end" - Dragged item was dropped (somewhere)
12601 * Add a new photo to the parent
12603 * @param parent The parent object
12604 * @return The new object or NULL if it cannot be created
12608 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12611 * Set the file that will be used as photo
12613 * @param obj The photo object
12614 * @param file The path to file that will be used as photo
12616 * @return (1 = success, 0 = error)
12620 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12623 * Set the file that will be used as thumbnail in the photo.
12625 * @param obj The photo object.
12626 * @param file The path to file that will be used as thumb.
12627 * @param group The key used in case of an EET file.
12631 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12634 * Set the size that will be used on the photo
12636 * @param obj The photo object
12637 * @param size The size that the photo will be
12641 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12644 * Set if the photo should be completely visible or not.
12646 * @param obj The photo object
12647 * @param fill if true the photo will be completely visible
12651 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12654 * Set editability of the photo.
12656 * An editable photo can be dragged to or from, and can be cut or
12657 * pasted too. Note that pasting an image or dropping an item on
12658 * the image will delete the existing content.
12660 * @param obj The photo object.
12661 * @param set To set of clear editablity.
12663 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12669 /* gesture layer */
12671 * @defgroup Elm_Gesture_Layer Gesture Layer
12672 * Gesture Layer Usage:
12674 * Use Gesture Layer to detect gestures.
12675 * The advantage is that you don't have to implement
12676 * gesture detection, just set callbacks of gesture state.
12677 * By using gesture layer we make standard interface.
12679 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12680 * with a parent object parameter.
12681 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12682 * call. Usually with same object as target (2nd parameter).
12684 * Now you need to tell gesture layer what gestures you follow.
12685 * This is done with @ref elm_gesture_layer_cb_set call.
12686 * By setting the callback you actually saying to gesture layer:
12687 * I would like to know when the gesture @ref Elm_Gesture_Types
12688 * switches to state @ref Elm_Gesture_State.
12690 * Next, you need to implement the actual action that follows the input
12691 * in your callback.
12693 * Note that if you like to stop being reported about a gesture, just set
12694 * all callbacks referring this gesture to NULL.
12695 * (again with @ref elm_gesture_layer_cb_set)
12697 * The information reported by gesture layer to your callback is depending
12698 * on @ref Elm_Gesture_Types:
12699 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12700 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12701 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12703 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12704 * @ref ELM_GESTURE_MOMENTUM.
12706 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12707 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12708 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12709 * Note that we consider a flick as a line-gesture that should be completed
12710 * in flick-time-limit as defined in @ref Config.
12712 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12714 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12717 * Gesture Layer Tweaks:
12719 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12720 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12722 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12723 * so gesture starts when user touches (a *DOWN event) touch-surface
12724 * and ends when no fingers touches surface (a *UP event).
12728 * @enum _Elm_Gesture_Types
12729 * Enum of supported gesture types.
12730 * @ingroup Elm_Gesture_Layer
12732 enum _Elm_Gesture_Types
12734 ELM_GESTURE_FIRST = 0,
12736 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12737 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12738 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12739 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12741 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12743 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12744 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12746 ELM_GESTURE_ZOOM, /**< Zoom */
12747 ELM_GESTURE_ROTATE, /**< Rotate */
12753 * @typedef Elm_Gesture_Types
12754 * gesture types enum
12755 * @ingroup Elm_Gesture_Layer
12757 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12760 * @enum _Elm_Gesture_State
12761 * Enum of gesture states.
12762 * @ingroup Elm_Gesture_Layer
12764 enum _Elm_Gesture_State
12766 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12767 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12768 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12769 ELM_GESTURE_STATE_END, /**< Gesture completed */
12770 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12774 * @typedef Elm_Gesture_State
12775 * gesture states enum
12776 * @ingroup Elm_Gesture_Layer
12778 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12781 * @struct _Elm_Gesture_Taps_Info
12782 * Struct holds taps info for user
12783 * @ingroup Elm_Gesture_Layer
12785 struct _Elm_Gesture_Taps_Info
12787 Evas_Coord x, y; /**< Holds center point between fingers */
12788 unsigned int n; /**< Number of fingers tapped */
12789 unsigned int timestamp; /**< event timestamp */
12793 * @typedef Elm_Gesture_Taps_Info
12794 * holds taps info for user
12795 * @ingroup Elm_Gesture_Layer
12797 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12800 * @struct _Elm_Gesture_Momentum_Info
12801 * Struct holds momentum info for user
12802 * x1 and y1 are not necessarily in sync
12803 * x1 holds x value of x direction starting point
12804 * and same holds for y1.
12805 * This is noticeable when doing V-shape movement
12806 * @ingroup Elm_Gesture_Layer
12808 struct _Elm_Gesture_Momentum_Info
12809 { /* Report line ends, timestamps, and momentum computed */
12810 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12811 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12812 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12813 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12815 unsigned int tx; /**< Timestamp of start of final x-swipe */
12816 unsigned int ty; /**< Timestamp of start of final y-swipe */
12818 Evas_Coord mx; /**< Momentum on X */
12819 Evas_Coord my; /**< Momentum on Y */
12821 unsigned int n; /**< Number of fingers */
12825 * @typedef Elm_Gesture_Momentum_Info
12826 * holds momentum info for user
12827 * @ingroup Elm_Gesture_Layer
12829 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12832 * @struct _Elm_Gesture_Line_Info
12833 * Struct holds line info for user
12834 * @ingroup Elm_Gesture_Layer
12836 struct _Elm_Gesture_Line_Info
12837 { /* Report line ends, timestamps, and momentum computed */
12838 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12839 double angle; /**< Angle (direction) of lines */
12843 * @typedef Elm_Gesture_Line_Info
12844 * Holds line info for user
12845 * @ingroup Elm_Gesture_Layer
12847 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12850 * @struct _Elm_Gesture_Zoom_Info
12851 * Struct holds zoom info for user
12852 * @ingroup Elm_Gesture_Layer
12854 struct _Elm_Gesture_Zoom_Info
12856 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12857 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12858 double zoom; /**< Zoom value: 1.0 means no zoom */
12859 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12863 * @typedef Elm_Gesture_Zoom_Info
12864 * Holds zoom info for user
12865 * @ingroup Elm_Gesture_Layer
12867 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12870 * @struct _Elm_Gesture_Rotate_Info
12871 * Struct holds rotation info for user
12872 * @ingroup Elm_Gesture_Layer
12874 struct _Elm_Gesture_Rotate_Info
12876 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12877 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12878 double base_angle; /**< Holds start-angle */
12879 double angle; /**< Rotation value: 0.0 means no rotation */
12880 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12884 * @typedef Elm_Gesture_Rotate_Info
12885 * Holds rotation info for user
12886 * @ingroup Elm_Gesture_Layer
12888 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12891 * @typedef Elm_Gesture_Event_Cb
12892 * User callback used to stream gesture info from gesture layer
12893 * @param data user data
12894 * @param event_info gesture report info
12895 * Returns a flag field to be applied on the causing event.
12896 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12897 * upon the event, in an irreversible way.
12899 * @ingroup Elm_Gesture_Layer
12901 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12904 * Use function to set callbacks to be notified about
12905 * change of state of gesture.
12906 * When a user registers a callback with this function
12907 * this means this gesture has to be tested.
12909 * When ALL callbacks for a gesture are set to NULL
12910 * it means user isn't interested in gesture-state
12911 * and it will not be tested.
12913 * @param obj Pointer to gesture-layer.
12914 * @param idx The gesture you would like to track its state.
12915 * @param cb callback function pointer.
12916 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12917 * @param data user info to be sent to callback (usually, Smart Data)
12919 * @ingroup Elm_Gesture_Layer
12921 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);
12924 * Call this function to get repeat-events settings.
12926 * @param obj Pointer to gesture-layer.
12928 * @return repeat events settings.
12929 * @see elm_gesture_layer_hold_events_set()
12930 * @ingroup Elm_Gesture_Layer
12932 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12935 * This function called in order to make gesture-layer repeat events.
12936 * Set this of you like to get the raw events only if gestures were not detected.
12937 * Clear this if you like gesture layer to fwd events as testing gestures.
12939 * @param obj Pointer to gesture-layer.
12940 * @param r Repeat: TRUE/FALSE
12942 * @ingroup Elm_Gesture_Layer
12944 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12947 * This function sets step-value for zoom action.
12948 * Set step to any positive value.
12949 * Cancel step setting by setting to 0.0
12951 * @param obj Pointer to gesture-layer.
12952 * @param s new zoom step value.
12954 * @ingroup Elm_Gesture_Layer
12956 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12959 * This function sets step-value for rotate action.
12960 * Set step to any positive value.
12961 * Cancel step setting by setting to 0.0
12963 * @param obj Pointer to gesture-layer.
12964 * @param s new roatate step value.
12966 * @ingroup Elm_Gesture_Layer
12968 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12971 * This function called to attach gesture-layer to an Evas_Object.
12972 * @param obj Pointer to gesture-layer.
12973 * @param t Pointer to underlying object (AKA Target)
12975 * @return TRUE, FALSE on success, failure.
12977 * @ingroup Elm_Gesture_Layer
12979 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12982 * Call this function to construct a new gesture-layer object.
12983 * This does not activate the gesture layer. You have to
12984 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12986 * @param parent the parent object.
12988 * @return Pointer to new gesture-layer object.
12990 * @ingroup Elm_Gesture_Layer
12992 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12995 * @defgroup Thumb Thumb
12997 * @image html img/widget/thumb/preview-00.png
12998 * @image latex img/widget/thumb/preview-00.eps
13000 * A thumb object is used for displaying the thumbnail of an image or video.
13001 * You must have compiled Elementary with Ethumb_Client support and the DBus
13002 * service must be present and auto-activated in order to have thumbnails to
13005 * Once the thumbnail object becomes visible, it will check if there is a
13006 * previously generated thumbnail image for the file set on it. If not, it
13007 * will start generating this thumbnail.
13009 * Different config settings will cause different thumbnails to be generated
13010 * even on the same file.
13012 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13013 * Ethumb documentation to change this path, and to see other configuration
13016 * Signals that you can add callbacks for are:
13018 * - "clicked" - This is called when a user has clicked the thumb without dragging
13020 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13021 * - "press" - This is called when a user has pressed down the thumb.
13022 * - "generate,start" - The thumbnail generation started.
13023 * - "generate,stop" - The generation process stopped.
13024 * - "generate,error" - The generation failed.
13025 * - "load,error" - The thumbnail image loading failed.
13027 * available styles:
13031 * An example of use of thumbnail:
13033 * - @ref thumb_example_01
13037 * @addtogroup Thumb
13042 * @enum _Elm_Thumb_Animation_Setting
13043 * @typedef Elm_Thumb_Animation_Setting
13045 * Used to set if a video thumbnail is animating or not.
13049 typedef enum _Elm_Thumb_Animation_Setting
13051 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13052 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13053 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13054 ELM_THUMB_ANIMATION_LAST
13055 } Elm_Thumb_Animation_Setting;
13058 * Add a new thumb object to the parent.
13060 * @param parent The parent object.
13061 * @return The new object or NULL if it cannot be created.
13063 * @see elm_thumb_file_set()
13064 * @see elm_thumb_ethumb_client_get()
13068 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13070 * Reload thumbnail if it was generated before.
13072 * @param obj The thumb object to reload
13074 * This is useful if the ethumb client configuration changed, like its
13075 * size, aspect or any other property one set in the handle returned
13076 * by elm_thumb_ethumb_client_get().
13078 * If the options didn't change, the thumbnail won't be generated again, but
13079 * the old one will still be used.
13081 * @see elm_thumb_file_set()
13085 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13087 * Set the file that will be used as thumbnail.
13089 * @param obj The thumb object.
13090 * @param file The path to file that will be used as thumb.
13091 * @param key The key used in case of an EET file.
13093 * The file can be an image or a video (in that case, acceptable extensions are:
13094 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13095 * function elm_thumb_animate().
13097 * @see elm_thumb_file_get()
13098 * @see elm_thumb_reload()
13099 * @see elm_thumb_animate()
13103 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13105 * Get the image or video path and key used to generate the thumbnail.
13107 * @param obj The thumb object.
13108 * @param file Pointer to filename.
13109 * @param key Pointer to key.
13111 * @see elm_thumb_file_set()
13112 * @see elm_thumb_path_get()
13116 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13118 * Get the path and key to the image or video generated by ethumb.
13120 * One just need to make sure that the thumbnail was generated before getting
13121 * its path; otherwise, the path will be NULL. One way to do that is by asking
13122 * for the path when/after the "generate,stop" smart callback is called.
13124 * @param obj The thumb object.
13125 * @param file Pointer to thumb path.
13126 * @param key Pointer to thumb key.
13128 * @see elm_thumb_file_get()
13132 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13134 * Set the animation state for the thumb object. If its content is an animated
13135 * video, you may start/stop the animation or tell it to play continuously and
13138 * @param obj The thumb object.
13139 * @param setting The animation setting.
13141 * @see elm_thumb_file_set()
13145 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13147 * Get the animation state for the thumb object.
13149 * @param obj The thumb object.
13150 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13153 * @see elm_thumb_animate_set()
13157 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13159 * Get the ethumb_client handle so custom configuration can be made.
13161 * @return Ethumb_Client instance or NULL.
13163 * This must be called before the objects are created to be sure no object is
13164 * visible and no generation started.
13166 * Example of usage:
13169 * #include <Elementary.h>
13170 * #ifndef ELM_LIB_QUICKLAUNCH
13172 * elm_main(int argc, char **argv)
13174 * Ethumb_Client *client;
13176 * elm_need_ethumb();
13180 * client = elm_thumb_ethumb_client_get();
13183 * ERR("could not get ethumb_client");
13186 * ethumb_client_size_set(client, 100, 100);
13187 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13190 * // Create elm_thumb objects here
13200 * @note There's only one client handle for Ethumb, so once a configuration
13201 * change is done to it, any other request for thumbnails (for any thumbnail
13202 * object) will use that configuration. Thus, this configuration is global.
13206 EAPI void *elm_thumb_ethumb_client_get(void);
13208 * Get the ethumb_client connection state.
13210 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13213 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13215 * Make the thumbnail 'editable'.
13217 * @param obj Thumb object.
13218 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13220 * This means the thumbnail is a valid drag target for drag and drop, and can be
13221 * cut or pasted too.
13223 * @see elm_thumb_editable_get()
13227 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13229 * Make the thumbnail 'editable'.
13231 * @param obj Thumb object.
13232 * @return Editability.
13234 * This means the thumbnail is a valid drag target for drag and drop, and can be
13235 * cut or pasted too.
13237 * @see elm_thumb_editable_set()
13241 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13248 * @defgroup Web Web
13250 * @image html img/widget/web/preview-00.png
13251 * @image latex img/widget/web/preview-00.eps
13253 * A web object is used for displaying web pages (HTML/CSS/JS)
13254 * using WebKit-EFL. You must have compiled Elementary with
13257 * Signals that you can add callbacks for are:
13258 * @li "download,request": A file download has been requested. Event info is
13259 * a pointer to a Elm_Web_Download
13260 * @li "editorclient,contents,changed": Editor client's contents changed
13261 * @li "editorclient,selection,changed": Editor client's selection changed
13262 * @li "frame,created": A new frame was created. Event info is an
13263 * Evas_Object which can be handled with WebKit's ewk_frame API
13264 * @li "icon,received": An icon was received by the main frame
13265 * @li "inputmethod,changed": Input method changed. Event info is an
13266 * Eina_Bool indicating whether it's enabled or not
13267 * @li "js,windowobject,clear": JS window object has been cleared
13268 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13269 * is a char *link[2], where the first string contains the URL the link
13270 * points to, and the second one the title of the link
13271 * @li "link,hover,out": Mouse cursor left the link
13272 * @li "load,document,finished": Loading of a document finished. Event info
13273 * is the frame that finished loading
13274 * @li "load,error": Load failed. Event info is a pointer to
13275 * Elm_Web_Frame_Load_Error
13276 * @li "load,finished": Load finished. Event info is NULL on success, on
13277 * error it's a pointer to Elm_Web_Frame_Load_Error
13278 * @li "load,newwindow,show": A new window was created and is ready to be
13280 * @li "load,progress": Overall load progress. Event info is a pointer to
13281 * a double containing a value between 0.0 and 1.0
13282 * @li "load,provisional": Started provisional load
13283 * @li "load,started": Loading of a document started
13284 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13285 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13286 * the menubar is visible, or EINA_FALSE in case it's not
13287 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13288 * an Eina_Bool indicating the visibility
13289 * @li "popup,created": A dropdown widget was activated, requesting its
13290 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13291 * @li "popup,willdelete": The web object is ready to destroy the popup
13292 * object created. Event info is a pointer to Elm_Web_Menu
13293 * @li "ready": Page is fully loaded
13294 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13295 * info is a pointer to Eina_Bool where the visibility state should be set
13296 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13297 * is an Eina_Bool with the visibility state set
13298 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13299 * a string with the new text
13300 * @li "statusbar,visible,get": Queries visibility of the status bar.
13301 * Event info is a pointer to Eina_Bool where the visibility state should be
13303 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13304 * an Eina_Bool with the visibility value
13305 * @li "title,changed": Title of the main frame changed. Event info is a
13306 * string with the new title
13307 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13308 * is a pointer to Eina_Bool where the visibility state should be set
13309 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13310 * info is an Eina_Bool with the visibility state
13311 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13312 * a string with the text to show
13313 * @li "uri,changed": URI of the main frame changed. Event info is a string
13315 * @li "view,resized": The web object internal's view changed sized
13316 * @li "windows,close,request": A JavaScript request to close the current
13317 * window was requested
13318 * @li "zoom,animated,end": Animated zoom finished
13320 * available styles:
13323 * An example of use of web:
13325 * - @ref web_example_01 TBD
13334 * Structure used to report load errors.
13336 * Load errors are reported as signal by elm_web. All the strings are
13337 * temporary references and should @b not be used after the signal
13338 * callback returns. If it's required, make copies with strdup() or
13339 * eina_stringshare_add() (they are not even guaranteed to be
13340 * stringshared, so must use eina_stringshare_add() and not
13341 * eina_stringshare_ref()).
13343 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13345 * Structure used to report load errors.
13347 * Load errors are reported as signal by elm_web. All the strings are
13348 * temporary references and should @b not be used after the signal
13349 * callback returns. If it's required, make copies with strdup() or
13350 * eina_stringshare_add() (they are not even guaranteed to be
13351 * stringshared, so must use eina_stringshare_add() and not
13352 * eina_stringshare_ref()).
13354 struct _Elm_Web_Frame_Load_Error
13356 int code; /**< Numeric error code */
13357 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13358 const char *domain; /**< Error domain name */
13359 const char *description; /**< Error description (already localized) */
13360 const char *failing_url; /**< The URL that failed to load */
13361 Evas_Object *frame; /**< Frame object that produced the error */
13365 * The possibles types that the items in a menu can be
13367 typedef enum _Elm_Web_Menu_Item_Type
13369 ELM_WEB_MENU_SEPARATOR,
13370 ELM_WEB_MENU_GROUP,
13371 ELM_WEB_MENU_OPTION
13372 } Elm_Web_Menu_Item_Type;
13375 * Structure describing the items in a menu
13377 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13379 * Structure describing the items in a menu
13381 struct _Elm_Web_Menu_Item
13383 const char *text; /**< The text for the item */
13384 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13388 * Structure describing the menu of a popup
13390 * This structure will be passed as the @c event_info for the "popup,create"
13391 * signal, which is emitted when a dropdown menu is opened. Users wanting
13392 * to handle these popups by themselves should listen to this signal and
13393 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13394 * property as @c EINA_FALSE means that the user will not handle the popup
13395 * and the default implementation will be used.
13397 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13398 * will be emitted to notify the user that it can destroy any objects and
13399 * free all data related to it.
13401 * @see elm_web_popup_selected_set()
13402 * @see elm_web_popup_destroy()
13404 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13406 * Structure describing the menu of a popup
13408 * This structure will be passed as the @c event_info for the "popup,create"
13409 * signal, which is emitted when a dropdown menu is opened. Users wanting
13410 * to handle these popups by themselves should listen to this signal and
13411 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13412 * property as @c EINA_FALSE means that the user will not handle the popup
13413 * and the default implementation will be used.
13415 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13416 * will be emitted to notify the user that it can destroy any objects and
13417 * free all data related to it.
13419 * @see elm_web_popup_selected_set()
13420 * @see elm_web_popup_destroy()
13422 struct _Elm_Web_Menu
13424 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13425 int x; /**< The X position of the popup, relative to the elm_web object */
13426 int y; /**< The Y position of the popup, relative to the elm_web object */
13427 int width; /**< Width of the popup menu */
13428 int height; /**< Height of the popup menu */
13430 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. */
13433 typedef struct _Elm_Web_Download Elm_Web_Download;
13434 struct _Elm_Web_Download
13440 * Types of zoom available.
13442 typedef enum _Elm_Web_Zoom_Mode
13444 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13445 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13446 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13447 ELM_WEB_ZOOM_MODE_LAST
13448 } Elm_Web_Zoom_Mode;
13450 * Opaque handler containing the features (such as statusbar, menubar, etc)
13451 * that are to be set on a newly requested window.
13453 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13455 * Callback type for the create_window hook.
13457 * The function parameters are:
13458 * @li @p data User data pointer set when setting the hook function
13459 * @li @p obj The elm_web object requesting the new window
13460 * @li @p js Set to @c EINA_TRUE if the request was originated from
13461 * JavaScript. @c EINA_FALSE otherwise.
13462 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13463 * the features requested for the new window.
13465 * The returned value of the function should be the @c elm_web widget where
13466 * the request will be loaded. That is, if a new window or tab is created,
13467 * the elm_web widget in it should be returned, and @b NOT the window
13469 * Returning @c NULL should cancel the request.
13471 * @see elm_web_window_create_hook_set()
13473 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13475 * Callback type for the JS alert hook.
13477 * The function parameters are:
13478 * @li @p data User data pointer set when setting the hook function
13479 * @li @p obj The elm_web object requesting the new window
13480 * @li @p message The message to show in the alert dialog
13482 * The function should return the object representing the alert dialog.
13483 * Elm_Web will run a second main loop to handle the dialog and normal
13484 * flow of the application will be restored when the object is deleted, so
13485 * the user should handle the popup properly in order to delete the object
13486 * when the action is finished.
13487 * If the function returns @c NULL the popup will be ignored.
13489 * @see elm_web_dialog_alert_hook_set()
13491 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13493 * Callback type for the JS confirm hook.
13495 * The function parameters are:
13496 * @li @p data User data pointer set when setting the hook function
13497 * @li @p obj The elm_web object requesting the new window
13498 * @li @p message The message to show in the confirm dialog
13499 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13500 * the user selected @c Ok, @c EINA_FALSE otherwise.
13502 * The function should return the object representing the confirm dialog.
13503 * Elm_Web will run a second main loop to handle the dialog and normal
13504 * flow of the application will be restored when the object is deleted, so
13505 * the user should handle the popup properly in order to delete the object
13506 * when the action is finished.
13507 * If the function returns @c NULL the popup will be ignored.
13509 * @see elm_web_dialog_confirm_hook_set()
13511 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13513 * Callback type for the JS prompt hook.
13515 * The function parameters are:
13516 * @li @p data User data pointer set when setting the hook function
13517 * @li @p obj The elm_web object requesting the new window
13518 * @li @p message The message to show in the prompt dialog
13519 * @li @p def_value The default value to present the user in the entry
13520 * @li @p value Pointer where to store the value given by the user. Must
13521 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13522 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13523 * the user selected @c Ok, @c EINA_FALSE otherwise.
13525 * The function should return the object representing the prompt dialog.
13526 * Elm_Web will run a second main loop to handle the dialog and normal
13527 * flow of the application will be restored when the object is deleted, so
13528 * the user should handle the popup properly in order to delete the object
13529 * when the action is finished.
13530 * If the function returns @c NULL the popup will be ignored.
13532 * @see elm_web_dialog_prompt_hook_set()
13534 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13536 * Callback type for the JS file selector hook.
13538 * The function parameters are:
13539 * @li @p data User data pointer set when setting the hook function
13540 * @li @p obj The elm_web object requesting the new window
13541 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13542 * @li @p accept_types Mime types accepted
13543 * @li @p selected Pointer where to store the list of malloc'ed strings
13544 * containing the path to each file selected. Must be @c NULL if the file
13545 * dialog is cancelled
13546 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13547 * the user selected @c Ok, @c EINA_FALSE otherwise.
13549 * The function should return the object representing the file selector
13551 * Elm_Web will run a second main loop to handle the dialog and normal
13552 * flow of the application will be restored when the object is deleted, so
13553 * the user should handle the popup properly in order to delete the object
13554 * when the action is finished.
13555 * If the function returns @c NULL the popup will be ignored.
13557 * @see elm_web_dialog_file selector_hook_set()
13559 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);
13561 * Callback type for the JS console message hook.
13563 * When a console message is added from JavaScript, any set function to the
13564 * console message hook will be called for the user to handle. There is no
13565 * default implementation of this hook.
13567 * The function parameters are:
13568 * @li @p data User data pointer set when setting the hook function
13569 * @li @p obj The elm_web object that originated the message
13570 * @li @p message The message sent
13571 * @li @p line_number The line number
13572 * @li @p source_id Source id
13574 * @see elm_web_console_message_hook_set()
13576 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13578 * Add a new web object to the parent.
13580 * @param parent The parent object.
13581 * @return The new object or NULL if it cannot be created.
13583 * @see elm_web_uri_set()
13584 * @see elm_web_webkit_view_get()
13586 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13589 * Get internal ewk_view object from web object.
13591 * Elementary may not provide some low level features of EWebKit,
13592 * instead of cluttering the API with proxy methods we opted to
13593 * return the internal reference. Be careful using it as it may
13594 * interfere with elm_web behavior.
13596 * @param obj The web object.
13597 * @return The internal ewk_view object or NULL if it does not
13598 * exist. (Failure to create or Elementary compiled without
13601 * @see elm_web_add()
13603 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13606 * Sets the function to call when a new window is requested
13608 * This hook will be called when a request to create a new window is
13609 * issued from the web page loaded.
13610 * There is no default implementation for this feature, so leaving this
13611 * unset or passing @c NULL in @p func will prevent new windows from
13614 * @param obj The web object where to set the hook function
13615 * @param func The hook function to be called when a window is requested
13616 * @param data User data
13618 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13620 * Sets the function to call when an alert dialog
13622 * This hook will be called when a JavaScript alert dialog is requested.
13623 * If no function is set or @c NULL is passed in @p func, the default
13624 * implementation will take place.
13626 * @param obj The web object where to set the hook function
13627 * @param func The callback function to be used
13628 * @param data User data
13630 * @see elm_web_inwin_mode_set()
13632 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13634 * Sets the function to call when an confirm dialog
13636 * This hook will be called when a JavaScript confirm dialog is requested.
13637 * If no function is set or @c NULL is passed in @p func, the default
13638 * implementation will take place.
13640 * @param obj The web object where to set the hook function
13641 * @param func The callback function to be used
13642 * @param data User data
13644 * @see elm_web_inwin_mode_set()
13646 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13648 * Sets the function to call when an prompt dialog
13650 * This hook will be called when a JavaScript prompt dialog is requested.
13651 * If no function is set or @c NULL is passed in @p func, the default
13652 * implementation will take place.
13654 * @param obj The web object where to set the hook function
13655 * @param func The callback function to be used
13656 * @param data User data
13658 * @see elm_web_inwin_mode_set()
13660 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13662 * Sets the function to call when an file selector dialog
13664 * This hook will be called when a JavaScript file selector dialog is
13666 * If no function is set or @c NULL is passed in @p func, the default
13667 * implementation will take place.
13669 * @param obj The web object where to set the hook function
13670 * @param func The callback function to be used
13671 * @param data User data
13673 * @see elm_web_inwin_mode_set()
13675 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13677 * Sets the function to call when a console message is emitted from JS
13679 * This hook will be called when a console message is emitted from
13680 * JavaScript. There is no default implementation for this feature.
13682 * @param obj The web object where to set the hook function
13683 * @param func The callback function to be used
13684 * @param data User data
13686 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13688 * Gets the status of the tab propagation
13690 * @param obj The web object to query
13691 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13693 * @see elm_web_tab_propagate_set()
13695 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13697 * Sets whether to use tab propagation
13699 * If tab propagation is enabled, whenever the user presses the Tab key,
13700 * Elementary will handle it and switch focus to the next widget.
13701 * The default value is disabled, where WebKit will handle the Tab key to
13702 * cycle focus though its internal objects, jumping to the next widget
13703 * only when that cycle ends.
13705 * @param obj The web object
13706 * @param propagate Whether to propagate Tab keys to Elementary or not
13708 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13710 * Sets the URI for the web object
13712 * It must be a full URI, with resource included, in the form
13713 * http://www.enlightenment.org or file:///tmp/something.html
13715 * @param obj The web object
13716 * @param uri The URI to set
13717 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13719 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13721 * Gets the current URI for the object
13723 * The returned string must not be freed and is guaranteed to be
13726 * @param obj The web object
13727 * @return A stringshared internal string with the current URI, or NULL on
13730 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13732 * Gets the current title
13734 * The returned string must not be freed and is guaranteed to be
13737 * @param obj The web object
13738 * @return A stringshared internal string with the current title, or NULL on
13741 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13743 * Sets the background color to be used by the web object
13745 * This is the color that will be used by default when the loaded page
13746 * does not set it's own. Color values are pre-multiplied.
13748 * @param obj The web object
13749 * @param r Red component
13750 * @param g Green component
13751 * @param b Blue component
13752 * @param a Alpha component
13754 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13756 * Gets the background color to be used by the web object
13758 * This is the color that will be used by default when the loaded page
13759 * does not set it's own. Color values are pre-multiplied.
13761 * @param obj The web object
13762 * @param r Red component
13763 * @param g Green component
13764 * @param b Blue component
13765 * @param a Alpha component
13767 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13769 * Gets a copy of the currently selected text
13771 * The string returned must be freed by the user when it's done with it.
13773 * @param obj The web object
13774 * @return A newly allocated string, or NULL if nothing is selected or an
13777 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13779 * Tells the web object which index in the currently open popup was selected
13781 * When the user handles the popup creation from the "popup,created" signal,
13782 * it needs to tell the web object which item was selected by calling this
13783 * function with the index corresponding to the item.
13785 * @param obj The web object
13786 * @param index The index selected
13788 * @see elm_web_popup_destroy()
13790 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13792 * Dismisses an open dropdown popup
13794 * When the popup from a dropdown widget is to be dismissed, either after
13795 * selecting an option or to cancel it, this function must be called, which
13796 * will later emit an "popup,willdelete" signal to notify the user that
13797 * any memory and objects related to this popup can be freed.
13799 * @param obj The web object
13800 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13801 * if there was no menu to destroy
13803 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13805 * Searches the given string in a document.
13807 * @param obj The web object where to search the text
13808 * @param string String to search
13809 * @param case_sensitive If search should be case sensitive or not
13810 * @param forward If search is from cursor and on or backwards
13811 * @param wrap If search should wrap at the end
13813 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13816 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13818 * Marks matches of the given string in a document.
13820 * @param obj The web object where to search text
13821 * @param string String to match
13822 * @param case_sensitive If match should be case sensitive or not
13823 * @param highlight If matches should be highlighted
13824 * @param limit Maximum amount of matches, or zero to unlimited
13826 * @return number of matched @a string
13828 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13830 * Clears all marked matches in the document
13832 * @param obj The web object
13834 * @return EINA_TRUE on success, EINA_FALSE otherwise
13836 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13838 * Sets whether to highlight the matched marks
13840 * If enabled, marks set with elm_web_text_matches_mark() will be
13843 * @param obj The web object
13844 * @param highlight Whether to highlight the marks or not
13846 * @return EINA_TRUE on success, EINA_FALSE otherwise
13848 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13850 * Gets whether highlighting marks is enabled
13852 * @param The web object
13854 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13857 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13859 * Gets the overall loading progress of the page
13861 * Returns the estimated loading progress of the page, with a value between
13862 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13863 * included in the page.
13865 * @param The web object
13867 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13870 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13872 * Stops loading the current page
13874 * Cancels the loading of the current page in the web object. This will
13875 * cause a "load,error" signal to be emitted, with the is_cancellation
13876 * flag set to EINA_TRUE.
13878 * @param obj The web object
13880 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13882 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13884 * Requests a reload of the current document in the object
13886 * @param obj The web object
13888 * @return EINA_TRUE on success, EINA_FALSE otherwise
13890 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13892 * Requests a reload of the current document, avoiding any existing caches
13894 * @param obj The web object
13896 * @return EINA_TRUE on success, EINA_FALSE otherwise
13898 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13900 * Goes back one step in the browsing history
13902 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13904 * @param obj The web object
13906 * @return EINA_TRUE on success, EINA_FALSE otherwise
13908 * @see elm_web_history_enable_set()
13909 * @see elm_web_back_possible()
13910 * @see elm_web_forward()
13911 * @see elm_web_navigate()
13913 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13915 * Goes forward one step in the browsing history
13917 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13919 * @param obj The web object
13921 * @return EINA_TRUE on success, EINA_FALSE otherwise
13923 * @see elm_web_history_enable_set()
13924 * @see elm_web_forward_possible()
13925 * @see elm_web_back()
13926 * @see elm_web_navigate()
13928 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13930 * Jumps the given number of steps in the browsing history
13932 * The @p steps value can be a negative integer to back in history, or a
13933 * positive to move forward.
13935 * @param obj The web object
13936 * @param steps The number of steps to jump
13938 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13939 * history exists to jump the given number of steps
13941 * @see elm_web_history_enable_set()
13942 * @see elm_web_navigate_possible()
13943 * @see elm_web_back()
13944 * @see elm_web_forward()
13946 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13948 * Queries whether it's possible to go back in history
13950 * @param obj The web object
13952 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13955 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13957 * Queries whether it's possible to go forward in history
13959 * @param obj The web object
13961 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13964 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13966 * Queries whether it's possible to jump the given number of steps
13968 * The @p steps value can be a negative integer to back in history, or a
13969 * positive to move forward.
13971 * @param obj The web object
13972 * @param steps The number of steps to check for
13974 * @return EINA_TRUE if enough history exists to perform the given jump,
13975 * EINA_FALSE otherwise
13977 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13979 * Gets whether browsing history is enabled for the given object
13981 * @param obj The web object
13983 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13985 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13987 * Enables or disables the browsing history
13989 * @param obj The web object
13990 * @param enable Whether to enable or disable the browsing history
13992 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13994 * Sets the zoom level of the web object
13996 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13997 * values meaning zoom in and lower meaning zoom out. This function will
13998 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13999 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14001 * @param obj The web object
14002 * @param zoom The zoom level to set
14004 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14006 * Gets the current zoom level set on the web object
14008 * Note that this is the zoom level set on the web object and not that
14009 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14010 * the two zoom levels should match, but for the other two modes the
14011 * Webkit zoom is calculated internally to match the chosen mode without
14012 * changing the zoom level set for the web object.
14014 * @param obj The web object
14016 * @return The zoom level set on the object
14018 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14020 * Sets the zoom mode to use
14022 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14023 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14025 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14026 * with the elm_web_zoom_set() function.
14027 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14028 * make sure the entirety of the web object's contents are shown.
14029 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14030 * fit the contents in the web object's size, without leaving any space
14033 * @param obj The web object
14034 * @param mode The mode to set
14036 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14038 * Gets the currently set zoom mode
14040 * @param obj The web object
14042 * @return The current zoom mode set for the object, or
14043 * ::ELM_WEB_ZOOM_MODE_LAST on error
14045 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14047 * Shows the given region in the web object
14049 * @param obj The web object
14050 * @param x The x coordinate of the region to show
14051 * @param y The y coordinate of the region to show
14052 * @param w The width of the region to show
14053 * @param h The height of the region to show
14055 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14057 * Brings in the region to the visible area
14059 * Like elm_web_region_show(), but it animates the scrolling of the object
14062 * @param obj The web object
14063 * @param x The x coordinate of the region to show
14064 * @param y The y coordinate of the region to show
14065 * @param w The width of the region to show
14066 * @param h The height of the region to show
14068 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14070 * Sets the default dialogs to use an Inwin instead of a normal window
14072 * If set, then the default implementation for the JavaScript dialogs and
14073 * file selector will be opened in an Inwin. Otherwise they will use a
14074 * normal separated window.
14076 * @param obj The web object
14077 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14079 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14081 * Gets whether Inwin mode is set for the current object
14083 * @param obj The web object
14085 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14087 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14089 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14090 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14091 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);
14092 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14099 * @defgroup Hoversel Hoversel
14101 * @image html img/widget/hoversel/preview-00.png
14102 * @image latex img/widget/hoversel/preview-00.eps
14104 * A hoversel is a button that pops up a list of items (automatically
14105 * choosing the direction to display) that have a label and, optionally, an
14106 * icon to select from. It is a convenience widget to avoid the need to do
14107 * all the piecing together yourself. It is intended for a small number of
14108 * items in the hoversel menu (no more than 8), though is capable of many
14111 * Signals that you can add callbacks for are:
14112 * "clicked" - the user clicked the hoversel button and popped up the sel
14113 * "selected" - an item in the hoversel list is selected. event_info is the item
14114 * "dismissed" - the hover is dismissed
14116 * See @ref tutorial_hoversel for an example.
14119 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14121 * @brief Add a new Hoversel object
14123 * @param parent The parent object
14124 * @return The new object or NULL if it cannot be created
14126 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14128 * @brief This sets the hoversel to expand horizontally.
14130 * @param obj The hoversel object
14131 * @param horizontal If true, the hover will expand horizontally to the
14134 * @note The initial button will display horizontally regardless of this
14137 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14139 * @brief This returns whether the hoversel is set to expand horizontally.
14141 * @param obj The hoversel object
14142 * @return If true, the hover will expand horizontally to the right.
14144 * @see elm_hoversel_horizontal_set()
14146 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14148 * @brief Set the Hover parent
14150 * @param obj The hoversel object
14151 * @param parent The parent to use
14153 * Sets the hover parent object, the area that will be darkened when the
14154 * hoversel is clicked. Should probably be the window that the hoversel is
14155 * in. See @ref Hover objects for more information.
14157 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14159 * @brief Get the Hover parent
14161 * @param obj The hoversel object
14162 * @return The used parent
14164 * Gets the hover parent object.
14166 * @see elm_hoversel_hover_parent_set()
14168 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14170 * @brief Set the hoversel button label
14172 * @param obj The hoversel object
14173 * @param label The label text.
14175 * This sets the label of the button that is always visible (before it is
14176 * clicked and expanded).
14178 * @deprecated elm_object_text_set()
14180 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14182 * @brief Get the hoversel button label
14184 * @param obj The hoversel object
14185 * @return The label text.
14187 * @deprecated elm_object_text_get()
14189 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14191 * @brief Set the icon of the hoversel button
14193 * @param obj The hoversel object
14194 * @param icon The icon object
14196 * Sets the icon of the button that is always visible (before it is clicked
14197 * and expanded). Once the icon object is set, a previously set one will be
14198 * deleted, if you want to keep that old content object, use the
14199 * elm_hoversel_icon_unset() function.
14201 * @see elm_object_content_set() for the button widget
14203 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14205 * @brief Get the icon of the hoversel button
14207 * @param obj The hoversel object
14208 * @return The icon object
14210 * Get the icon of the button that is always visible (before it is clicked
14211 * and expanded). Also see elm_object_content_get() for the button widget.
14213 * @see elm_hoversel_icon_set()
14215 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14217 * @brief Get and unparent the icon of the hoversel button
14219 * @param obj The hoversel object
14220 * @return The icon object that was being used
14222 * Unparent and return the icon of the button that is always visible
14223 * (before it is clicked and expanded).
14225 * @see elm_hoversel_icon_set()
14226 * @see elm_object_content_unset() for the button widget
14228 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14230 * @brief This triggers the hoversel popup from code, the same as if the user
14231 * had clicked the button.
14233 * @param obj The hoversel object
14235 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14237 * @brief This dismisses the hoversel popup as if the user had clicked
14238 * outside the hover.
14240 * @param obj The hoversel object
14242 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14244 * @brief Returns whether the hoversel is expanded.
14246 * @param obj The hoversel object
14247 * @return This will return EINA_TRUE if the hoversel is expanded or
14248 * EINA_FALSE if it is not expanded.
14250 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14252 * @brief This will remove all the children items from the hoversel.
14254 * @param obj The hoversel object
14256 * @warning Should @b not be called while the hoversel is active; use
14257 * elm_hoversel_expanded_get() to check first.
14259 * @see elm_hoversel_item_del_cb_set()
14260 * @see elm_hoversel_item_del()
14262 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14264 * @brief Get the list of items within the given hoversel.
14266 * @param obj The hoversel object
14267 * @return Returns a list of Elm_Hoversel_Item*
14269 * @see elm_hoversel_item_add()
14271 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14273 * @brief Add an item to the hoversel button
14275 * @param obj The hoversel object
14276 * @param label The text label to use for the item (NULL if not desired)
14277 * @param icon_file An image file path on disk to use for the icon or standard
14278 * icon name (NULL if not desired)
14279 * @param icon_type The icon type if relevant
14280 * @param func Convenience function to call when this item is selected
14281 * @param data Data to pass to item-related functions
14282 * @return A handle to the item added.
14284 * This adds an item to the hoversel to show when it is clicked. Note: if you
14285 * need to use an icon from an edje file then use
14286 * elm_hoversel_item_icon_set() right after the this function, and set
14287 * icon_file to NULL here.
14289 * For more information on what @p icon_file and @p icon_type are see the
14290 * @ref Icon "icon documentation".
14292 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);
14294 * @brief Delete an item from the hoversel
14296 * @param item The item to delete
14298 * This deletes the item from the hoversel (should not be called while the
14299 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14301 * @see elm_hoversel_item_add()
14302 * @see elm_hoversel_item_del_cb_set()
14304 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14306 * @brief Set the function to be called when an item from the hoversel is
14309 * @param item The item to set the callback on
14310 * @param func The function called
14312 * That function will receive these parameters:
14313 * @li void *item_data
14314 * @li Evas_Object *the_item_object
14315 * @li Elm_Hoversel_Item *the_object_struct
14317 * @see elm_hoversel_item_add()
14319 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14321 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14322 * that will be passed to associated function callbacks.
14324 * @param item The item to get the data from
14325 * @return The data pointer set with elm_hoversel_item_add()
14327 * @see elm_hoversel_item_add()
14329 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14331 * @brief This returns the label text of the given hoversel item.
14333 * @param item The item to get the label
14334 * @return The label text of the hoversel item
14336 * @see elm_hoversel_item_add()
14338 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14340 * @brief This sets the icon for the given hoversel item.
14342 * @param item The item to set the icon
14343 * @param icon_file An image file path on disk to use for the icon or standard
14345 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14346 * to NULL if the icon is not an edje file
14347 * @param icon_type The icon type
14349 * The icon can be loaded from the standard set, from an image file, or from
14352 * @see elm_hoversel_item_add()
14354 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);
14356 * @brief Get the icon object of the hoversel item
14358 * @param item The item to get the icon from
14359 * @param icon_file The image file path on disk used for the icon or standard
14361 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14362 * if the icon is not an edje file
14363 * @param icon_type The icon type
14365 * @see elm_hoversel_item_icon_set()
14366 * @see elm_hoversel_item_add()
14368 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);
14374 * @defgroup Toolbar Toolbar
14375 * @ingroup Elementary
14377 * @image html img/widget/toolbar/preview-00.png
14378 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14380 * @image html img/toolbar.png
14381 * @image latex img/toolbar.eps width=\textwidth
14383 * A toolbar is a widget that displays a list of items inside
14384 * a box. It can be scrollable, show a menu with items that don't fit
14385 * to toolbar size or even crop them.
14387 * Only one item can be selected at a time.
14389 * Items can have multiple states, or show menus when selected by the user.
14391 * Smart callbacks one can listen to:
14392 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14393 * - "language,changed" - when the program language changes
14395 * Available styles for it:
14397 * - @c "transparent" - no background or shadow, just show the content
14399 * List of examples:
14400 * @li @ref toolbar_example_01
14401 * @li @ref toolbar_example_02
14402 * @li @ref toolbar_example_03
14406 * @addtogroup Toolbar
14411 * @enum _Elm_Toolbar_Shrink_Mode
14412 * @typedef Elm_Toolbar_Shrink_Mode
14414 * Set toolbar's items display behavior, it can be scrollabel,
14415 * show a menu with exceeding items, or simply hide them.
14417 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14420 * Values <b> don't </b> work as bitmask, only one can be choosen.
14422 * @see elm_toolbar_mode_shrink_set()
14423 * @see elm_toolbar_mode_shrink_get()
14427 typedef enum _Elm_Toolbar_Shrink_Mode
14429 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14430 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14431 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14432 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14433 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14434 } Elm_Toolbar_Shrink_Mode;
14436 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(). */
14438 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(). */
14441 * Add a new toolbar widget to the given parent Elementary
14442 * (container) object.
14444 * @param parent The parent object.
14445 * @return a new toolbar widget handle or @c NULL, on errors.
14447 * This function inserts a new toolbar widget on the canvas.
14451 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14454 * Set the icon size, in pixels, to be used by toolbar items.
14456 * @param obj The toolbar object
14457 * @param icon_size The icon size in pixels
14459 * @note Default value is @c 32. It reads value from elm config.
14461 * @see elm_toolbar_icon_size_get()
14465 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14468 * Get the icon size, in pixels, to be used by toolbar items.
14470 * @param obj The toolbar object.
14471 * @return The icon size in pixels.
14473 * @see elm_toolbar_icon_size_set() for details.
14477 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14480 * Sets icon lookup order, for toolbar items' icons.
14482 * @param obj The toolbar object.
14483 * @param order The icon lookup order.
14485 * Icons added before calling this function will not be affected.
14486 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14488 * @see elm_toolbar_icon_order_lookup_get()
14492 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14495 * Gets the icon lookup order.
14497 * @param obj The toolbar object.
14498 * @return The icon lookup order.
14500 * @see elm_toolbar_icon_order_lookup_set() for details.
14504 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14507 * Set whether the toolbar should always have an item selected.
14509 * @param obj The toolbar object.
14510 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14513 * This will cause the toolbar to always have an item selected, and clicking
14514 * the selected item will not cause a selected event to be emitted. Enabling this mode
14515 * will immediately select the first toolbar item.
14517 * Always-selected is disabled by default.
14519 * @see elm_toolbar_always_select_mode_get().
14523 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14526 * Get whether the toolbar should always have an item selected.
14528 * @param obj The toolbar object.
14529 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14530 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14532 * @see elm_toolbar_always_select_mode_set() for details.
14536 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14539 * Set whether the toolbar items' should be selected by the user or not.
14541 * @param obj The toolbar object.
14542 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14545 * This will turn off the ability to select items entirely and they will
14546 * neither appear selected nor emit selected signals. The clicked
14547 * callback function will still be called.
14549 * Selection is enabled by default.
14551 * @see elm_toolbar_no_select_mode_get().
14555 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14558 * Set whether the toolbar items' should be selected by the user or not.
14560 * @param obj The toolbar object.
14561 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14562 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14564 * @see elm_toolbar_no_select_mode_set() for details.
14568 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14571 * Append item to the toolbar.
14573 * @param obj The toolbar object.
14574 * @param icon A string with icon name or the absolute path of an image file.
14575 * @param label The label of the item.
14576 * @param func The function to call when the item is clicked.
14577 * @param data The data to associate with the item for related callbacks.
14578 * @return The created item or @c NULL upon failure.
14580 * A new item will be created and appended to the toolbar, i.e., will
14581 * be set as @b last item.
14583 * Items created with this method can be deleted with
14584 * elm_toolbar_item_del().
14586 * Associated @p data can be properly freed when item is deleted if a
14587 * callback function is set with elm_toolbar_item_del_cb_set().
14589 * If a function is passed as argument, it will be called everytime this item
14590 * is selected, i.e., the user clicks over an unselected item.
14591 * If such function isn't needed, just passing
14592 * @c NULL as @p func is enough. The same should be done for @p data.
14594 * Toolbar will load icon image from fdo or current theme.
14595 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14596 * If an absolute path is provided it will load it direct from a file.
14598 * @see elm_toolbar_item_icon_set()
14599 * @see elm_toolbar_item_del()
14600 * @see elm_toolbar_item_del_cb_set()
14604 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);
14607 * Prepend item to the toolbar.
14609 * @param obj The toolbar object.
14610 * @param icon A string with icon name or the absolute path of an image file.
14611 * @param label The label of the item.
14612 * @param func The function to call when the item is clicked.
14613 * @param data The data to associate with the item for related callbacks.
14614 * @return The created item or @c NULL upon failure.
14616 * A new item will be created and prepended to the toolbar, i.e., will
14617 * be set as @b first item.
14619 * Items created with this method can be deleted with
14620 * elm_toolbar_item_del().
14622 * Associated @p data can be properly freed when item is deleted if a
14623 * callback function is set with elm_toolbar_item_del_cb_set().
14625 * If a function is passed as argument, it will be called everytime this item
14626 * is selected, i.e., the user clicks over an unselected item.
14627 * If such function isn't needed, just passing
14628 * @c NULL as @p func is enough. The same should be done for @p data.
14630 * Toolbar will load icon image from fdo or current theme.
14631 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14632 * If an absolute path is provided it will load it direct from a file.
14634 * @see elm_toolbar_item_icon_set()
14635 * @see elm_toolbar_item_del()
14636 * @see elm_toolbar_item_del_cb_set()
14640 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);
14643 * Insert a new item into the toolbar object before item @p before.
14645 * @param obj The toolbar object.
14646 * @param before The toolbar item to insert before.
14647 * @param icon A string with icon name or the absolute path of an image file.
14648 * @param label The label of the item.
14649 * @param func The function to call when the item is clicked.
14650 * @param data The data to associate with the item for related callbacks.
14651 * @return The created item or @c NULL upon failure.
14653 * A new item will be created and added to the toolbar. Its position in
14654 * this toolbar will be just before item @p before.
14656 * Items created with this method can be deleted with
14657 * elm_toolbar_item_del().
14659 * Associated @p data can be properly freed when item is deleted if a
14660 * callback function is set with elm_toolbar_item_del_cb_set().
14662 * If a function is passed as argument, it will be called everytime this item
14663 * is selected, i.e., the user clicks over an unselected item.
14664 * If such function isn't needed, just passing
14665 * @c NULL as @p func is enough. The same should be done for @p data.
14667 * Toolbar will load icon image from fdo or current theme.
14668 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14669 * If an absolute path is provided it will load it direct from a file.
14671 * @see elm_toolbar_item_icon_set()
14672 * @see elm_toolbar_item_del()
14673 * @see elm_toolbar_item_del_cb_set()
14677 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);
14680 * Insert a new item into the toolbar object after item @p after.
14682 * @param obj The toolbar object.
14683 * @param after The toolbar item to insert after.
14684 * @param icon A string with icon name or the absolute path of an image file.
14685 * @param label The label of the item.
14686 * @param func The function to call when the item is clicked.
14687 * @param data The data to associate with the item for related callbacks.
14688 * @return The created item or @c NULL upon failure.
14690 * A new item will be created and added to the toolbar. Its position in
14691 * this toolbar will be just after item @p after.
14693 * Items created with this method can be deleted with
14694 * elm_toolbar_item_del().
14696 * Associated @p data can be properly freed when item is deleted if a
14697 * callback function is set with elm_toolbar_item_del_cb_set().
14699 * If a function is passed as argument, it will be called everytime this item
14700 * is selected, i.e., the user clicks over an unselected item.
14701 * If such function isn't needed, just passing
14702 * @c NULL as @p func is enough. The same should be done for @p data.
14704 * Toolbar will load icon image from fdo or current theme.
14705 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14706 * If an absolute path is provided it will load it direct from a file.
14708 * @see elm_toolbar_item_icon_set()
14709 * @see elm_toolbar_item_del()
14710 * @see elm_toolbar_item_del_cb_set()
14714 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);
14717 * Get the first item in the given toolbar widget's list of
14720 * @param obj The toolbar object
14721 * @return The first item or @c NULL, if it has no items (and on
14724 * @see elm_toolbar_item_append()
14725 * @see elm_toolbar_last_item_get()
14729 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14732 * Get the last item in the given toolbar widget's list of
14735 * @param obj The toolbar object
14736 * @return The last item or @c NULL, if it has no items (and on
14739 * @see elm_toolbar_item_prepend()
14740 * @see elm_toolbar_first_item_get()
14744 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14747 * Get the item after @p item in toolbar.
14749 * @param item The toolbar item.
14750 * @return The item after @p item, or @c NULL if none or on failure.
14752 * @note If it is the last item, @c NULL will be returned.
14754 * @see elm_toolbar_item_append()
14758 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14761 * Get the item before @p item in toolbar.
14763 * @param item The toolbar item.
14764 * @return The item before @p item, or @c NULL if none or on failure.
14766 * @note If it is the first item, @c NULL will be returned.
14768 * @see elm_toolbar_item_prepend()
14772 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14775 * Get the toolbar object from an item.
14777 * @param item The item.
14778 * @return The toolbar object.
14780 * This returns the toolbar object itself that an item belongs to.
14784 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14787 * Set the priority of a toolbar item.
14789 * @param item The toolbar item.
14790 * @param priority The item priority. The default is zero.
14792 * This is used only when the toolbar shrink mode is set to
14793 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14794 * When space is less than required, items with low priority
14795 * will be removed from the toolbar and added to a dynamically-created menu,
14796 * while items with higher priority will remain on the toolbar,
14797 * with the same order they were added.
14799 * @see elm_toolbar_item_priority_get()
14803 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14806 * Get the priority of a toolbar item.
14808 * @param item The toolbar item.
14809 * @return The @p item priority, or @c 0 on failure.
14811 * @see elm_toolbar_item_priority_set() for details.
14815 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14818 * Get the label of item.
14820 * @param item The item of toolbar.
14821 * @return The label of item.
14823 * The return value is a pointer to the label associated to @p item when
14824 * it was created, with function elm_toolbar_item_append() or similar,
14826 * with function elm_toolbar_item_label_set. If no label
14827 * was passed as argument, it will return @c NULL.
14829 * @see elm_toolbar_item_label_set() for more details.
14830 * @see elm_toolbar_item_append()
14834 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14837 * Set the label of item.
14839 * @param item The item of toolbar.
14840 * @param text The label of item.
14842 * The label to be displayed by the item.
14843 * Label will be placed at icons bottom (if set).
14845 * If a label was passed as argument on item creation, with function
14846 * elm_toolbar_item_append() or similar, it will be already
14847 * displayed by the item.
14849 * @see elm_toolbar_item_label_get()
14850 * @see elm_toolbar_item_append()
14854 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14857 * Return the data associated with a given toolbar widget item.
14859 * @param item The toolbar widget item handle.
14860 * @return The data associated with @p item.
14862 * @see elm_toolbar_item_data_set()
14866 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14869 * Set the data associated with a given toolbar widget item.
14871 * @param item The toolbar widget item handle.
14872 * @param data The new data pointer to set to @p item.
14874 * This sets new item data on @p item.
14876 * @warning The old data pointer won't be touched by this function, so
14877 * the user had better to free that old data himself/herself.
14881 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14884 * Returns a pointer to a toolbar item by its label.
14886 * @param obj The toolbar object.
14887 * @param label The label of the item to find.
14889 * @return The pointer to the toolbar item matching @p label or @c NULL
14894 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14897 * Get whether the @p item is selected or not.
14899 * @param item The toolbar item.
14900 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14901 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14903 * @see elm_toolbar_selected_item_set() for details.
14904 * @see elm_toolbar_item_selected_get()
14908 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14911 * Set the selected state of an item.
14913 * @param item The toolbar item
14914 * @param selected The selected state
14916 * This sets the selected state of the given item @p it.
14917 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14919 * If a new item is selected the previosly selected will be unselected.
14920 * Previoulsy selected item can be get with function
14921 * elm_toolbar_selected_item_get().
14923 * Selected items will be highlighted.
14925 * @see elm_toolbar_item_selected_get()
14926 * @see elm_toolbar_selected_item_get()
14930 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14933 * Get the selected item.
14935 * @param obj The toolbar object.
14936 * @return The selected toolbar item.
14938 * The selected item can be unselected with function
14939 * elm_toolbar_item_selected_set().
14941 * The selected item always will be highlighted on toolbar.
14943 * @see elm_toolbar_selected_items_get()
14947 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14950 * Set the icon associated with @p item.
14952 * @param obj The parent of this item.
14953 * @param item The toolbar item.
14954 * @param icon A string with icon name or the absolute path of an image file.
14956 * Toolbar will load icon image from fdo or current theme.
14957 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14958 * If an absolute path is provided it will load it direct from a file.
14960 * @see elm_toolbar_icon_order_lookup_set()
14961 * @see elm_toolbar_icon_order_lookup_get()
14965 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14968 * Get the string used to set the icon of @p item.
14970 * @param item The toolbar item.
14971 * @return The string associated with the icon object.
14973 * @see elm_toolbar_item_icon_set() for details.
14977 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14980 * Get the object of @p item.
14982 * @param item The toolbar item.
14983 * @return The object
14987 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14990 * Get the icon object of @p item.
14992 * @param item The toolbar item.
14993 * @return The icon object
14995 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14999 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15002 * Set the icon associated with @p item to an image in a binary buffer.
15004 * @param item The toolbar item.
15005 * @param img The binary data that will be used as an image
15006 * @param size The size of binary data @p img
15007 * @param format Optional format of @p img to pass to the image loader
15008 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15010 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15012 * @note The icon image set by this function can be changed by
15013 * elm_toolbar_item_icon_set().
15017 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);
15020 * Delete them item from the toolbar.
15022 * @param item The item of toolbar to be deleted.
15024 * @see elm_toolbar_item_append()
15025 * @see elm_toolbar_item_del_cb_set()
15029 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15032 * Set the function called when a toolbar item is freed.
15034 * @param item The item to set the callback on.
15035 * @param func The function called.
15037 * If there is a @p func, then it will be called prior item's memory release.
15038 * That will be called with the following arguments:
15040 * @li item's Evas object;
15043 * This way, a data associated to a toolbar item could be properly freed.
15047 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15050 * Get a value whether toolbar item is disabled or not.
15052 * @param item The item.
15053 * @return The disabled state.
15055 * @see elm_toolbar_item_disabled_set() for more details.
15059 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15062 * Sets the disabled/enabled state of a toolbar item.
15064 * @param item The item.
15065 * @param disabled The disabled state.
15067 * A disabled item cannot be selected or unselected. It will also
15068 * change its appearance (generally greyed out). This sets the
15069 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15074 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15077 * Set or unset item as a separator.
15079 * @param item The toolbar item.
15080 * @param setting @c EINA_TRUE to set item @p item as separator or
15081 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15083 * Items aren't set as separator by default.
15085 * If set as separator it will display separator theme, so won't display
15088 * @see elm_toolbar_item_separator_get()
15092 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15095 * Get a value whether item is a separator or not.
15097 * @param item The toolbar item.
15098 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15099 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15101 * @see elm_toolbar_item_separator_set() for details.
15105 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15108 * Set the shrink state of toolbar @p obj.
15110 * @param obj The toolbar object.
15111 * @param shrink_mode Toolbar's items display behavior.
15113 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15114 * but will enforce a minimun size so all the items will fit, won't scroll
15115 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15116 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15117 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15121 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15124 * Get the shrink mode of toolbar @p obj.
15126 * @param obj The toolbar object.
15127 * @return Toolbar's items display behavior.
15129 * @see elm_toolbar_mode_shrink_set() for details.
15133 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15136 * Enable/disable homogenous mode.
15138 * @param obj The toolbar object
15139 * @param homogeneous Assume the items within the toolbar are of the
15140 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15142 * This will enable the homogeneous mode where items are of the same size.
15143 * @see elm_toolbar_homogeneous_get()
15147 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15150 * Get whether the homogenous mode is enabled.
15152 * @param obj The toolbar object.
15153 * @return Assume the items within the toolbar are of the same height
15154 * and width (EINA_TRUE = on, EINA_FALSE = off).
15156 * @see elm_toolbar_homogeneous_set()
15160 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15163 * Enable/disable homogenous mode.
15165 * @param obj The toolbar object
15166 * @param homogeneous Assume the items within the toolbar are of the
15167 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15169 * This will enable the homogeneous mode where items are of the same size.
15170 * @see elm_toolbar_homogeneous_get()
15172 * @deprecated use elm_toolbar_homogeneous_set() instead.
15176 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15179 * Get whether the homogenous mode is enabled.
15181 * @param obj The toolbar object.
15182 * @return Assume the items within the toolbar are of the same height
15183 * and width (EINA_TRUE = on, EINA_FALSE = off).
15185 * @see elm_toolbar_homogeneous_set()
15186 * @deprecated use elm_toolbar_homogeneous_get() instead.
15190 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15193 * Set the parent object of the toolbar items' menus.
15195 * @param obj The toolbar object.
15196 * @param parent The parent of the menu objects.
15198 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15200 * For more details about setting the parent for toolbar menus, see
15201 * elm_menu_parent_set().
15203 * @see elm_menu_parent_set() for details.
15204 * @see elm_toolbar_item_menu_set() for details.
15208 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15211 * Get the parent object of the toolbar items' menus.
15213 * @param obj The toolbar object.
15214 * @return The parent of the menu objects.
15216 * @see elm_toolbar_menu_parent_set() for details.
15220 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15223 * Set the alignment of the items.
15225 * @param obj The toolbar object.
15226 * @param align The new alignment, a float between <tt> 0.0 </tt>
15227 * and <tt> 1.0 </tt>.
15229 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15230 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15233 * Centered items by default.
15235 * @see elm_toolbar_align_get()
15239 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15242 * Get the alignment of the items.
15244 * @param obj The toolbar object.
15245 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15248 * @see elm_toolbar_align_set() for details.
15252 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15255 * Set whether the toolbar item opens a menu.
15257 * @param item The toolbar item.
15258 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15260 * A toolbar item can be set to be a menu, using this function.
15262 * Once it is set to be a menu, it can be manipulated through the
15263 * menu-like function elm_toolbar_menu_parent_set() and the other
15264 * elm_menu functions, using the Evas_Object @c menu returned by
15265 * elm_toolbar_item_menu_get().
15267 * So, items to be displayed in this item's menu should be added with
15268 * elm_menu_item_add().
15270 * The following code exemplifies the most basic usage:
15272 * tb = elm_toolbar_add(win)
15273 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15274 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15275 * elm_toolbar_menu_parent_set(tb, win);
15276 * menu = elm_toolbar_item_menu_get(item);
15277 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15278 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15282 * @see elm_toolbar_item_menu_get()
15286 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15289 * Get toolbar item's menu.
15291 * @param item The toolbar item.
15292 * @return Item's menu object or @c NULL on failure.
15294 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15295 * this function will set it.
15297 * @see elm_toolbar_item_menu_set() for details.
15301 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15304 * Add a new state to @p item.
15306 * @param item The item.
15307 * @param icon A string with icon name or the absolute path of an image file.
15308 * @param label The label of the new state.
15309 * @param func The function to call when the item is clicked when this
15310 * state is selected.
15311 * @param data The data to associate with the state.
15312 * @return The toolbar item state, or @c NULL upon failure.
15314 * Toolbar will load icon image from fdo or current theme.
15315 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15316 * If an absolute path is provided it will load it direct from a file.
15318 * States created with this function can be removed with
15319 * elm_toolbar_item_state_del().
15321 * @see elm_toolbar_item_state_del()
15322 * @see elm_toolbar_item_state_sel()
15323 * @see elm_toolbar_item_state_get()
15327 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);
15330 * Delete a previoulsy added state to @p item.
15332 * @param item The toolbar item.
15333 * @param state The state to be deleted.
15334 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15336 * @see elm_toolbar_item_state_add()
15338 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15341 * Set @p state as the current state of @p it.
15343 * @param it The item.
15344 * @param state The state to use.
15345 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15347 * If @p state is @c NULL, it won't select any state and the default item's
15348 * icon and label will be used. It's the same behaviour than
15349 * elm_toolbar_item_state_unser().
15351 * @see elm_toolbar_item_state_unset()
15355 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15358 * Unset the state of @p it.
15360 * @param it The item.
15362 * The default icon and label from this item will be displayed.
15364 * @see elm_toolbar_item_state_set() for more details.
15368 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15371 * Get the current state of @p it.
15373 * @param item The item.
15374 * @return The selected state or @c NULL if none is selected or on failure.
15376 * @see elm_toolbar_item_state_set() for details.
15377 * @see elm_toolbar_item_state_unset()
15378 * @see elm_toolbar_item_state_add()
15382 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15385 * Get the state after selected state in toolbar's @p item.
15387 * @param it The toolbar item to change state.
15388 * @return The state after current state, or @c NULL on failure.
15390 * If last state is selected, this function will return first state.
15392 * @see elm_toolbar_item_state_set()
15393 * @see elm_toolbar_item_state_add()
15397 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15400 * Get the state before selected state in toolbar's @p item.
15402 * @param it The toolbar item to change state.
15403 * @return The state before current state, or @c NULL on failure.
15405 * If first state is selected, this function will return last state.
15407 * @see elm_toolbar_item_state_set()
15408 * @see elm_toolbar_item_state_add()
15412 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15415 * Set the text to be shown in a given toolbar item's tooltips.
15417 * @param item Target item.
15418 * @param text The text to set in the content.
15420 * Setup the text as tooltip to object. The item can have only one tooltip,
15421 * so any previous tooltip data - set with this function or
15422 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15424 * @see elm_object_tooltip_text_set() for more details.
15428 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15431 * Set the content to be shown in the tooltip item.
15433 * Setup the tooltip to item. The item can have only one tooltip,
15434 * so any previous tooltip data is removed. @p func(with @p data) will
15435 * be called every time that need show the tooltip and it should
15436 * return a valid Evas_Object. This object is then managed fully by
15437 * tooltip system and is deleted when the tooltip is gone.
15439 * @param item the toolbar item being attached a tooltip.
15440 * @param func the function used to create the tooltip contents.
15441 * @param data what to provide to @a func as callback data/context.
15442 * @param del_cb called when data is not needed anymore, either when
15443 * another callback replaces @a func, the tooltip is unset with
15444 * elm_toolbar_item_tooltip_unset() or the owner @a item
15445 * dies. This callback receives as the first parameter the
15446 * given @a data, and @c event_info is the item.
15448 * @see elm_object_tooltip_content_cb_set() for more details.
15452 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);
15455 * Unset tooltip from item.
15457 * @param item toolbar item to remove previously set tooltip.
15459 * Remove tooltip from item. The callback provided as del_cb to
15460 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15461 * it is not used anymore.
15463 * @see elm_object_tooltip_unset() for more details.
15464 * @see elm_toolbar_item_tooltip_content_cb_set()
15468 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15471 * Sets a different style for this item tooltip.
15473 * @note before you set a style you should define a tooltip with
15474 * elm_toolbar_item_tooltip_content_cb_set() or
15475 * elm_toolbar_item_tooltip_text_set()
15477 * @param item toolbar item with tooltip already set.
15478 * @param style the theme style to use (default, transparent, ...)
15480 * @see elm_object_tooltip_style_set() for more details.
15484 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15487 * Get the style for this item tooltip.
15489 * @param item toolbar item with tooltip already set.
15490 * @return style the theme style in use, defaults to "default". If the
15491 * object does not have a tooltip set, then NULL is returned.
15493 * @see elm_object_tooltip_style_get() for more details.
15494 * @see elm_toolbar_item_tooltip_style_set()
15498 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15501 * Set the type of mouse pointer/cursor decoration to be shown,
15502 * when the mouse pointer is over the given toolbar widget item
15504 * @param item toolbar item to customize cursor on
15505 * @param cursor the cursor type's name
15507 * This function works analogously as elm_object_cursor_set(), but
15508 * here the cursor's changing area is restricted to the item's
15509 * area, and not the whole widget's. Note that that item cursors
15510 * have precedence over widget cursors, so that a mouse over an
15511 * item with custom cursor set will always show @b that cursor.
15513 * If this function is called twice for an object, a previously set
15514 * cursor will be unset on the second call.
15516 * @see elm_object_cursor_set()
15517 * @see elm_toolbar_item_cursor_get()
15518 * @see elm_toolbar_item_cursor_unset()
15522 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15525 * Get the type of mouse pointer/cursor decoration set to be shown,
15526 * when the mouse pointer is over the given toolbar widget item
15528 * @param item toolbar item with custom cursor set
15529 * @return the cursor type's name or @c NULL, if no custom cursors
15530 * were set to @p item (and on errors)
15532 * @see elm_object_cursor_get()
15533 * @see elm_toolbar_item_cursor_set()
15534 * @see elm_toolbar_item_cursor_unset()
15538 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15541 * Unset any custom mouse pointer/cursor decoration set to be
15542 * shown, when the mouse pointer is over the given toolbar widget
15543 * item, thus making it show the @b default cursor again.
15545 * @param item a toolbar item
15547 * Use this call to undo any custom settings on this item's cursor
15548 * decoration, bringing it back to defaults (no custom style set).
15550 * @see elm_object_cursor_unset()
15551 * @see elm_toolbar_item_cursor_set()
15555 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15558 * Set a different @b style for a given custom cursor set for a
15561 * @param item toolbar item with custom cursor set
15562 * @param style the <b>theme style</b> to use (e.g. @c "default",
15563 * @c "transparent", etc)
15565 * This function only makes sense when one is using custom mouse
15566 * cursor decorations <b>defined in a theme file</b>, which can have,
15567 * given a cursor name/type, <b>alternate styles</b> on it. It
15568 * works analogously as elm_object_cursor_style_set(), but here
15569 * applyed only to toolbar item objects.
15571 * @warning Before you set a cursor style you should have definen a
15572 * custom cursor previously on the item, with
15573 * elm_toolbar_item_cursor_set()
15575 * @see elm_toolbar_item_cursor_engine_only_set()
15576 * @see elm_toolbar_item_cursor_style_get()
15580 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15583 * Get the current @b style set for a given toolbar item's custom
15586 * @param item toolbar item with custom cursor set.
15587 * @return style the cursor style in use. If the object does not
15588 * have a cursor set, then @c NULL is returned.
15590 * @see elm_toolbar_item_cursor_style_set() for more details
15594 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15597 * Set if the (custom)cursor for a given toolbar item should be
15598 * searched in its theme, also, or should only rely on the
15599 * rendering engine.
15601 * @param item item with custom (custom) cursor already set on
15602 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15603 * only on those provided by the rendering engine, @c EINA_FALSE to
15604 * have them searched on the widget's theme, as well.
15606 * @note This call is of use only if you've set a custom cursor
15607 * for toolbar items, with elm_toolbar_item_cursor_set().
15609 * @note By default, cursors will only be looked for between those
15610 * provided by the rendering engine.
15614 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15617 * Get if the (custom) cursor for a given toolbar item is being
15618 * searched in its theme, also, or is only relying on the rendering
15621 * @param item a toolbar item
15622 * @return @c EINA_TRUE, if cursors are being looked for only on
15623 * those provided by the rendering engine, @c EINA_FALSE if they
15624 * are being searched on the widget's theme, as well.
15626 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15630 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15633 * Change a toolbar's orientation
15634 * @param obj The toolbar object
15635 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15636 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15638 * @deprecated use elm_toolbar_horizontal_set() instead.
15640 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15643 * Change a toolbar's orientation
15644 * @param obj The toolbar object
15645 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15646 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15649 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15652 * Get a toolbar's orientation
15653 * @param obj The toolbar object
15654 * @return If @c EINA_TRUE, the toolbar is vertical
15655 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15657 * @deprecated use elm_toolbar_horizontal_get() instead.
15659 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15662 * Get a toolbar's orientation
15663 * @param obj The toolbar object
15664 * @return If @c EINA_TRUE, the toolbar is horizontal
15665 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15668 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15674 * @defgroup Tooltips Tooltips
15676 * The Tooltip is an (internal, for now) smart object used to show a
15677 * content in a frame on mouse hover of objects(or widgets), with
15678 * tips/information about them.
15683 EAPI double elm_tooltip_delay_get(void);
15684 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15685 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15686 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15687 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15688 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15689 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15690 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);
15691 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15692 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15693 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15694 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15695 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15702 * @defgroup Cursors Cursors
15704 * The Elementary cursor is an internal smart object used to
15705 * customize the mouse cursor displayed over objects (or
15706 * widgets). In the most common scenario, the cursor decoration
15707 * comes from the graphical @b engine Elementary is running
15708 * on. Those engines may provide different decorations for cursors,
15709 * and Elementary provides functions to choose them (think of X11
15710 * cursors, as an example).
15712 * There's also the possibility of, besides using engine provided
15713 * cursors, also use ones coming from Edje theming files. Both
15714 * globally and per widget, Elementary makes it possible for one to
15715 * make the cursors lookup to be held on engines only or on
15716 * Elementary's theme file, too. To set cursor's hot spot,
15717 * two data items should be added to cursor's theme: "hot_x" and
15718 * "hot_y", that are the offset from upper-left corner of the cursor
15719 * (coordinates 0,0).
15725 * Set the cursor to be shown when mouse is over the object
15727 * Set the cursor that will be displayed when mouse is over the
15728 * object. The object can have only one cursor set to it, so if
15729 * this function is called twice for an object, the previous set
15731 * If using X cursors, a definition of all the valid cursor names
15732 * is listed on Elementary_Cursors.h. If an invalid name is set
15733 * the default cursor will be used.
15735 * @param obj the object being set a cursor.
15736 * @param cursor the cursor name to be used.
15740 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15743 * Get the cursor to be shown when mouse is over the object
15745 * @param obj an object with cursor already set.
15746 * @return the cursor name.
15750 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15753 * Unset cursor for object
15755 * Unset cursor for object, and set the cursor to default if the mouse
15756 * was over this object.
15758 * @param obj Target object
15759 * @see elm_object_cursor_set()
15763 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15766 * Sets a different style for this object cursor.
15768 * @note before you set a style you should define a cursor with
15769 * elm_object_cursor_set()
15771 * @param obj an object with cursor already set.
15772 * @param style the theme style to use (default, transparent, ...)
15776 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15779 * Get the style for this object cursor.
15781 * @param obj an object with cursor already set.
15782 * @return style the theme style in use, defaults to "default". If the
15783 * object does not have a cursor set, then NULL is returned.
15787 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15790 * Set if the cursor set should be searched on the theme or should use
15791 * the provided by the engine, only.
15793 * @note before you set if should look on theme you should define a cursor
15794 * with elm_object_cursor_set(). By default it will only look for cursors
15795 * provided by the engine.
15797 * @param obj an object with cursor already set.
15798 * @param engine_only boolean to define it cursors should be looked only
15799 * between the provided by the engine or searched on widget's theme as well.
15803 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15806 * Get the cursor engine only usage for this object cursor.
15808 * @param obj an object with cursor already set.
15809 * @return engine_only boolean to define it cursors should be
15810 * looked only between the provided by the engine or searched on
15811 * widget's theme as well. If the object does not have a cursor
15812 * set, then EINA_FALSE is returned.
15816 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15819 * Get the configured cursor engine only usage
15821 * This gets the globally configured exclusive usage of engine cursors.
15823 * @return 1 if only engine cursors should be used
15826 EAPI int elm_cursor_engine_only_get(void);
15829 * Set the configured cursor engine only usage
15831 * This sets the globally configured exclusive usage of engine cursors.
15832 * It won't affect cursors set before changing this value.
15834 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15835 * look for them on theme before.
15836 * @return EINA_TRUE if value is valid and setted (0 or 1)
15839 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15846 * @defgroup Menu Menu
15848 * @image html img/widget/menu/preview-00.png
15849 * @image latex img/widget/menu/preview-00.eps
15851 * A menu is a list of items displayed above its parent. When the menu is
15852 * showing its parent is darkened. Each item can have a sub-menu. The menu
15853 * object can be used to display a menu on a right click event, in a toolbar,
15856 * Signals that you can add callbacks for are:
15857 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15858 * event_info is NULL.
15860 * @see @ref tutorial_menu
15863 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15865 * @brief Add a new menu to the parent
15867 * @param parent The parent object.
15868 * @return The new object or NULL if it cannot be created.
15870 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15872 * @brief Set the parent for the given menu widget
15874 * @param obj The menu object.
15875 * @param parent The new parent.
15877 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15879 * @brief Get the parent for the given menu widget
15881 * @param obj The menu object.
15882 * @return The parent.
15884 * @see elm_menu_parent_set()
15886 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15888 * @brief Move the menu to a new position
15890 * @param obj The menu object.
15891 * @param x The new position.
15892 * @param y The new position.
15894 * Sets the top-left position of the menu to (@p x,@p y).
15896 * @note @p x and @p y coordinates are relative to parent.
15898 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15900 * @brief Close a opened menu
15902 * @param obj the menu object
15905 * Hides the menu and all it's sub-menus.
15907 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15909 * @brief Returns a list of @p item's items.
15911 * @param obj The menu object
15912 * @return An Eina_List* of @p item's items
15914 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15916 * @brief Get the Evas_Object of an Elm_Menu_Item
15918 * @param item The menu item object.
15919 * @return The edje object containing the swallowed content
15921 * @warning Don't manipulate this object!
15923 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15925 * @brief Add an item at the end of the given menu widget
15927 * @param obj The menu object.
15928 * @param parent The parent menu item (optional)
15929 * @param icon A icon display on the item. The icon will be destryed by the menu.
15930 * @param label The label of the item.
15931 * @param func Function called when the user select the item.
15932 * @param data Data sent by the callback.
15933 * @return Returns the new item.
15935 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);
15937 * @brief Add an object swallowed in an item at the end of the given menu
15940 * @param obj The menu object.
15941 * @param parent The parent menu item (optional)
15942 * @param subobj The object to swallow
15943 * @param func Function called when the user select the item.
15944 * @param data Data sent by the callback.
15945 * @return Returns the new item.
15947 * Add an evas object as an item to the menu.
15949 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15951 * @brief Set the label of a menu item
15953 * @param item The menu item object.
15954 * @param label The label to set for @p item
15956 * @warning Don't use this funcion on items created with
15957 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15959 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15961 * @brief Get the label of a menu item
15963 * @param item The menu item object.
15964 * @return The label of @p item
15966 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15968 * @brief Set the icon of a menu item to the standard icon with name @p icon
15970 * @param item The menu item object.
15971 * @param icon The icon object to set for the content of @p item
15973 * Once this icon is set, any previously set icon will be deleted.
15975 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15977 * @brief Get the string representation from the icon of a menu item
15979 * @param item The menu item object.
15980 * @return The string representation of @p item's icon or NULL
15982 * @see elm_menu_item_object_icon_name_set()
15984 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15986 * @brief Set the content object of a menu item
15988 * @param item The menu item object
15989 * @param The content object or NULL
15990 * @return EINA_TRUE on success, else EINA_FALSE
15992 * Use this function to change the object swallowed by a menu item, deleting
15993 * any previously swallowed object.
15995 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15997 * @brief Get the content object of a menu item
15999 * @param item The menu item object
16000 * @return The content object or NULL
16001 * @note If @p item was added with elm_menu_item_add_object, this
16002 * function will return the object passed, else it will return the
16005 * @see elm_menu_item_object_content_set()
16007 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16009 * @brief Set the selected state of @p item.
16011 * @param item The menu item object.
16012 * @param selected The selected/unselected state of the item
16014 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16016 * @brief Get the selected state of @p item.
16018 * @param item The menu item object.
16019 * @return The selected/unselected state of the item
16021 * @see elm_menu_item_selected_set()
16023 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16025 * @brief Set the disabled state of @p item.
16027 * @param item The menu item object.
16028 * @param disabled The enabled/disabled state of the item
16030 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16032 * @brief Get the disabled state of @p item.
16034 * @param item The menu item object.
16035 * @return The enabled/disabled state of the item
16037 * @see elm_menu_item_disabled_set()
16039 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16041 * @brief Add a separator item to menu @p obj under @p parent.
16043 * @param obj The menu object
16044 * @param parent The item to add the separator under
16045 * @return The created item or NULL on failure
16047 * This is item is a @ref Separator.
16049 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16051 * @brief Returns whether @p item is a separator.
16053 * @param item The item to check
16054 * @return If true, @p item is a separator
16056 * @see elm_menu_item_separator_add()
16058 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16060 * @brief Deletes an item from the menu.
16062 * @param item The item to delete.
16064 * @see elm_menu_item_add()
16066 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16068 * @brief Set the function called when a menu item is deleted.
16070 * @param item The item to set the callback on
16071 * @param func The function called
16073 * @see elm_menu_item_add()
16074 * @see elm_menu_item_del()
16076 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16078 * @brief Returns the data associated with menu item @p item.
16080 * @param item The item
16081 * @return The data associated with @p item or NULL if none was set.
16083 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16085 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16087 * @brief Sets the data to be associated with menu item @p item.
16089 * @param item The item
16090 * @param data The data to be associated with @p item
16092 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16094 * @brief Returns a list of @p item's subitems.
16096 * @param item The item
16097 * @return An Eina_List* of @p item's subitems
16099 * @see elm_menu_add()
16101 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16103 * @brief Get the position of a menu item
16105 * @param item The menu item
16106 * @return The item's index
16108 * This function returns the index position of a menu item in a menu.
16109 * For a sub-menu, this number is relative to the first item in the sub-menu.
16111 * @note Index values begin with 0
16113 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16115 * @brief @brief Return a menu item's owner menu
16117 * @param item The menu item
16118 * @return The menu object owning @p item, or NULL on failure
16120 * Use this function to get the menu object owning an item.
16122 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16124 * @brief Get the selected item in the menu
16126 * @param obj The menu object
16127 * @return The selected item, or NULL if none
16129 * @see elm_menu_item_selected_get()
16130 * @see elm_menu_item_selected_set()
16132 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16134 * @brief Get the last item in the menu
16136 * @param obj The menu object
16137 * @return The last item, or NULL if none
16139 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16141 * @brief Get the first item in the menu
16143 * @param obj The menu object
16144 * @return The first item, or NULL if none
16146 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16148 * @brief Get the next item in the menu.
16150 * @param item The menu item object.
16151 * @return The item after it, or NULL if none
16153 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16155 * @brief Get the previous item in the menu.
16157 * @param item The menu item object.
16158 * @return The item before it, or NULL if none
16160 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16166 * @defgroup List List
16167 * @ingroup Elementary
16169 * @image html img/widget/list/preview-00.png
16170 * @image latex img/widget/list/preview-00.eps width=\textwidth
16172 * @image html img/list.png
16173 * @image latex img/list.eps width=\textwidth
16175 * A list widget is a container whose children are displayed vertically or
16176 * horizontally, in order, and can be selected.
16177 * The list can accept only one or multiple items selection. Also has many
16178 * modes of items displaying.
16180 * A list is a very simple type of list widget. For more robust
16181 * lists, @ref Genlist should probably be used.
16183 * Smart callbacks one can listen to:
16184 * - @c "activated" - The user has double-clicked or pressed
16185 * (enter|return|spacebar) on an item. The @c event_info parameter
16186 * is the item that was activated.
16187 * - @c "clicked,double" - The user has double-clicked an item.
16188 * The @c event_info parameter is the item that was double-clicked.
16189 * - "selected" - when the user selected an item
16190 * - "unselected" - when the user unselected an item
16191 * - "longpressed" - an item in the list is long-pressed
16192 * - "edge,top" - the list is scrolled until the top edge
16193 * - "edge,bottom" - the list is scrolled until the bottom edge
16194 * - "edge,left" - the list is scrolled until the left edge
16195 * - "edge,right" - the list is scrolled until the right edge
16196 * - "language,changed" - the program's language changed
16198 * Available styles for it:
16201 * List of examples:
16202 * @li @ref list_example_01
16203 * @li @ref list_example_02
16204 * @li @ref list_example_03
16213 * @enum _Elm_List_Mode
16214 * @typedef Elm_List_Mode
16216 * Set list's resize behavior, transverse axis scroll and
16217 * items cropping. See each mode's description for more details.
16219 * @note Default value is #ELM_LIST_SCROLL.
16221 * Values <b> don't </b> work as bitmask, only one can be choosen.
16223 * @see elm_list_mode_set()
16224 * @see elm_list_mode_get()
16228 typedef enum _Elm_List_Mode
16230 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. */
16231 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). */
16232 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. */
16233 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. */
16234 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16237 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(). */
16240 * Add a new list widget to the given parent Elementary
16241 * (container) object.
16243 * @param parent The parent object.
16244 * @return a new list widget handle or @c NULL, on errors.
16246 * This function inserts a new list widget on the canvas.
16250 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16255 * @param obj The list object
16257 * @note Call before running show() on the list object.
16258 * @warning If not called, it won't display the list properly.
16261 * li = elm_list_add(win);
16262 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16263 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16265 * evas_object_show(li);
16270 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16273 * Enable or disable multiple items selection on the list object.
16275 * @param obj The list object
16276 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16279 * Disabled by default. If disabled, the user can select a single item of
16280 * the list each time. Selected items are highlighted on list.
16281 * If enabled, many items can be selected.
16283 * If a selected item is selected again, it will be unselected.
16285 * @see elm_list_multi_select_get()
16289 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16292 * Get a value whether multiple items selection is enabled or not.
16294 * @see elm_list_multi_select_set() for details.
16296 * @param obj The list object.
16297 * @return @c EINA_TRUE means multiple items selection is enabled.
16298 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16299 * @c EINA_FALSE is returned.
16303 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16306 * Set which mode to use for the list object.
16308 * @param obj The list object
16309 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16310 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16312 * Set list's resize behavior, transverse axis scroll and
16313 * items cropping. See each mode's description for more details.
16315 * @note Default value is #ELM_LIST_SCROLL.
16317 * Only one can be set, if a previous one was set, it will be changed
16318 * by the new mode set. Bitmask won't work as well.
16320 * @see elm_list_mode_get()
16324 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16327 * Get the mode the list is at.
16329 * @param obj The list object
16330 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16331 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16333 * @note see elm_list_mode_set() for more information.
16337 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16340 * Enable or disable horizontal mode on the list object.
16342 * @param obj The list object.
16343 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16344 * disable it, i.e., to enable vertical mode.
16346 * @note Vertical mode is set by default.
16348 * On horizontal mode items are displayed on list from left to right,
16349 * instead of from top to bottom. Also, the list will scroll horizontally.
16350 * Each item will presents left icon on top and right icon, or end, at
16353 * @see elm_list_horizontal_get()
16357 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16360 * Get a value whether horizontal mode is enabled or not.
16362 * @param obj The list object.
16363 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16364 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16365 * @c EINA_FALSE is returned.
16367 * @see elm_list_horizontal_set() for details.
16371 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16374 * Enable or disable always select mode on the list object.
16376 * @param obj The list object
16377 * @param always_select @c EINA_TRUE to enable always select mode or
16378 * @c EINA_FALSE to disable it.
16380 * @note Always select mode is disabled by default.
16382 * Default behavior of list items is to only call its callback function
16383 * the first time it's pressed, i.e., when it is selected. If a selected
16384 * item is pressed again, and multi-select is disabled, it won't call
16385 * this function (if multi-select is enabled it will unselect the item).
16387 * If always select is enabled, it will call the callback function
16388 * everytime a item is pressed, so it will call when the item is selected,
16389 * and again when a selected item is pressed.
16391 * @see elm_list_always_select_mode_get()
16392 * @see elm_list_multi_select_set()
16396 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16399 * Get a value whether always select mode is enabled or not, meaning that
16400 * an item will always call its callback function, even if already selected.
16402 * @param obj The list object
16403 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16404 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16405 * @c EINA_FALSE is returned.
16407 * @see elm_list_always_select_mode_set() for details.
16411 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16414 * Set bouncing behaviour when the scrolled content reaches an edge.
16416 * Tell the internal scroller object whether it should bounce or not
16417 * when it reaches the respective edges for each axis.
16419 * @param obj The list object
16420 * @param h_bounce Whether to bounce or not in the horizontal axis.
16421 * @param v_bounce Whether to bounce or not in the vertical axis.
16423 * @see elm_scroller_bounce_set()
16427 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16430 * Get the bouncing behaviour of the internal scroller.
16432 * Get whether the internal scroller should bounce when the edge of each
16433 * axis is reached scrolling.
16435 * @param obj The list object.
16436 * @param h_bounce Pointer where to store the bounce state of the horizontal
16438 * @param v_bounce Pointer where to store the bounce state of the vertical
16441 * @see elm_scroller_bounce_get()
16442 * @see elm_list_bounce_set()
16446 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16449 * Set the scrollbar policy.
16451 * @param obj The list object
16452 * @param policy_h Horizontal scrollbar policy.
16453 * @param policy_v Vertical scrollbar policy.
16455 * This sets the scrollbar visibility policy for the given scroller.
16456 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16457 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16458 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16459 * This applies respectively for the horizontal and vertical scrollbars.
16461 * The both are disabled by default, i.e., are set to
16462 * #ELM_SCROLLER_POLICY_OFF.
16466 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16469 * Get the scrollbar policy.
16471 * @see elm_list_scroller_policy_get() for details.
16473 * @param obj The list object.
16474 * @param policy_h Pointer where to store horizontal scrollbar policy.
16475 * @param policy_v Pointer where to store vertical scrollbar policy.
16479 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);
16482 * Append a new item to the list object.
16484 * @param obj The list object.
16485 * @param label The label of the list item.
16486 * @param icon The icon object to use for the left side of the item. An
16487 * icon can be any Evas object, but usually it is an icon created
16488 * with elm_icon_add().
16489 * @param end The icon object to use for the right side of the item. An
16490 * icon can be any Evas object.
16491 * @param func The function to call when the item is clicked.
16492 * @param data The data to associate with the item for related callbacks.
16494 * @return The created item or @c NULL upon failure.
16496 * A new item will be created and appended to the list, i.e., will
16497 * be set as @b last item.
16499 * Items created with this method can be deleted with
16500 * elm_list_item_del().
16502 * Associated @p data can be properly freed when item is deleted if a
16503 * callback function is set with elm_list_item_del_cb_set().
16505 * If a function is passed as argument, it will be called everytime this item
16506 * is selected, i.e., the user clicks over an unselected item.
16507 * If always select is enabled it will call this function every time
16508 * user clicks over an item (already selected or not).
16509 * If such function isn't needed, just passing
16510 * @c NULL as @p func is enough. The same should be done for @p data.
16512 * Simple example (with no function callback or data associated):
16514 * li = elm_list_add(win);
16515 * ic = elm_icon_add(win);
16516 * elm_icon_file_set(ic, "path/to/image", NULL);
16517 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16518 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16520 * evas_object_show(li);
16523 * @see elm_list_always_select_mode_set()
16524 * @see elm_list_item_del()
16525 * @see elm_list_item_del_cb_set()
16526 * @see elm_list_clear()
16527 * @see elm_icon_add()
16531 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);
16534 * Prepend a new item to the list object.
16536 * @param obj The list object.
16537 * @param label The label of the list item.
16538 * @param icon The icon object to use for the left side of the item. An
16539 * icon can be any Evas object, but usually it is an icon created
16540 * with elm_icon_add().
16541 * @param end The icon object to use for the right side of the item. An
16542 * icon can be any Evas object.
16543 * @param func The function to call when the item is clicked.
16544 * @param data The data to associate with the item for related callbacks.
16546 * @return The created item or @c NULL upon failure.
16548 * A new item will be created and prepended to the list, i.e., will
16549 * be set as @b first item.
16551 * Items created with this method can be deleted with
16552 * elm_list_item_del().
16554 * Associated @p data can be properly freed when item is deleted if a
16555 * callback function is set with elm_list_item_del_cb_set().
16557 * If a function is passed as argument, it will be called everytime this item
16558 * is selected, i.e., the user clicks over an unselected item.
16559 * If always select is enabled it will call this function every time
16560 * user clicks over an item (already selected or not).
16561 * If such function isn't needed, just passing
16562 * @c NULL as @p func is enough. The same should be done for @p data.
16564 * @see elm_list_item_append() for a simple code example.
16565 * @see elm_list_always_select_mode_set()
16566 * @see elm_list_item_del()
16567 * @see elm_list_item_del_cb_set()
16568 * @see elm_list_clear()
16569 * @see elm_icon_add()
16573 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);
16576 * Insert a new item into the list object before item @p before.
16578 * @param obj The list object.
16579 * @param before The list item to insert before.
16580 * @param label The label of the list item.
16581 * @param icon The icon object to use for the left side of the item. An
16582 * icon can be any Evas object, but usually it is an icon created
16583 * with elm_icon_add().
16584 * @param end The icon object to use for the right side of the item. An
16585 * icon can be any Evas object.
16586 * @param func The function to call when the item is clicked.
16587 * @param data The data to associate with the item for related callbacks.
16589 * @return The created item or @c NULL upon failure.
16591 * A new item will be created and added to the list. Its position in
16592 * this list will be just before item @p before.
16594 * Items created with this method can be deleted with
16595 * elm_list_item_del().
16597 * Associated @p data can be properly freed when item is deleted if a
16598 * callback function is set with elm_list_item_del_cb_set().
16600 * If a function is passed as argument, it will be called everytime this item
16601 * is selected, i.e., the user clicks over an unselected item.
16602 * If always select is enabled it will call this function every time
16603 * user clicks over an item (already selected or not).
16604 * If such function isn't needed, just passing
16605 * @c NULL as @p func is enough. The same should be done for @p data.
16607 * @see elm_list_item_append() for a simple code example.
16608 * @see elm_list_always_select_mode_set()
16609 * @see elm_list_item_del()
16610 * @see elm_list_item_del_cb_set()
16611 * @see elm_list_clear()
16612 * @see elm_icon_add()
16616 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);
16619 * Insert a new item into the list object after item @p after.
16621 * @param obj The list object.
16622 * @param after The list item to insert after.
16623 * @param label The label of the list item.
16624 * @param icon The icon object to use for the left side of the item. An
16625 * icon can be any Evas object, but usually it is an icon created
16626 * with elm_icon_add().
16627 * @param end The icon object to use for the right side of the item. An
16628 * icon can be any Evas object.
16629 * @param func The function to call when the item is clicked.
16630 * @param data The data to associate with the item for related callbacks.
16632 * @return The created item or @c NULL upon failure.
16634 * A new item will be created and added to the list. Its position in
16635 * this list will be just after item @p after.
16637 * Items created with this method can be deleted with
16638 * elm_list_item_del().
16640 * Associated @p data can be properly freed when item is deleted if a
16641 * callback function is set with elm_list_item_del_cb_set().
16643 * If a function is passed as argument, it will be called everytime this item
16644 * is selected, i.e., the user clicks over an unselected item.
16645 * If always select is enabled it will call this function every time
16646 * user clicks over an item (already selected or not).
16647 * If such function isn't needed, just passing
16648 * @c NULL as @p func is enough. The same should be done for @p data.
16650 * @see elm_list_item_append() for a simple code example.
16651 * @see elm_list_always_select_mode_set()
16652 * @see elm_list_item_del()
16653 * @see elm_list_item_del_cb_set()
16654 * @see elm_list_clear()
16655 * @see elm_icon_add()
16659 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);
16662 * Insert a new item into the sorted list object.
16664 * @param obj The list object.
16665 * @param label The label of the list item.
16666 * @param icon The icon object to use for the left side of the item. An
16667 * icon can be any Evas object, but usually it is an icon created
16668 * with elm_icon_add().
16669 * @param end The icon object to use for the right side of the item. An
16670 * icon can be any Evas object.
16671 * @param func The function to call when the item is clicked.
16672 * @param data The data to associate with the item for related callbacks.
16673 * @param cmp_func The comparing function to be used to sort list
16674 * items <b>by #Elm_List_Item item handles</b>. This function will
16675 * receive two items and compare them, returning a non-negative integer
16676 * if the second item should be place after the first, or negative value
16677 * if should be placed before.
16679 * @return The created item or @c NULL upon failure.
16681 * @note This function inserts values into a list object assuming it was
16682 * sorted and the result will be sorted.
16684 * A new item will be created and added to the list. Its position in
16685 * this list will be found comparing the new item with previously inserted
16686 * items using function @p cmp_func.
16688 * Items created with this method can be deleted with
16689 * elm_list_item_del().
16691 * Associated @p data can be properly freed when item is deleted if a
16692 * callback function is set with elm_list_item_del_cb_set().
16694 * If a function is passed as argument, it will be called everytime this item
16695 * is selected, i.e., the user clicks over an unselected item.
16696 * If always select is enabled it will call this function every time
16697 * user clicks over an item (already selected or not).
16698 * If such function isn't needed, just passing
16699 * @c NULL as @p func is enough. The same should be done for @p data.
16701 * @see elm_list_item_append() for a simple code example.
16702 * @see elm_list_always_select_mode_set()
16703 * @see elm_list_item_del()
16704 * @see elm_list_item_del_cb_set()
16705 * @see elm_list_clear()
16706 * @see elm_icon_add()
16710 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);
16713 * Remove all list's items.
16715 * @param obj The list object
16717 * @see elm_list_item_del()
16718 * @see elm_list_item_append()
16722 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16725 * Get a list of all the list items.
16727 * @param obj The list object
16728 * @return An @c Eina_List of list items, #Elm_List_Item,
16729 * or @c NULL on failure.
16731 * @see elm_list_item_append()
16732 * @see elm_list_item_del()
16733 * @see elm_list_clear()
16737 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16740 * Get the selected item.
16742 * @param obj The list object.
16743 * @return The selected list item.
16745 * The selected item can be unselected with function
16746 * elm_list_item_selected_set().
16748 * The selected item always will be highlighted on list.
16750 * @see elm_list_selected_items_get()
16754 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16757 * Return a list of the currently selected list items.
16759 * @param obj The list object.
16760 * @return An @c Eina_List of list items, #Elm_List_Item,
16761 * or @c NULL on failure.
16763 * Multiple items can be selected if multi select is enabled. It can be
16764 * done with elm_list_multi_select_set().
16766 * @see elm_list_selected_item_get()
16767 * @see elm_list_multi_select_set()
16771 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16774 * Set the selected state of an item.
16776 * @param item The list item
16777 * @param selected The selected state
16779 * This sets the selected state of the given item @p it.
16780 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16782 * If a new item is selected the previosly selected will be unselected,
16783 * unless multiple selection is enabled with elm_list_multi_select_set().
16784 * Previoulsy selected item can be get with function
16785 * elm_list_selected_item_get().
16787 * Selected items will be highlighted.
16789 * @see elm_list_item_selected_get()
16790 * @see elm_list_selected_item_get()
16791 * @see elm_list_multi_select_set()
16795 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16798 * Get whether the @p item is selected or not.
16800 * @param item The list item.
16801 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16802 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16804 * @see elm_list_selected_item_set() for details.
16805 * @see elm_list_item_selected_get()
16809 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16812 * Set or unset item as a separator.
16814 * @param it The list item.
16815 * @param setting @c EINA_TRUE to set item @p it as separator or
16816 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16818 * Items aren't set as separator by default.
16820 * If set as separator it will display separator theme, so won't display
16823 * @see elm_list_item_separator_get()
16827 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16830 * Get a value whether item is a separator or not.
16832 * @see elm_list_item_separator_set() for details.
16834 * @param it The list item.
16835 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16836 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16840 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16843 * Show @p item in the list view.
16845 * @param item The list item to be shown.
16847 * It won't animate list until item is visible. If such behavior is wanted,
16848 * use elm_list_bring_in() intead.
16852 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16855 * Bring in the given item to list view.
16857 * @param item The item.
16859 * This causes list to jump to the given item @p item and show it
16860 * (by scrolling), if it is not fully visible.
16862 * This may use animation to do so and take a period of time.
16864 * If animation isn't wanted, elm_list_item_show() can be used.
16868 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16871 * Delete them item from the list.
16873 * @param item The item of list to be deleted.
16875 * If deleting all list items is required, elm_list_clear()
16876 * should be used instead of getting items list and deleting each one.
16878 * @see elm_list_clear()
16879 * @see elm_list_item_append()
16880 * @see elm_list_item_del_cb_set()
16884 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16887 * Set the function called when a list item is freed.
16889 * @param item The item to set the callback on
16890 * @param func The function called
16892 * If there is a @p func, then it will be called prior item's memory release.
16893 * That will be called with the following arguments:
16895 * @li item's Evas object;
16898 * This way, a data associated to a list item could be properly freed.
16902 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16905 * Get the data associated to the item.
16907 * @param item The list item
16908 * @return The data associated to @p item
16910 * The return value is a pointer to data associated to @p item when it was
16911 * created, with function elm_list_item_append() or similar. If no data
16912 * was passed as argument, it will return @c NULL.
16914 * @see elm_list_item_append()
16918 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16921 * Get the left side icon associated to the item.
16923 * @param item The list item
16924 * @return The left side icon associated to @p item
16926 * The return value is a pointer to the icon associated to @p item when
16928 * created, with function elm_list_item_append() or similar, or later
16929 * with function elm_list_item_icon_set(). If no icon
16930 * was passed as argument, it will return @c NULL.
16932 * @see elm_list_item_append()
16933 * @see elm_list_item_icon_set()
16937 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16940 * Set the left side icon associated to the item.
16942 * @param item The list item
16943 * @param icon The left side icon object to associate with @p item
16945 * The icon object to use at left side of the item. An
16946 * icon can be any Evas object, but usually it is an icon created
16947 * with elm_icon_add().
16949 * Once the icon object is set, a previously set one will be deleted.
16950 * @warning Setting the same icon for two items will cause the icon to
16951 * dissapear from the first item.
16953 * If an icon was passed as argument on item creation, with function
16954 * elm_list_item_append() or similar, it will be already
16955 * associated to the item.
16957 * @see elm_list_item_append()
16958 * @see elm_list_item_icon_get()
16962 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16965 * Get the right side icon associated to the item.
16967 * @param item The list item
16968 * @return The right side icon associated to @p item
16970 * The return value is a pointer to the icon associated to @p item when
16972 * created, with function elm_list_item_append() or similar, or later
16973 * with function elm_list_item_icon_set(). If no icon
16974 * was passed as argument, it will return @c NULL.
16976 * @see elm_list_item_append()
16977 * @see elm_list_item_icon_set()
16981 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16984 * Set the right side icon associated to the item.
16986 * @param item The list item
16987 * @param end The right side icon object to associate with @p item
16989 * The icon object to use at right side of the item. An
16990 * icon can be any Evas object, but usually it is an icon created
16991 * with elm_icon_add().
16993 * Once the icon object is set, a previously set one will be deleted.
16994 * @warning Setting the same icon for two items will cause the icon to
16995 * dissapear from the first item.
16997 * If an icon was passed as argument on item creation, with function
16998 * elm_list_item_append() or similar, it will be already
16999 * associated to the item.
17001 * @see elm_list_item_append()
17002 * @see elm_list_item_end_get()
17006 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17009 * Gets the base object of the item.
17011 * @param item The list item
17012 * @return The base object associated with @p item
17014 * Base object is the @c Evas_Object that represents that item.
17018 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17019 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17022 * Get the label of item.
17024 * @param item The item of list.
17025 * @return The label of item.
17027 * The return value is a pointer to the label associated to @p item when
17028 * it was created, with function elm_list_item_append(), or later
17029 * with function elm_list_item_label_set. If no label
17030 * was passed as argument, it will return @c NULL.
17032 * @see elm_list_item_label_set() for more details.
17033 * @see elm_list_item_append()
17037 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17040 * Set the label of item.
17042 * @param item The item of list.
17043 * @param text The label of item.
17045 * The label to be displayed by the item.
17046 * Label will be placed between left and right side icons (if set).
17048 * If a label was passed as argument on item creation, with function
17049 * elm_list_item_append() or similar, it will be already
17050 * displayed by the item.
17052 * @see elm_list_item_label_get()
17053 * @see elm_list_item_append()
17057 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17061 * Get the item before @p it in list.
17063 * @param it The list item.
17064 * @return The item before @p it, or @c NULL if none or on failure.
17066 * @note If it is the first item, @c NULL will be returned.
17068 * @see elm_list_item_append()
17069 * @see elm_list_items_get()
17073 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17076 * Get the item after @p it in list.
17078 * @param it The list item.
17079 * @return The item after @p it, or @c NULL if none or on failure.
17081 * @note If it is the last item, @c NULL will be returned.
17083 * @see elm_list_item_append()
17084 * @see elm_list_items_get()
17088 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17091 * Sets the disabled/enabled state of a list item.
17093 * @param it The item.
17094 * @param disabled The disabled state.
17096 * A disabled item cannot be selected or unselected. It will also
17097 * change its appearance (generally greyed out). This sets the
17098 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17103 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17106 * Get a value whether list item is disabled or not.
17108 * @param it The item.
17109 * @return The disabled state.
17111 * @see elm_list_item_disabled_set() for more details.
17115 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17118 * Set the text to be shown in a given list item's tooltips.
17120 * @param item Target item.
17121 * @param text The text to set in the content.
17123 * Setup the text as tooltip to object. The item can have only one tooltip,
17124 * so any previous tooltip data - set with this function or
17125 * elm_list_item_tooltip_content_cb_set() - is removed.
17127 * @see elm_object_tooltip_text_set() for more details.
17131 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17135 * @brief Disable size restrictions on an object's tooltip
17136 * @param item The tooltip's anchor object
17137 * @param disable If EINA_TRUE, size restrictions are disabled
17138 * @return EINA_FALSE on failure, EINA_TRUE on success
17140 * This function allows a tooltip to expand beyond its parant window's canvas.
17141 * It will instead be limited only by the size of the display.
17143 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17145 * @brief Retrieve size restriction state of an object's tooltip
17146 * @param obj The tooltip's anchor object
17147 * @return If EINA_TRUE, size restrictions are disabled
17149 * This function returns whether a tooltip is allowed to expand beyond
17150 * its parant window's canvas.
17151 * It will instead be limited only by the size of the display.
17153 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17156 * Set the content to be shown in the tooltip item.
17158 * Setup the tooltip to item. The item can have only one tooltip,
17159 * so any previous tooltip data is removed. @p func(with @p data) will
17160 * be called every time that need show the tooltip and it should
17161 * return a valid Evas_Object. This object is then managed fully by
17162 * tooltip system and is deleted when the tooltip is gone.
17164 * @param item the list item being attached a tooltip.
17165 * @param func the function used to create the tooltip contents.
17166 * @param data what to provide to @a func as callback data/context.
17167 * @param del_cb called when data is not needed anymore, either when
17168 * another callback replaces @a func, the tooltip is unset with
17169 * elm_list_item_tooltip_unset() or the owner @a item
17170 * dies. This callback receives as the first parameter the
17171 * given @a data, and @c event_info is the item.
17173 * @see elm_object_tooltip_content_cb_set() for more details.
17177 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);
17180 * Unset tooltip from item.
17182 * @param item list item to remove previously set tooltip.
17184 * Remove tooltip from item. The callback provided as del_cb to
17185 * elm_list_item_tooltip_content_cb_set() will be called to notify
17186 * it is not used anymore.
17188 * @see elm_object_tooltip_unset() for more details.
17189 * @see elm_list_item_tooltip_content_cb_set()
17193 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17196 * Sets a different style for this item tooltip.
17198 * @note before you set a style you should define a tooltip with
17199 * elm_list_item_tooltip_content_cb_set() or
17200 * elm_list_item_tooltip_text_set()
17202 * @param item list item with tooltip already set.
17203 * @param style the theme style to use (default, transparent, ...)
17205 * @see elm_object_tooltip_style_set() for more details.
17209 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17212 * Get the style for this item tooltip.
17214 * @param item list item with tooltip already set.
17215 * @return style the theme style in use, defaults to "default". If the
17216 * object does not have a tooltip set, then NULL is returned.
17218 * @see elm_object_tooltip_style_get() for more details.
17219 * @see elm_list_item_tooltip_style_set()
17223 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17226 * Set the type of mouse pointer/cursor decoration to be shown,
17227 * when the mouse pointer is over the given list widget item
17229 * @param item list item to customize cursor on
17230 * @param cursor the cursor type's name
17232 * This function works analogously as elm_object_cursor_set(), but
17233 * here the cursor's changing area is restricted to the item's
17234 * area, and not the whole widget's. Note that that item cursors
17235 * have precedence over widget cursors, so that a mouse over an
17236 * item with custom cursor set will always show @b that cursor.
17238 * If this function is called twice for an object, a previously set
17239 * cursor will be unset on the second call.
17241 * @see elm_object_cursor_set()
17242 * @see elm_list_item_cursor_get()
17243 * @see elm_list_item_cursor_unset()
17247 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17250 * Get the type of mouse pointer/cursor decoration set to be shown,
17251 * when the mouse pointer is over the given list widget item
17253 * @param item list item with custom cursor set
17254 * @return the cursor type's name or @c NULL, if no custom cursors
17255 * were set to @p item (and on errors)
17257 * @see elm_object_cursor_get()
17258 * @see elm_list_item_cursor_set()
17259 * @see elm_list_item_cursor_unset()
17263 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17266 * Unset any custom mouse pointer/cursor decoration set to be
17267 * shown, when the mouse pointer is over the given list widget
17268 * item, thus making it show the @b default cursor again.
17270 * @param item a list item
17272 * Use this call to undo any custom settings on this item's cursor
17273 * decoration, bringing it back to defaults (no custom style set).
17275 * @see elm_object_cursor_unset()
17276 * @see elm_list_item_cursor_set()
17280 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17283 * Set a different @b style for a given custom cursor set for a
17286 * @param item list item with custom cursor set
17287 * @param style the <b>theme style</b> to use (e.g. @c "default",
17288 * @c "transparent", etc)
17290 * This function only makes sense when one is using custom mouse
17291 * cursor decorations <b>defined in a theme file</b>, which can have,
17292 * given a cursor name/type, <b>alternate styles</b> on it. It
17293 * works analogously as elm_object_cursor_style_set(), but here
17294 * applyed only to list item objects.
17296 * @warning Before you set a cursor style you should have definen a
17297 * custom cursor previously on the item, with
17298 * elm_list_item_cursor_set()
17300 * @see elm_list_item_cursor_engine_only_set()
17301 * @see elm_list_item_cursor_style_get()
17305 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17308 * Get the current @b style set for a given list item's custom
17311 * @param item list item with custom cursor set.
17312 * @return style the cursor style in use. If the object does not
17313 * have a cursor set, then @c NULL is returned.
17315 * @see elm_list_item_cursor_style_set() for more details
17319 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17322 * Set if the (custom)cursor for a given list item should be
17323 * searched in its theme, also, or should only rely on the
17324 * rendering engine.
17326 * @param item item with custom (custom) cursor already set on
17327 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17328 * only on those provided by the rendering engine, @c EINA_FALSE to
17329 * have them searched on the widget's theme, as well.
17331 * @note This call is of use only if you've set a custom cursor
17332 * for list items, with elm_list_item_cursor_set().
17334 * @note By default, cursors will only be looked for between those
17335 * provided by the rendering engine.
17339 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17342 * Get if the (custom) cursor for a given list item is being
17343 * searched in its theme, also, or is only relying on the rendering
17346 * @param item a list item
17347 * @return @c EINA_TRUE, if cursors are being looked for only on
17348 * those provided by the rendering engine, @c EINA_FALSE if they
17349 * are being searched on the widget's theme, as well.
17351 * @see elm_list_item_cursor_engine_only_set(), for more details
17355 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17362 * @defgroup Slider Slider
17363 * @ingroup Elementary
17365 * @image html img/widget/slider/preview-00.png
17366 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17368 * The slider adds a dragable āsliderā widget for selecting the value of
17369 * something within a range.
17371 * A slider can be horizontal or vertical. It can contain an Icon and has a
17372 * primary label as well as a units label (that is formatted with floating
17373 * point values and thus accepts a printf-style format string, like
17374 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17375 * else (like on the slider itself) that also accepts a format string like
17376 * units. Label, Icon Unit and Indicator strings/objects are optional.
17378 * A slider may be inverted which means values invert, with high vales being
17379 * on the left or top and low values on the right or bottom (as opposed to
17380 * normally being low on the left or top and high on the bottom and right).
17382 * The slider should have its minimum and maximum values set by the
17383 * application with elm_slider_min_max_set() and value should also be set by
17384 * the application before use with elm_slider_value_set(). The span of the
17385 * slider is its length (horizontally or vertically). This will be scaled by
17386 * the object or applications scaling factor. At any point code can query the
17387 * slider for its value with elm_slider_value_get().
17389 * Smart callbacks one can listen to:
17390 * - "changed" - Whenever the slider value is changed by the user.
17391 * - "slider,drag,start" - dragging the slider indicator around has started.
17392 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17393 * - "delay,changed" - A short time after the value is changed by the user.
17394 * This will be called only when the user stops dragging for
17395 * a very short period or when they release their
17396 * finger/mouse, so it avoids possibly expensive reactions to
17397 * the value change.
17399 * Available styles for it:
17402 * Default contents parts of the slider widget that you can use for are:
17403 * @li "icon" - A icon of the slider
17404 * @li "end" - A end part content of the slider
17406 * Default text parts of the silder widget that you can use for are:
17407 * @li "default" - Label of the silder
17408 * Here is an example on its usage:
17409 * @li @ref slider_example
17413 * @addtogroup Slider
17418 * Add a new slider widget to the given parent Elementary
17419 * (container) object.
17421 * @param parent The parent object.
17422 * @return a new slider widget handle or @c NULL, on errors.
17424 * This function inserts a new slider widget on the canvas.
17428 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17431 * Set the label of a given slider widget
17433 * @param obj The progress bar object
17434 * @param label The text label string, in UTF-8
17437 * @deprecated use elm_object_text_set() instead.
17439 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17442 * Get the label of a given slider widget
17444 * @param obj The progressbar object
17445 * @return The text label string, in UTF-8
17448 * @deprecated use elm_object_text_get() instead.
17450 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17453 * Set the icon object of the slider object.
17455 * @param obj The slider object.
17456 * @param icon The icon object.
17458 * On horizontal mode, icon is placed at left, and on vertical mode,
17461 * @note Once the icon object is set, a previously set one will be deleted.
17462 * If you want to keep that old content object, use the
17463 * elm_slider_icon_unset() function.
17465 * @warning If the object being set does not have minimum size hints set,
17466 * it won't get properly displayed.
17469 * @deprecated use elm_object_content_part_set() instead.
17471 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17474 * Unset an icon set on a given slider widget.
17476 * @param obj The slider object.
17477 * @return The icon object that was being used, if any was set, or
17478 * @c NULL, otherwise (and on errors).
17480 * On horizontal mode, icon is placed at left, and on vertical mode,
17483 * This call will unparent and return the icon object which was set
17484 * for this widget, previously, on success.
17486 * @see elm_slider_icon_set() for more details
17487 * @see elm_slider_icon_get()
17488 * @deprecated use elm_object_content_part_unset() instead.
17492 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17495 * Retrieve the icon object set for a given slider widget.
17497 * @param obj The slider object.
17498 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17499 * otherwise (and on errors).
17501 * On horizontal mode, icon is placed at left, and on vertical mode,
17504 * @see elm_slider_icon_set() for more details
17505 * @see elm_slider_icon_unset()
17507 * @deprecated use elm_object_content_part_get() instead.
17511 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17514 * Set the end object of the slider object.
17516 * @param obj The slider object.
17517 * @param end The end object.
17519 * On horizontal mode, end is placed at left, and on vertical mode,
17520 * placed at bottom.
17522 * @note Once the icon object is set, a previously set one will be deleted.
17523 * If you want to keep that old content object, use the
17524 * elm_slider_end_unset() function.
17526 * @warning If the object being set does not have minimum size hints set,
17527 * it won't get properly displayed.
17529 * @deprecated use elm_object_content_part_set() instead.
17533 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17536 * Unset an end object set on a given slider widget.
17538 * @param obj The slider object.
17539 * @return The end object that was being used, if any was set, or
17540 * @c NULL, otherwise (and on errors).
17542 * On horizontal mode, end is placed at left, and on vertical mode,
17543 * placed at bottom.
17545 * This call will unparent and return the icon object which was set
17546 * for this widget, previously, on success.
17548 * @see elm_slider_end_set() for more details.
17549 * @see elm_slider_end_get()
17551 * @deprecated use elm_object_content_part_unset() instead
17556 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17559 * Retrieve the end object set for a given slider widget.
17561 * @param obj The slider object.
17562 * @return The end object's handle, if @p obj had one set, or @c NULL,
17563 * otherwise (and on errors).
17565 * On horizontal mode, icon is placed at right, and on vertical mode,
17566 * placed at bottom.
17568 * @see elm_slider_end_set() for more details.
17569 * @see elm_slider_end_unset()
17572 * @deprecated use elm_object_content_part_get() instead
17577 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17580 * Set the (exact) length of the bar region of a given slider widget.
17582 * @param obj The slider object.
17583 * @param size The length of the slider's bar region.
17585 * This sets the minimum width (when in horizontal mode) or height
17586 * (when in vertical mode) of the actual bar area of the slider
17587 * @p obj. This in turn affects the object's minimum size. Use
17588 * this when you're not setting other size hints expanding on the
17589 * given direction (like weight and alignment hints) and you would
17590 * like it to have a specific size.
17592 * @note Icon, end, label, indicator and unit text around @p obj
17593 * will require their
17594 * own space, which will make @p obj to require more the @p size,
17597 * @see elm_slider_span_size_get()
17601 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17604 * Get the length set for the bar region of a given slider widget
17606 * @param obj The slider object.
17607 * @return The length of the slider's bar region.
17609 * If that size was not set previously, with
17610 * elm_slider_span_size_set(), this call will return @c 0.
17614 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17617 * Set the format string for the unit label.
17619 * @param obj The slider object.
17620 * @param format The format string for the unit display.
17622 * Unit label is displayed all the time, if set, after slider's bar.
17623 * In horizontal mode, at right and in vertical mode, at bottom.
17625 * If @c NULL, unit label won't be visible. If not it sets the format
17626 * string for the label text. To the label text is provided a floating point
17627 * value, so the label text can display up to 1 floating point value.
17628 * Note that this is optional.
17630 * Use a format string such as "%1.2f meters" for example, and it will
17631 * display values like: "3.14 meters" for a value equal to 3.14159.
17633 * Default is unit label disabled.
17635 * @see elm_slider_indicator_format_get()
17639 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17642 * Get the unit label format of the slider.
17644 * @param obj The slider object.
17645 * @return The unit label format string in UTF-8.
17647 * Unit label is displayed all the time, if set, after slider's bar.
17648 * In horizontal mode, at right and in vertical mode, at bottom.
17650 * @see elm_slider_unit_format_set() for more
17651 * information on how this works.
17655 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17658 * Set the format string for the indicator label.
17660 * @param obj The slider object.
17661 * @param indicator The format string for the indicator display.
17663 * The slider may display its value somewhere else then unit label,
17664 * for example, above the slider knob that is dragged around. This function
17665 * sets the format string used for this.
17667 * If @c NULL, indicator label won't be visible. If not it sets the format
17668 * string for the label text. To the label text is provided a floating point
17669 * value, so the label text can display up to 1 floating point value.
17670 * Note that this is optional.
17672 * Use a format string such as "%1.2f meters" for example, and it will
17673 * display values like: "3.14 meters" for a value equal to 3.14159.
17675 * Default is indicator label disabled.
17677 * @see elm_slider_indicator_format_get()
17681 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17684 * Get the indicator label format of the slider.
17686 * @param obj The slider object.
17687 * @return The indicator label format string in UTF-8.
17689 * The slider may display its value somewhere else then unit label,
17690 * for example, above the slider knob that is dragged around. This function
17691 * gets the format string used for this.
17693 * @see elm_slider_indicator_format_set() for more
17694 * information on how this works.
17698 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17701 * Set the format function pointer for the indicator label
17703 * @param obj The slider object.
17704 * @param func The indicator format function.
17705 * @param free_func The freeing function for the format string.
17707 * Set the callback function to format the indicator string.
17709 * @see elm_slider_indicator_format_set() for more info on how this works.
17713 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);
17716 * Set the format function pointer for the units label
17718 * @param obj The slider object.
17719 * @param func The units format function.
17720 * @param free_func The freeing function for the format string.
17722 * Set the callback function to format the indicator string.
17724 * @see elm_slider_units_format_set() for more info on how this works.
17728 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);
17731 * Set the orientation of a given slider widget.
17733 * @param obj The slider object.
17734 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17735 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17737 * Use this function to change how your slider is to be
17738 * disposed: vertically or horizontally.
17740 * By default it's displayed horizontally.
17742 * @see elm_slider_horizontal_get()
17746 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17749 * Retrieve the orientation of a given slider widget
17751 * @param obj The slider object.
17752 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17753 * @c EINA_FALSE if it's @b vertical (and on errors).
17755 * @see elm_slider_horizontal_set() for more details.
17759 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17762 * Set the minimum and maximum values for the slider.
17764 * @param obj The slider object.
17765 * @param min The minimum value.
17766 * @param max The maximum value.
17768 * Define the allowed range of values to be selected by the user.
17770 * If actual value is less than @p min, it will be updated to @p min. If it
17771 * is bigger then @p max, will be updated to @p max. Actual value can be
17772 * get with elm_slider_value_get().
17774 * By default, min is equal to 0.0, and max is equal to 1.0.
17776 * @warning Maximum must be greater than minimum, otherwise behavior
17779 * @see elm_slider_min_max_get()
17783 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17786 * Get the minimum and maximum values of the slider.
17788 * @param obj The slider object.
17789 * @param min Pointer where to store the minimum value.
17790 * @param max Pointer where to store the maximum value.
17792 * @note If only one value is needed, the other pointer can be passed
17795 * @see elm_slider_min_max_set() for details.
17799 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17802 * Set the value the slider displays.
17804 * @param obj The slider object.
17805 * @param val The value to be displayed.
17807 * Value will be presented on the unit label following format specified with
17808 * elm_slider_unit_format_set() and on indicator with
17809 * elm_slider_indicator_format_set().
17811 * @warning The value must to be between min and max values. This values
17812 * are set by elm_slider_min_max_set().
17814 * @see elm_slider_value_get()
17815 * @see elm_slider_unit_format_set()
17816 * @see elm_slider_indicator_format_set()
17817 * @see elm_slider_min_max_set()
17821 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17824 * Get the value displayed by the spinner.
17826 * @param obj The spinner object.
17827 * @return The value displayed.
17829 * @see elm_spinner_value_set() for details.
17833 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17836 * Invert a given slider widget's displaying values order
17838 * @param obj The slider object.
17839 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17840 * @c EINA_FALSE to bring it back to default, non-inverted values.
17842 * A slider may be @b inverted, in which state it gets its
17843 * values inverted, with high vales being on the left or top and
17844 * low values on the right or bottom, as opposed to normally have
17845 * the low values on the former and high values on the latter,
17846 * respectively, for horizontal and vertical modes.
17848 * @see elm_slider_inverted_get()
17852 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17855 * Get whether a given slider widget's displaying values are
17858 * @param obj The slider object.
17859 * @return @c EINA_TRUE, if @p obj has inverted values,
17860 * @c EINA_FALSE otherwise (and on errors).
17862 * @see elm_slider_inverted_set() for more details.
17866 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17869 * Set whether to enlarge slider indicator (augmented knob) or not.
17871 * @param obj The slider object.
17872 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17873 * let the knob always at default size.
17875 * By default, indicator will be bigger while dragged by the user.
17877 * @warning It won't display values set with
17878 * elm_slider_indicator_format_set() if you disable indicator.
17882 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17885 * Get whether a given slider widget's enlarging indicator or not.
17887 * @param obj The slider object.
17888 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17889 * @c EINA_FALSE otherwise (and on errors).
17891 * @see elm_slider_indicator_show_set() for details.
17895 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17902 * @addtogroup Actionslider Actionslider
17904 * @image html img/widget/actionslider/preview-00.png
17905 * @image latex img/widget/actionslider/preview-00.eps
17907 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17908 * properties. The user drags and releases the indicator, to choose a label.
17910 * Labels occupy the following positions.
17915 * Positions can be enabled or disabled.
17917 * Magnets can be set on the above positions.
17919 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17921 * @note By default all positions are set as enabled.
17923 * Signals that you can add callbacks for are:
17925 * "selected" - when user selects an enabled position (the label is passed
17928 * "pos_changed" - when the indicator reaches any of the positions("left",
17929 * "right" or "center").
17931 * See an example of actionslider usage @ref actionslider_example_page "here"
17934 typedef enum _Elm_Actionslider_Pos
17936 ELM_ACTIONSLIDER_NONE = 0,
17937 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17938 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17939 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17940 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17941 } Elm_Actionslider_Pos;
17944 * Add a new actionslider to the parent.
17946 * @param parent The parent object
17947 * @return The new actionslider object or NULL if it cannot be created
17949 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17951 * Set actionslider labels.
17953 * @param obj The actionslider object
17954 * @param left_label The label to be set on the left.
17955 * @param center_label The label to be set on the center.
17956 * @param right_label The label to be set on the right.
17957 * @deprecated use elm_object_text_set() instead.
17959 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
17961 * Get actionslider labels.
17963 * @param obj The actionslider object
17964 * @param left_label A char** to place the left_label of @p obj into.
17965 * @param center_label A char** to place the center_label of @p obj into.
17966 * @param right_label A char** to place the right_label of @p obj into.
17967 * @deprecated use elm_object_text_set() instead.
17969 EINA_DEPRECATED EAPI void elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
17971 * Get actionslider selected label.
17973 * @param obj The actionslider object
17974 * @return The selected label
17976 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17978 * Set actionslider indicator position.
17980 * @param obj The actionslider object.
17981 * @param pos The position of the indicator.
17983 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17985 * Get actionslider indicator position.
17987 * @param obj The actionslider object.
17988 * @return The position of the indicator.
17990 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17992 * Set actionslider magnet position. To make multiple positions magnets @c or
17993 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17995 * @param obj The actionslider object.
17996 * @param pos Bit mask indicating the magnet positions.
17998 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18000 * Get actionslider magnet position.
18002 * @param obj The actionslider object.
18003 * @return The positions with magnet property.
18005 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18007 * Set actionslider enabled position. To set multiple positions as enabled @c or
18008 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18010 * @note All the positions are enabled by default.
18012 * @param obj The actionslider object.
18013 * @param pos Bit mask indicating the enabled positions.
18015 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18017 * Get actionslider enabled position.
18019 * @param obj The actionslider object.
18020 * @return The enabled positions.
18022 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18024 * Set the label used on the indicator.
18026 * @param obj The actionslider object
18027 * @param label The label to be set on the indicator.
18028 * @deprecated use elm_object_text_set() instead.
18030 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18032 * Get the label used on the indicator object.
18034 * @param obj The actionslider object
18035 * @return The indicator label
18036 * @deprecated use elm_object_text_get() instead.
18038 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18044 * @defgroup Genlist Genlist
18046 * @image html img/widget/genlist/preview-00.png
18047 * @image latex img/widget/genlist/preview-00.eps
18048 * @image html img/genlist.png
18049 * @image latex img/genlist.eps
18051 * This widget aims to have more expansive list than the simple list in
18052 * Elementary that could have more flexible items and allow many more entries
18053 * while still being fast and low on memory usage. At the same time it was
18054 * also made to be able to do tree structures. But the price to pay is more
18055 * complexity when it comes to usage. If all you want is a simple list with
18056 * icons and a single label, use the normal @ref List object.
18058 * Genlist has a fairly large API, mostly because it's relatively complex,
18059 * trying to be both expansive, powerful and efficient. First we will begin
18060 * an overview on the theory behind genlist.
18062 * @section Genlist_Item_Class Genlist item classes - creating items
18064 * In order to have the ability to add and delete items on the fly, genlist
18065 * implements a class (callback) system where the application provides a
18066 * structure with information about that type of item (genlist may contain
18067 * multiple different items with different classes, states and styles).
18068 * Genlist will call the functions in this struct (methods) when an item is
18069 * "realized" (i.e., created dynamically, while the user is scrolling the
18070 * grid). All objects will simply be deleted when no longer needed with
18071 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18072 * following members:
18073 * - @c item_style - This is a constant string and simply defines the name
18074 * of the item style. It @b must be specified and the default should be @c
18077 * - @c func - A struct with pointers to functions that will be called when
18078 * an item is going to be actually created. All of them receive a @c data
18079 * parameter that will point to the same data passed to
18080 * elm_genlist_item_append() and related item creation functions, and a @c
18081 * obj parameter that points to the genlist object itself.
18083 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18084 * state_get and @c del. The 3 first functions also receive a @c part
18085 * parameter described below. A brief description of these functions follows:
18087 * - @c label_get - The @c part parameter is the name string of one of the
18088 * existing text parts in the Edje group implementing the item's theme.
18089 * This function @b must return a strdup'()ed string, as the caller will
18090 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18091 * - @c content_get - The @c part parameter is the name string of one of the
18092 * existing (content) swallow parts in the Edje group implementing the item's
18093 * theme. It must return @c NULL, when no content is desired, or a valid
18094 * object handle, otherwise. The object will be deleted by the genlist on
18095 * its deletion or when the item is "unrealized". See
18096 * #Elm_Genlist_Item_Icon_Get_Cb.
18097 * - @c func.state_get - The @c part parameter is the name string of one of
18098 * the state parts in the Edje group implementing the item's theme. Return
18099 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18100 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18101 * and @c "elm" as "emission" and "source" arguments, respectively, when
18102 * the state is true (the default is false), where @c XXX is the name of
18103 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18104 * - @c func.del - This is intended for use when genlist items are deleted,
18105 * so any data attached to the item (e.g. its data parameter on creation)
18106 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18108 * available item styles:
18110 * - default_style - The text part is a textblock
18112 * @image html img/widget/genlist/preview-04.png
18113 * @image latex img/widget/genlist/preview-04.eps
18117 * @image html img/widget/genlist/preview-01.png
18118 * @image latex img/widget/genlist/preview-01.eps
18120 * - icon_top_text_bottom
18122 * @image html img/widget/genlist/preview-02.png
18123 * @image latex img/widget/genlist/preview-02.eps
18127 * @image html img/widget/genlist/preview-03.png
18128 * @image latex img/widget/genlist/preview-03.eps
18130 * @section Genlist_Items Structure of items
18132 * An item in a genlist can have 0 or more text labels (they can be regular
18133 * text or textblock Evas objects - that's up to the style to determine), 0
18134 * or more contents (which are simply objects swallowed into the genlist item's
18135 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18136 * behavior left to the user to define. The Edje part names for each of
18137 * these properties will be looked up, in the theme file for the genlist,
18138 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18139 * "states", respectively. For each of those properties, if more than one
18140 * part is provided, they must have names listed separated by spaces in the
18141 * data fields. For the default genlist item theme, we have @b one label
18142 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18143 * "elm.swallow.end") and @b no state parts.
18145 * A genlist item may be at one of several styles. Elementary provides one
18146 * by default - "default", but this can be extended by system or application
18147 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18150 * @section Genlist_Manipulation Editing and Navigating
18152 * Items can be added by several calls. All of them return a @ref
18153 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18154 * They all take a data parameter that is meant to be used for a handle to
18155 * the applications internal data (eg the struct with the original item
18156 * data). The parent parameter is the parent genlist item this belongs to if
18157 * it is a tree or an indexed group, and NULL if there is no parent. The
18158 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18159 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18160 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18161 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18162 * is set then this item is group index item that is displayed at the top
18163 * until the next group comes. The func parameter is a convenience callback
18164 * that is called when the item is selected and the data parameter will be
18165 * the func_data parameter, obj be the genlist object and event_info will be
18166 * the genlist item.
18168 * elm_genlist_item_append() adds an item to the end of the list, or if
18169 * there is a parent, to the end of all the child items of the parent.
18170 * elm_genlist_item_prepend() is the same but adds to the beginning of
18171 * the list or children list. elm_genlist_item_insert_before() inserts at
18172 * item before another item and elm_genlist_item_insert_after() inserts after
18173 * the indicated item.
18175 * The application can clear the list with elm_gen_clear() which deletes
18176 * all the items in the list and elm_genlist_item_del() will delete a specific
18177 * item. elm_genlist_item_subitems_clear() will clear all items that are
18178 * children of the indicated parent item.
18180 * To help inspect list items you can jump to the item at the top of the list
18181 * with elm_genlist_first_item_get() which will return the item pointer, and
18182 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18183 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18184 * and previous items respectively relative to the indicated item. Using
18185 * these calls you can walk the entire item list/tree. Note that as a tree
18186 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18187 * let you know which item is the parent (and thus know how to skip them if
18190 * @section Genlist_Muti_Selection Multi-selection
18192 * If the application wants multiple items to be able to be selected,
18193 * elm_genlist_multi_select_set() can enable this. If the list is
18194 * single-selection only (the default), then elm_genlist_selected_item_get()
18195 * will return the selected item, if any, or NULL I none is selected. If the
18196 * list is multi-select then elm_genlist_selected_items_get() will return a
18197 * list (that is only valid as long as no items are modified (added, deleted,
18198 * selected or unselected)).
18200 * @section Genlist_Usage_Hints Usage hints
18202 * There are also convenience functions. elm_gen_item_genlist_get() will
18203 * return the genlist object the item belongs to. elm_genlist_item_show()
18204 * will make the scroller scroll to show that specific item so its visible.
18205 * elm_genlist_item_data_get() returns the data pointer set by the item
18206 * creation functions.
18208 * If an item changes (state of boolean changes, label or contents change),
18209 * then use elm_genlist_item_update() to have genlist update the item with
18210 * the new state. Genlist will re-realize the item thus call the functions
18211 * in the _Elm_Genlist_Item_Class for that item.
18213 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18214 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18215 * to expand/contract an item and get its expanded state, use
18216 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18217 * again to make an item disabled (unable to be selected and appear
18218 * differently) use elm_genlist_item_disabled_set() to set this and
18219 * elm_genlist_item_disabled_get() to get the disabled state.
18221 * In general to indicate how the genlist should expand items horizontally to
18222 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18223 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18224 * mode means that if items are too wide to fit, the scroller will scroll
18225 * horizontally. Otherwise items are expanded to fill the width of the
18226 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18227 * to the viewport width and limited to that size. This can be combined with
18228 * a different style that uses edjes' ellipsis feature (cutting text off like
18231 * Items will only call their selection func and callback when first becoming
18232 * selected. Any further clicks will do nothing, unless you enable always
18233 * select with elm_gen_always_select_mode_set(). This means even if
18234 * selected, every click will make the selected callbacks be called.
18235 * elm_genlist_no_select_mode_set() will turn off the ability to select
18236 * items entirely and they will neither appear selected nor call selected
18237 * callback functions.
18239 * Remember that you can create new styles and add your own theme augmentation
18240 * per application with elm_theme_extension_add(). If you absolutely must
18241 * have a specific style that overrides any theme the user or system sets up
18242 * you can use elm_theme_overlay_add() to add such a file.
18244 * @section Genlist_Implementation Implementation
18246 * Evas tracks every object you create. Every time it processes an event
18247 * (mouse move, down, up etc.) it needs to walk through objects and find out
18248 * what event that affects. Even worse every time it renders display updates,
18249 * in order to just calculate what to re-draw, it needs to walk through many
18250 * many many objects. Thus, the more objects you keep active, the more
18251 * overhead Evas has in just doing its work. It is advisable to keep your
18252 * active objects to the minimum working set you need. Also remember that
18253 * object creation and deletion carries an overhead, so there is a
18254 * middle-ground, which is not easily determined. But don't keep massive lists
18255 * of objects you can't see or use. Genlist does this with list objects. It
18256 * creates and destroys them dynamically as you scroll around. It groups them
18257 * into blocks so it can determine the visibility etc. of a whole block at
18258 * once as opposed to having to walk the whole list. This 2-level list allows
18259 * for very large numbers of items to be in the list (tests have used up to
18260 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18261 * may be different sizes, every item added needs to be calculated as to its
18262 * size and thus this presents a lot of overhead on populating the list, this
18263 * genlist employs a queue. Any item added is queued and spooled off over
18264 * time, actually appearing some time later, so if your list has many members
18265 * you may find it takes a while for them to all appear, with your process
18266 * consuming a lot of CPU while it is busy spooling.
18268 * Genlist also implements a tree structure, but it does so with callbacks to
18269 * the application, with the application filling in tree structures when
18270 * requested (allowing for efficient building of a very deep tree that could
18271 * even be used for file-management). See the above smart signal callbacks for
18274 * @section Genlist_Smart_Events Genlist smart events
18276 * Signals that you can add callbacks for are:
18277 * - @c "activated" - The user has double-clicked or pressed
18278 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18279 * item that was activated.
18280 * - @c "clicked,double" - The user has double-clicked an item. The @c
18281 * event_info parameter is the item that was double-clicked.
18282 * - @c "selected" - This is called when a user has made an item selected.
18283 * The event_info parameter is the genlist item that was selected.
18284 * - @c "unselected" - This is called when a user has made an item
18285 * unselected. The event_info parameter is the genlist item that was
18287 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18288 * called and the item is now meant to be expanded. The event_info
18289 * parameter is the genlist item that was indicated to expand. It is the
18290 * job of this callback to then fill in the child items.
18291 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18292 * called and the item is now meant to be contracted. The event_info
18293 * parameter is the genlist item that was indicated to contract. It is the
18294 * job of this callback to then delete the child items.
18295 * - @c "expand,request" - This is called when a user has indicated they want
18296 * to expand a tree branch item. The callback should decide if the item can
18297 * expand (has any children) and then call elm_genlist_item_expanded_set()
18298 * appropriately to set the state. The event_info parameter is the genlist
18299 * item that was indicated to expand.
18300 * - @c "contract,request" - This is called when a user has indicated they
18301 * want to contract a tree branch item. The callback should decide if the
18302 * item can contract (has any children) and then call
18303 * elm_genlist_item_expanded_set() appropriately to set the state. The
18304 * event_info parameter is the genlist item that was indicated to contract.
18305 * - @c "realized" - This is called when the item in the list is created as a
18306 * real evas object. event_info parameter is the genlist item that was
18307 * created. The object may be deleted at any time, so it is up to the
18308 * caller to not use the object pointer from elm_genlist_item_object_get()
18309 * in a way where it may point to freed objects.
18310 * - @c "unrealized" - This is called just before an item is unrealized.
18311 * After this call content objects provided will be deleted and the item
18312 * object itself delete or be put into a floating cache.
18313 * - @c "drag,start,up" - This is called when the item in the list has been
18314 * dragged (not scrolled) up.
18315 * - @c "drag,start,down" - This is called when the item in the list has been
18316 * dragged (not scrolled) down.
18317 * - @c "drag,start,left" - This is called when the item in the list has been
18318 * dragged (not scrolled) left.
18319 * - @c "drag,start,right" - This is called when the item in the list has
18320 * been dragged (not scrolled) right.
18321 * - @c "drag,stop" - This is called when the item in the list has stopped
18323 * - @c "drag" - This is called when the item in the list is being dragged.
18324 * - @c "longpressed" - This is called when the item is pressed for a certain
18325 * amount of time. By default it's 1 second.
18326 * - @c "scroll,anim,start" - This is called when scrolling animation has
18328 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18330 * - @c "scroll,drag,start" - This is called when dragging the content has
18332 * - @c "scroll,drag,stop" - This is called when dragging the content has
18334 * - @c "edge,top" - This is called when the genlist is scrolled until
18336 * - @c "edge,bottom" - This is called when the genlist is scrolled
18337 * until the bottom edge.
18338 * - @c "edge,left" - This is called when the genlist is scrolled
18339 * until the left edge.
18340 * - @c "edge,right" - This is called when the genlist is scrolled
18341 * until the right edge.
18342 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18344 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18346 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18348 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18350 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18351 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18352 * multi-touch pinched in.
18353 * - @c "swipe" - This is called when the genlist is swiped.
18354 * - @c "moved" - This is called when a genlist item is moved.
18355 * - @c "language,changed" - This is called when the program's language is
18358 * @section Genlist_Examples Examples
18360 * Here is a list of examples that use the genlist, trying to show some of
18361 * its capabilities:
18362 * - @ref genlist_example_01
18363 * - @ref genlist_example_02
18364 * - @ref genlist_example_03
18365 * - @ref genlist_example_04
18366 * - @ref genlist_example_05
18370 * @addtogroup Genlist
18375 * @enum _Elm_Genlist_Item_Flags
18376 * @typedef Elm_Genlist_Item_Flags
18378 * Defines if the item is of any special type (has subitems or it's the
18379 * index of a group), or is just a simple item.
18383 typedef enum _Elm_Genlist_Item_Flags
18385 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18386 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18387 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18388 } Elm_Genlist_Item_Flags;
18389 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18390 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18391 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18392 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18393 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18395 * Label fetching class function for Elm_Gen_Item_Class.
18396 * @param data The data passed in the item creation function
18397 * @param obj The base widget object
18398 * @param part The part name of the swallow
18399 * @return The allocated (NOT stringshared) string to set as the label
18401 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18403 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18404 * @param data The data passed in the item creation function
18405 * @param obj The base widget object
18406 * @param part The part name of the swallow
18407 * @return The content object to swallow
18409 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18411 * State fetching class function for Elm_Gen_Item_Class.
18412 * @param data The data passed in the item creation function
18413 * @param obj The base widget object
18414 * @param part The part name of the swallow
18415 * @return The hell if I know
18417 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18419 * Deletion class function for Elm_Gen_Item_Class.
18420 * @param data The data passed in the item creation function
18421 * @param obj The base widget object
18423 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18426 * @struct _Elm_Genlist_Item_Class
18428 * Genlist item class definition structs.
18430 * This struct contains the style and fetching functions that will define the
18431 * contents of each item.
18433 * @see @ref Genlist_Item_Class
18435 struct _Elm_Genlist_Item_Class
18437 const char *item_style; /**< style of this class. */
18438 struct Elm_Genlist_Item_Class_Func
18440 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18441 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18442 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18443 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18446 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18448 * Add a new genlist widget to the given parent Elementary
18449 * (container) object
18451 * @param parent The parent object
18452 * @return a new genlist widget handle or @c NULL, on errors
18454 * This function inserts a new genlist widget on the canvas.
18456 * @see elm_genlist_item_append()
18457 * @see elm_genlist_item_del()
18458 * @see elm_gen_clear()
18462 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18464 * Remove all items from a given genlist widget.
18466 * @param obj The genlist object
18468 * This removes (and deletes) all items in @p obj, leaving it empty.
18470 * This is deprecated. Please use elm_gen_clear() instead.
18472 * @see elm_genlist_item_del(), to remove just one item.
18476 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18478 * Enable or disable multi-selection in the genlist
18480 * @param obj The genlist object
18481 * @param multi Multi-select enable/disable. Default is disabled.
18483 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18484 * the list. This allows more than 1 item to be selected. To retrieve the list
18485 * of selected items, use elm_genlist_selected_items_get().
18487 * @see elm_genlist_selected_items_get()
18488 * @see elm_genlist_multi_select_get()
18492 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18494 * Gets if multi-selection in genlist is enabled or disabled.
18496 * @param obj The genlist object
18497 * @return Multi-select enabled/disabled
18498 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18500 * @see elm_genlist_multi_select_set()
18504 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18506 * This sets the horizontal stretching mode.
18508 * @param obj The genlist object
18509 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18511 * This sets the mode used for sizing items horizontally. Valid modes
18512 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18513 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18514 * the scroller will scroll horizontally. Otherwise items are expanded
18515 * to fill the width of the viewport of the scroller. If it is
18516 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18517 * limited to that size.
18519 * @see elm_genlist_horizontal_get()
18523 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18524 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18526 * Gets the horizontal stretching mode.
18528 * @param obj The genlist object
18529 * @return The mode to use
18530 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18532 * @see elm_genlist_horizontal_set()
18536 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18537 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18539 * Set the always select mode.
18541 * @param obj The genlist object
18542 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18543 * EINA_FALSE = off). Default is @c EINA_FALSE.
18545 * Items will only call their selection func and callback when first
18546 * becoming selected. Any further clicks will do nothing, unless you
18547 * enable always select with elm_gen_always_select_mode_set().
18548 * This means that, even if selected, every click will make the selected
18549 * callbacks be called.
18551 * This function is deprecated. please see elm_gen_always_select_mode_set()
18553 * @see elm_genlist_always_select_mode_get()
18557 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18559 * Get the always select mode.
18561 * @param obj The genlist object
18562 * @return The always select mode
18563 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18565 * @see elm_genlist_always_select_mode_set()
18569 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18571 * Enable/disable the no select mode.
18573 * @param obj The genlist object
18574 * @param no_select The no select mode
18575 * (EINA_TRUE = on, EINA_FALSE = off)
18577 * This will turn off the ability to select items entirely and they
18578 * will neither appear selected nor call selected callback functions.
18580 * @see elm_genlist_no_select_mode_get()
18584 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18586 * Gets whether the no select mode is enabled.
18588 * @param obj The genlist object
18589 * @return The no select mode
18590 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18592 * @see elm_genlist_no_select_mode_set()
18596 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18598 * Enable/disable compress mode.
18600 * @param obj The genlist object
18601 * @param compress The compress mode
18602 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18604 * This will enable the compress mode where items are "compressed"
18605 * horizontally to fit the genlist scrollable viewport width. This is
18606 * special for genlist. Do not rely on
18607 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18608 * work as genlist needs to handle it specially.
18610 * @see elm_genlist_compress_mode_get()
18614 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18616 * Get whether the compress mode is enabled.
18618 * @param obj The genlist object
18619 * @return The compress mode
18620 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18622 * @see elm_genlist_compress_mode_set()
18626 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18628 * Enable/disable height-for-width mode.
18630 * @param obj The genlist object
18631 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18632 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18634 * With height-for-width mode the item width will be fixed (restricted
18635 * to a minimum of) to the list width when calculating its size in
18636 * order to allow the height to be calculated based on it. This allows,
18637 * for instance, text block to wrap lines if the Edje part is
18638 * configured with "text.min: 0 1".
18640 * @note This mode will make list resize slower as it will have to
18641 * recalculate every item height again whenever the list width
18644 * @note When height-for-width mode is enabled, it also enables
18645 * compress mode (see elm_genlist_compress_mode_set()) and
18646 * disables homogeneous (see elm_genlist_homogeneous_set()).
18650 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18652 * Get whether the height-for-width mode is enabled.
18654 * @param obj The genlist object
18655 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18660 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18662 * Enable/disable horizontal and vertical bouncing effect.
18664 * @param obj The genlist object
18665 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18666 * EINA_FALSE = off). Default is @c EINA_FALSE.
18667 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18668 * EINA_FALSE = off). Default is @c EINA_TRUE.
18670 * This will enable or disable the scroller bouncing effect for the
18671 * genlist. See elm_scroller_bounce_set() for details.
18673 * @see elm_scroller_bounce_set()
18674 * @see elm_genlist_bounce_get()
18678 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18680 * Get whether the horizontal and vertical bouncing effect is enabled.
18682 * @param obj The genlist object
18683 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18685 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18688 * @see elm_genlist_bounce_set()
18692 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18694 * Enable/disable homogenous mode.
18696 * @param obj The genlist object
18697 * @param homogeneous Assume the items within the genlist are of the
18698 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18701 * This will enable the homogeneous mode where items are of the same
18702 * height and width so that genlist may do the lazy-loading at its
18703 * maximum (which increases the performance for scrolling the list). This
18704 * implies 'compressed' mode.
18706 * @see elm_genlist_compress_mode_set()
18707 * @see elm_genlist_homogeneous_get()
18711 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18713 * Get whether the homogenous mode is enabled.
18715 * @param obj The genlist object
18716 * @return Assume the items within the genlist are of the same height
18717 * and width (EINA_TRUE = on, EINA_FALSE = off)
18719 * @see elm_genlist_homogeneous_set()
18723 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18725 * Set the maximum number of items within an item block
18727 * @param obj The genlist object
18728 * @param n Maximum number of items within an item block. Default is 32.
18730 * This will configure the block count to tune to the target with
18731 * particular performance matrix.
18733 * A block of objects will be used to reduce the number of operations due to
18734 * many objects in the screen. It can determine the visibility, or if the
18735 * object has changed, it theme needs to be updated, etc. doing this kind of
18736 * calculation to the entire block, instead of per object.
18738 * The default value for the block count is enough for most lists, so unless
18739 * you know you will have a lot of objects visible in the screen at the same
18740 * time, don't try to change this.
18742 * @see elm_genlist_block_count_get()
18743 * @see @ref Genlist_Implementation
18747 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18749 * Get the maximum number of items within an item block
18751 * @param obj The genlist object
18752 * @return Maximum number of items within an item block
18754 * @see elm_genlist_block_count_set()
18758 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18760 * Set the timeout in seconds for the longpress event.
18762 * @param obj The genlist object
18763 * @param timeout timeout in seconds. Default is 1.
18765 * This option will change how long it takes to send an event "longpressed"
18766 * after the mouse down signal is sent to the list. If this event occurs, no
18767 * "clicked" event will be sent.
18769 * @see elm_genlist_longpress_timeout_set()
18773 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18775 * Get the timeout in seconds for the longpress event.
18777 * @param obj The genlist object
18778 * @return timeout in seconds
18780 * @see elm_genlist_longpress_timeout_get()
18784 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18786 * Append a new item in a given genlist widget.
18788 * @param obj The genlist object
18789 * @param itc The item class for the item
18790 * @param data The item data
18791 * @param parent The parent item, or NULL if none
18792 * @param flags Item flags
18793 * @param func Convenience function called when the item is selected
18794 * @param func_data Data passed to @p func above.
18795 * @return A handle to the item added or @c NULL if not possible
18797 * This adds the given item to the end of the list or the end of
18798 * the children list if the @p parent is given.
18800 * @see elm_genlist_item_prepend()
18801 * @see elm_genlist_item_insert_before()
18802 * @see elm_genlist_item_insert_after()
18803 * @see elm_genlist_item_del()
18807 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);
18809 * Prepend a new item in a given genlist widget.
18811 * @param obj The genlist object
18812 * @param itc The item class for the item
18813 * @param data The item data
18814 * @param parent The parent item, or NULL if none
18815 * @param flags Item flags
18816 * @param func Convenience function called when the item is selected
18817 * @param func_data Data passed to @p func above.
18818 * @return A handle to the item added or NULL if not possible
18820 * This adds an item to the beginning of the list or beginning of the
18821 * children of the parent if given.
18823 * @see elm_genlist_item_append()
18824 * @see elm_genlist_item_insert_before()
18825 * @see elm_genlist_item_insert_after()
18826 * @see elm_genlist_item_del()
18830 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);
18832 * Insert an item before another in a genlist widget
18834 * @param obj The genlist object
18835 * @param itc The item class for the item
18836 * @param data The item data
18837 * @param before The item to place this new one before.
18838 * @param flags Item flags
18839 * @param func Convenience function called when the item is selected
18840 * @param func_data Data passed to @p func above.
18841 * @return A handle to the item added or @c NULL if not possible
18843 * This inserts an item before another in the list. It will be in the
18844 * same tree level or group as the item it is inserted before.
18846 * @see elm_genlist_item_append()
18847 * @see elm_genlist_item_prepend()
18848 * @see elm_genlist_item_insert_after()
18849 * @see elm_genlist_item_del()
18853 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);
18855 * Insert an item after another in a genlist widget
18857 * @param obj The genlist object
18858 * @param itc The item class for the item
18859 * @param data The item data
18860 * @param after The item to place this new one after.
18861 * @param flags Item flags
18862 * @param func Convenience function called when the item is selected
18863 * @param func_data Data passed to @p func above.
18864 * @return A handle to the item added or @c NULL if not possible
18866 * This inserts an item after another in the list. It will be in the
18867 * same tree level or group as the item it is inserted after.
18869 * @see elm_genlist_item_append()
18870 * @see elm_genlist_item_prepend()
18871 * @see elm_genlist_item_insert_before()
18872 * @see elm_genlist_item_del()
18876 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);
18878 * Insert a new item into the sorted genlist object
18880 * @param obj The genlist object
18881 * @param itc The item class for the item
18882 * @param data The item data
18883 * @param parent The parent item, or NULL if none
18884 * @param flags Item flags
18885 * @param comp The function called for the sort
18886 * @param func Convenience function called when item selected
18887 * @param func_data Data passed to @p func above.
18888 * @return A handle to the item added or NULL if not possible
18892 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);
18893 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);
18894 /* operations to retrieve existing items */
18896 * Get the selectd item in the genlist.
18898 * @param obj The genlist object
18899 * @return The selected item, or NULL if none is selected.
18901 * This gets the selected item in the list (if multi-selection is enabled, only
18902 * the item that was first selected in the list is returned - which is not very
18903 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18906 * If no item is selected, NULL is returned.
18908 * @see elm_genlist_selected_items_get()
18912 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18914 * Get a list of selected items in the genlist.
18916 * @param obj The genlist object
18917 * @return The list of selected items, or NULL if none are selected.
18919 * It returns a list of the selected items. This list pointer is only valid so
18920 * long as the selection doesn't change (no items are selected or unselected, or
18921 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18922 * pointers. The order of the items in this list is the order which they were
18923 * selected, i.e. the first item in this list is the first item that was
18924 * selected, and so on.
18926 * @note If not in multi-select mode, consider using function
18927 * elm_genlist_selected_item_get() instead.
18929 * @see elm_genlist_multi_select_set()
18930 * @see elm_genlist_selected_item_get()
18934 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18936 * Get the mode item style of items in the genlist
18937 * @param obj The genlist object
18938 * @return The mode item style string, or NULL if none is specified
18940 * This is a constant string and simply defines the name of the
18941 * style that will be used for mode animations. It can be
18942 * @c NULL if you don't plan to use Genlist mode. See
18943 * elm_genlist_item_mode_set() for more info.
18947 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18949 * Set the mode item style of items in the genlist
18950 * @param obj The genlist object
18951 * @param style The mode item style string, or NULL if none is desired
18953 * This is a constant string and simply defines the name of the
18954 * style that will be used for mode animations. It can be
18955 * @c NULL if you don't plan to use Genlist mode. See
18956 * elm_genlist_item_mode_set() for more info.
18960 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18962 * Get a list of realized items in genlist
18964 * @param obj The genlist object
18965 * @return The list of realized items, nor NULL if none are realized.
18967 * This returns a list of the realized items in the genlist. The list
18968 * contains Elm_Genlist_Item pointers. The list must be freed by the
18969 * caller when done with eina_list_free(). The item pointers in the
18970 * list are only valid so long as those items are not deleted or the
18971 * genlist is not deleted.
18973 * @see elm_genlist_realized_items_update()
18977 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18979 * Get the item that is at the x, y canvas coords.
18981 * @param obj The gelinst object.
18982 * @param x The input x coordinate
18983 * @param y The input y coordinate
18984 * @param posret The position relative to the item returned here
18985 * @return The item at the coordinates or NULL if none
18987 * This returns the item at the given coordinates (which are canvas
18988 * relative, not object-relative). If an item is at that coordinate,
18989 * that item handle is returned, and if @p posret is not NULL, the
18990 * integer pointed to is set to a value of -1, 0 or 1, depending if
18991 * the coordinate is on the upper portion of that item (-1), on the
18992 * middle section (0) or on the lower part (1). If NULL is returned as
18993 * an item (no item found there), then posret may indicate -1 or 1
18994 * based if the coordinate is above or below all items respectively in
18999 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);
19001 * Get the first item in the genlist
19003 * This returns the first item in the list.
19005 * @param obj The genlist object
19006 * @return The first item, or NULL if none
19010 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19012 * Get the last item in the genlist
19014 * This returns the last item in the list.
19016 * @return The last item, or NULL if none
19020 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19022 * Set the scrollbar policy
19024 * @param obj The genlist object
19025 * @param policy_h Horizontal scrollbar policy.
19026 * @param policy_v Vertical scrollbar policy.
19028 * This sets the scrollbar visibility policy for the given genlist
19029 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19030 * made visible if it is needed, and otherwise kept hidden.
19031 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19032 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19033 * respectively for the horizontal and vertical scrollbars. Default is
19034 * #ELM_SMART_SCROLLER_POLICY_AUTO
19036 * @see elm_genlist_scroller_policy_get()
19040 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19042 * Get the scrollbar policy
19044 * @param obj The genlist object
19045 * @param policy_h Pointer to store the horizontal scrollbar policy.
19046 * @param policy_v Pointer to store the vertical scrollbar policy.
19048 * @see elm_genlist_scroller_policy_set()
19052 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);
19054 * Get the @b next item in a genlist widget's internal list of items,
19055 * given a handle to one of those items.
19057 * @param item The genlist item to fetch next from
19058 * @return The item after @p item, or @c NULL if there's none (and
19061 * This returns the item placed after the @p item, on the container
19064 * @see elm_genlist_item_prev_get()
19068 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19070 * Get the @b previous item in a genlist widget's internal list of items,
19071 * given a handle to one of those items.
19073 * @param item The genlist item to fetch previous from
19074 * @return The item before @p item, or @c NULL if there's none (and
19077 * This returns the item placed before the @p item, on the container
19080 * @see elm_genlist_item_next_get()
19084 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19086 * Get the genlist object's handle which contains a given genlist
19089 * @param item The item to fetch the container from
19090 * @return The genlist (parent) object
19092 * This returns the genlist object itself that an item belongs to.
19094 * This function is deprecated. Please use elm_gen_item_widget_get()
19098 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19100 * Get the parent item of the given item
19102 * @param it The item
19103 * @return The parent of the item or @c NULL if it has no parent.
19105 * This returns the item that was specified as parent of the item @p it on
19106 * elm_genlist_item_append() and insertion related functions.
19110 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19112 * Remove all sub-items (children) of the given item
19114 * @param it The item
19116 * This removes all items that are children (and their descendants) of the
19117 * given item @p it.
19119 * @see elm_genlist_clear()
19120 * @see elm_genlist_item_del()
19124 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19126 * Set whether a given genlist item is selected or not
19128 * @param it The item
19129 * @param selected Use @c EINA_TRUE, to make it selected, @c
19130 * EINA_FALSE to make it unselected
19132 * This sets the selected state of an item. If multi selection is
19133 * not enabled on the containing genlist and @p selected is @c
19134 * EINA_TRUE, any other previously selected items will get
19135 * unselected in favor of this new one.
19137 * @see elm_genlist_item_selected_get()
19141 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19143 * Get whether a given genlist item is selected or not
19145 * @param it The item
19146 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19148 * @see elm_genlist_item_selected_set() for more details
19152 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19154 * Sets the expanded state of an item.
19156 * @param it The item
19157 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19159 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19162 * The theme will respond to this change visually, and a signal "expanded" or
19163 * "contracted" will be sent from the genlist with a pointer to the item that
19164 * has been expanded/contracted.
19166 * Calling this function won't show or hide any child of this item (if it is
19167 * a parent). You must manually delete and create them on the callbacks fo
19168 * the "expanded" or "contracted" signals.
19170 * @see elm_genlist_item_expanded_get()
19174 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19176 * Get the expanded state of an item
19178 * @param it The item
19179 * @return The expanded state
19181 * This gets the expanded state of an item.
19183 * @see elm_genlist_item_expanded_set()
19187 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19189 * Get the depth of expanded item
19191 * @param it The genlist item object
19192 * @return The depth of expanded item
19196 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19198 * Set whether a given genlist item is disabled or not.
19200 * @param it The item
19201 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19202 * to enable it back.
19204 * A disabled item cannot be selected or unselected. It will also
19205 * change its appearance, to signal the user it's disabled.
19207 * @see elm_genlist_item_disabled_get()
19211 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19213 * Get whether a given genlist item is disabled or not.
19215 * @param it The item
19216 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19219 * @see elm_genlist_item_disabled_set() for more details
19223 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19225 * Sets the display only state of an item.
19227 * @param it The item
19228 * @param display_only @c EINA_TRUE if the item is display only, @c
19229 * EINA_FALSE otherwise.
19231 * A display only item cannot be selected or unselected. It is for
19232 * display only and not selecting or otherwise clicking, dragging
19233 * etc. by the user, thus finger size rules will not be applied to
19236 * It's good to set group index items to display only state.
19238 * @see elm_genlist_item_display_only_get()
19242 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19244 * Get the display only state of an item
19246 * @param it The item
19247 * @return @c EINA_TRUE if the item is display only, @c
19248 * EINA_FALSE otherwise.
19250 * @see elm_genlist_item_display_only_set()
19254 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19256 * Show the portion of a genlist's internal list containing a given
19257 * item, immediately.
19259 * @param it The item to display
19261 * This causes genlist to jump to the given item @p it and show it (by
19262 * immediately scrolling to that position), if it is not fully visible.
19264 * @see elm_genlist_item_bring_in()
19265 * @see elm_genlist_item_top_show()
19266 * @see elm_genlist_item_middle_show()
19270 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19272 * Animatedly bring in, to the visible are of a genlist, a given
19275 * @param it The item to display
19277 * This causes genlist to jump to the given item @p it and show it (by
19278 * animatedly scrolling), if it is not fully visible. This may use animation
19279 * to do so and take a period of time
19281 * @see elm_genlist_item_show()
19282 * @see elm_genlist_item_top_bring_in()
19283 * @see elm_genlist_item_middle_bring_in()
19287 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19289 * Show the portion of a genlist's internal list containing a given
19290 * item, immediately.
19292 * @param it The item to display
19294 * This causes genlist to jump to the given item @p it and show it (by
19295 * immediately scrolling to that position), if it is not fully visible.
19297 * The item will be positioned at the top of the genlist viewport.
19299 * @see elm_genlist_item_show()
19300 * @see elm_genlist_item_top_bring_in()
19304 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19306 * Animatedly bring in, to the visible are of a genlist, a given
19309 * @param it The item
19311 * This causes genlist to jump to the given item @p it and show it (by
19312 * animatedly scrolling), if it is not fully visible. This may use animation
19313 * to do so and take a period of time
19315 * The item will be positioned at the top of the genlist viewport.
19317 * @see elm_genlist_item_bring_in()
19318 * @see elm_genlist_item_top_show()
19322 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19324 * Show the portion of a genlist's internal list containing a given
19325 * item, immediately.
19327 * @param it The item to display
19329 * This causes genlist to jump to the given item @p it and show it (by
19330 * immediately scrolling to that position), if it is not fully visible.
19332 * The item will be positioned at the middle of the genlist viewport.
19334 * @see elm_genlist_item_show()
19335 * @see elm_genlist_item_middle_bring_in()
19339 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19341 * Animatedly bring in, to the visible are of a genlist, a given
19344 * @param it The item
19346 * This causes genlist to jump to the given item @p it and show it (by
19347 * animatedly scrolling), if it is not fully visible. This may use animation
19348 * to do so and take a period of time
19350 * The item will be positioned at the middle of the genlist viewport.
19352 * @see elm_genlist_item_bring_in()
19353 * @see elm_genlist_item_middle_show()
19357 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19359 * Remove a genlist item from the its parent, deleting it.
19361 * @param item The item to be removed.
19362 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19364 * @see elm_genlist_clear(), to remove all items in a genlist at
19369 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19371 * Return the data associated to a given genlist item
19373 * @param item The genlist item.
19374 * @return the data associated to this item.
19376 * This returns the @c data value passed on the
19377 * elm_genlist_item_append() and related item addition calls.
19379 * @see elm_genlist_item_append()
19380 * @see elm_genlist_item_data_set()
19384 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19386 * Set the data associated to a given genlist item
19388 * @param item The genlist item
19389 * @param data The new data pointer to set on it
19391 * This @b overrides the @c data value passed on the
19392 * elm_genlist_item_append() and related item addition calls. This
19393 * function @b won't call elm_genlist_item_update() automatically,
19394 * so you'd issue it afterwards if you want to hove the item
19395 * updated to reflect the that new data.
19397 * @see elm_genlist_item_data_get()
19401 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19403 * Tells genlist to "orphan" icons fetchs by the item class
19405 * @param it The item
19407 * This instructs genlist to release references to icons in the item,
19408 * meaning that they will no longer be managed by genlist and are
19409 * floating "orphans" that can be re-used elsewhere if the user wants
19414 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19415 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19417 * Get the real Evas object created to implement the view of a
19418 * given genlist item
19420 * @param item The genlist item.
19421 * @return the Evas object implementing this item's view.
19423 * This returns the actual Evas object used to implement the
19424 * specified genlist item's view. This may be @c NULL, as it may
19425 * not have been created or may have been deleted, at any time, by
19426 * the genlist. <b>Do not modify this object</b> (move, resize,
19427 * show, hide, etc.), as the genlist is controlling it. This
19428 * function is for querying, emitting custom signals or hooking
19429 * lower level callbacks for events on that object. Do not delete
19430 * this object under any circumstances.
19432 * @see elm_genlist_item_data_get()
19436 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19438 * Update the contents of an item
19440 * @param it The item
19442 * This updates an item by calling all the item class functions again
19443 * to get the icons, labels and states. Use this when the original
19444 * item data has changed and the changes are desired to be reflected.
19446 * Use elm_genlist_realized_items_update() to update all already realized
19449 * @see elm_genlist_realized_items_update()
19453 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19455 * Update the item class of an item
19457 * @param it The item
19458 * @param itc The item class for the item
19460 * This sets another class fo the item, changing the way that it is
19461 * displayed. After changing the item class, elm_genlist_item_update() is
19462 * called on the item @p it.
19466 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19467 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19469 * Set the text to be shown in a given genlist item's tooltips.
19471 * @param item The genlist item
19472 * @param text The text to set in the content
19474 * This call will setup the text to be used as tooltip to that item
19475 * (analogous to elm_object_tooltip_text_set(), but being item
19476 * tooltips with higher precedence than object tooltips). It can
19477 * have only one tooltip at a time, so any previous tooltip data
19478 * will get removed.
19480 * In order to set an icon or something else as a tooltip, look at
19481 * elm_genlist_item_tooltip_content_cb_set().
19485 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19487 * Set the content to be shown in a given genlist item's tooltips
19489 * @param item The genlist item.
19490 * @param func The function returning the tooltip contents.
19491 * @param data What to provide to @a func as callback data/context.
19492 * @param del_cb Called when data is not needed anymore, either when
19493 * another callback replaces @p func, the tooltip is unset with
19494 * elm_genlist_item_tooltip_unset() or the owner @p item
19495 * dies. This callback receives as its first parameter the
19496 * given @p data, being @c event_info the item handle.
19498 * This call will setup the tooltip's contents to @p item
19499 * (analogous to elm_object_tooltip_content_cb_set(), but being
19500 * item tooltips with higher precedence than object tooltips). It
19501 * can have only one tooltip at a time, so any previous tooltip
19502 * content will get removed. @p func (with @p data) will be called
19503 * every time Elementary needs to show the tooltip and it should
19504 * return a valid Evas object, which will be fully managed by the
19505 * tooltip system, getting deleted when the tooltip is gone.
19507 * In order to set just a text as a tooltip, look at
19508 * elm_genlist_item_tooltip_text_set().
19512 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);
19514 * Unset a tooltip from a given genlist item
19516 * @param item genlist item to remove a previously set tooltip from.
19518 * This call removes any tooltip set on @p item. The callback
19519 * provided as @c del_cb to
19520 * elm_genlist_item_tooltip_content_cb_set() will be called to
19521 * notify it is not used anymore (and have resources cleaned, if
19524 * @see elm_genlist_item_tooltip_content_cb_set()
19528 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19530 * Set a different @b style for a given genlist item's tooltip.
19532 * @param item genlist item with tooltip set
19533 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19534 * "default", @c "transparent", etc)
19536 * Tooltips can have <b>alternate styles</b> to be displayed on,
19537 * which are defined by the theme set on Elementary. This function
19538 * works analogously as elm_object_tooltip_style_set(), but here
19539 * applied only to genlist item objects. The default style for
19540 * tooltips is @c "default".
19542 * @note before you set a style you should define a tooltip with
19543 * elm_genlist_item_tooltip_content_cb_set() or
19544 * elm_genlist_item_tooltip_text_set()
19546 * @see elm_genlist_item_tooltip_style_get()
19550 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19552 * Get the style set a given genlist item's tooltip.
19554 * @param item genlist item with tooltip already set on.
19555 * @return style the theme style in use, which defaults to
19556 * "default". If the object does not have a tooltip set,
19557 * then @c NULL is returned.
19559 * @see elm_genlist_item_tooltip_style_set() for more details
19563 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19565 * @brief Disable size restrictions on an object's tooltip
19566 * @param item The tooltip's anchor object
19567 * @param disable If EINA_TRUE, size restrictions are disabled
19568 * @return EINA_FALSE on failure, EINA_TRUE on success
19570 * This function allows a tooltip to expand beyond its parant window's canvas.
19571 * It will instead be limited only by the size of the display.
19573 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19575 * @brief Retrieve size restriction state of an object's tooltip
19576 * @param item The tooltip's anchor object
19577 * @return If EINA_TRUE, size restrictions are disabled
19579 * This function returns whether a tooltip is allowed to expand beyond
19580 * its parant window's canvas.
19581 * It will instead be limited only by the size of the display.
19583 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19585 * Set the type of mouse pointer/cursor decoration to be shown,
19586 * when the mouse pointer is over the given genlist widget item
19588 * @param item genlist item to customize cursor on
19589 * @param cursor the cursor type's name
19591 * This function works analogously as elm_object_cursor_set(), but
19592 * here the cursor's changing area is restricted to the item's
19593 * area, and not the whole widget's. Note that that item cursors
19594 * have precedence over widget cursors, so that a mouse over @p
19595 * item will always show cursor @p type.
19597 * If this function is called twice for an object, a previously set
19598 * cursor will be unset on the second call.
19600 * @see elm_object_cursor_set()
19601 * @see elm_genlist_item_cursor_get()
19602 * @see elm_genlist_item_cursor_unset()
19606 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19608 * Get the type of mouse pointer/cursor decoration set to be shown,
19609 * when the mouse pointer is over the given genlist widget item
19611 * @param item genlist item with custom cursor set
19612 * @return the cursor type's name or @c NULL, if no custom cursors
19613 * were set to @p item (and on errors)
19615 * @see elm_object_cursor_get()
19616 * @see elm_genlist_item_cursor_set() for more details
19617 * @see elm_genlist_item_cursor_unset()
19621 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19623 * Unset any custom mouse pointer/cursor decoration set to be
19624 * shown, when the mouse pointer is over the given genlist widget
19625 * item, thus making it show the @b default cursor again.
19627 * @param item a genlist item
19629 * Use this call to undo any custom settings on this item's cursor
19630 * decoration, bringing it back to defaults (no custom style set).
19632 * @see elm_object_cursor_unset()
19633 * @see elm_genlist_item_cursor_set() for more details
19637 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19639 * Set a different @b style for a given custom cursor set for a
19642 * @param item genlist item with custom cursor set
19643 * @param style the <b>theme style</b> to use (e.g. @c "default",
19644 * @c "transparent", etc)
19646 * This function only makes sense when one is using custom mouse
19647 * cursor decorations <b>defined in a theme file</b> , which can
19648 * have, given a cursor name/type, <b>alternate styles</b> on
19649 * it. It works analogously as elm_object_cursor_style_set(), but
19650 * here applied only to genlist item objects.
19652 * @warning Before you set a cursor style you should have defined a
19653 * custom cursor previously on the item, with
19654 * elm_genlist_item_cursor_set()
19656 * @see elm_genlist_item_cursor_engine_only_set()
19657 * @see elm_genlist_item_cursor_style_get()
19661 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19663 * Get the current @b style set for a given genlist item's custom
19666 * @param item genlist item with custom cursor set.
19667 * @return style the cursor style in use. If the object does not
19668 * have a cursor set, then @c NULL is returned.
19670 * @see elm_genlist_item_cursor_style_set() for more details
19674 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19676 * Set if the (custom) cursor for a given genlist item should be
19677 * searched in its theme, also, or should only rely on the
19678 * rendering engine.
19680 * @param item item with custom (custom) cursor already set on
19681 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19682 * only on those provided by the rendering engine, @c EINA_FALSE to
19683 * have them searched on the widget's theme, as well.
19685 * @note This call is of use only if you've set a custom cursor
19686 * for genlist items, with elm_genlist_item_cursor_set().
19688 * @note By default, cursors will only be looked for between those
19689 * provided by the rendering engine.
19693 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19695 * Get if the (custom) cursor for a given genlist item is being
19696 * searched in its theme, also, or is only relying on the rendering
19699 * @param item a genlist item
19700 * @return @c EINA_TRUE, if cursors are being looked for only on
19701 * those provided by the rendering engine, @c EINA_FALSE if they
19702 * are being searched on the widget's theme, as well.
19704 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19708 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19710 * Update the contents of all realized items.
19712 * @param obj The genlist object.
19714 * This updates all realized items by calling all the item class functions again
19715 * to get the icons, labels and states. Use this when the original
19716 * item data has changed and the changes are desired to be reflected.
19718 * To update just one item, use elm_genlist_item_update().
19720 * @see elm_genlist_realized_items_get()
19721 * @see elm_genlist_item_update()
19725 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19727 * Activate a genlist mode on an item
19729 * @param item The genlist item
19730 * @param mode Mode name
19731 * @param mode_set Boolean to define set or unset mode.
19733 * A genlist mode is a different way of selecting an item. Once a mode is
19734 * activated on an item, any other selected item is immediately unselected.
19735 * This feature provides an easy way of implementing a new kind of animation
19736 * for selecting an item, without having to entirely rewrite the item style
19737 * theme. However, the elm_genlist_selected_* API can't be used to get what
19738 * item is activate for a mode.
19740 * The current item style will still be used, but applying a genlist mode to
19741 * an item will select it using a different kind of animation.
19743 * The current active item for a mode can be found by
19744 * elm_genlist_mode_item_get().
19746 * The characteristics of genlist mode are:
19747 * - Only one mode can be active at any time, and for only one item.
19748 * - Genlist handles deactivating other items when one item is activated.
19749 * - A mode is defined in the genlist theme (edc), and more modes can easily
19751 * - A mode style and the genlist item style are different things. They
19752 * can be combined to provide a default style to the item, with some kind
19753 * of animation for that item when the mode is activated.
19755 * When a mode is activated on an item, a new view for that item is created.
19756 * The theme of this mode defines the animation that will be used to transit
19757 * the item from the old view to the new view. This second (new) view will be
19758 * active for that item while the mode is active on the item, and will be
19759 * destroyed after the mode is totally deactivated from that item.
19761 * @see elm_genlist_mode_get()
19762 * @see elm_genlist_mode_item_get()
19766 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19768 * Get the last (or current) genlist mode used.
19770 * @param obj The genlist object
19772 * This function just returns the name of the last used genlist mode. It will
19773 * be the current mode if it's still active.
19775 * @see elm_genlist_item_mode_set()
19776 * @see elm_genlist_mode_item_get()
19780 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19782 * Get active genlist mode item
19784 * @param obj The genlist object
19785 * @return The active item for that current mode. Or @c NULL if no item is
19786 * activated with any mode.
19788 * This function returns the item that was activated with a mode, by the
19789 * function elm_genlist_item_mode_set().
19791 * @see elm_genlist_item_mode_set()
19792 * @see elm_genlist_mode_get()
19796 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19801 * @param obj The genlist object
19802 * @param reorder_mode The reorder mode
19803 * (EINA_TRUE = on, EINA_FALSE = off)
19807 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19810 * Get the reorder mode
19812 * @param obj The genlist object
19813 * @return The reorder mode
19814 * (EINA_TRUE = on, EINA_FALSE = off)
19818 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19825 * @defgroup Check Check
19827 * @image html img/widget/check/preview-00.png
19828 * @image latex img/widget/check/preview-00.eps
19829 * @image html img/widget/check/preview-01.png
19830 * @image latex img/widget/check/preview-01.eps
19831 * @image html img/widget/check/preview-02.png
19832 * @image latex img/widget/check/preview-02.eps
19834 * @brief The check widget allows for toggling a value between true and
19837 * Check objects are a lot like radio objects in layout and functionality
19838 * except they do not work as a group, but independently and only toggle the
19839 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19840 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19841 * returns the current state. For convenience, like the radio objects, you
19842 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19843 * for it to modify.
19845 * Signals that you can add callbacks for are:
19846 * "changed" - This is called whenever the user changes the state of one of
19847 * the check object(event_info is NULL).
19849 * Default contents parts of the check widget that you can use for are:
19850 * @li "icon" - A icon of the check
19852 * Default text parts of the check widget that you can use for are:
19853 * @li "elm.text" - Label of the check
19855 * @ref tutorial_check should give you a firm grasp of how to use this widget
19860 * @brief Add a new Check object
19862 * @param parent The parent object
19863 * @return The new object or NULL if it cannot be created
19865 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19867 * @brief Set the text label of the check object
19869 * @param obj The check object
19870 * @param label The text label string in UTF-8
19872 * @deprecated use elm_object_text_set() instead.
19874 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19876 * @brief Get the text label of the check object
19878 * @param obj The check object
19879 * @return The text label string in UTF-8
19881 * @deprecated use elm_object_text_get() instead.
19883 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19885 * @brief Set the icon object of the check object
19887 * @param obj The check object
19888 * @param icon The icon object
19890 * Once the icon object is set, a previously set one will be deleted.
19891 * If you want to keep that old content object, use the
19892 * elm_object_content_unset() function.
19894 * @deprecated use elm_object_content_part_set() instead.
19897 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19899 * @brief Get the icon object of the check object
19901 * @param obj The check object
19902 * @return The icon object
19904 * @deprecated use elm_object_content_part_get() instead.
19907 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19909 * @brief Unset the icon used for the check object
19911 * @param obj The check object
19912 * @return The icon object that was being used
19914 * Unparent and return the icon object which was set for this widget.
19916 * @deprecated use elm_object_content_part_unset() instead.
19919 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19921 * @brief Set the on/off state of the check object
19923 * @param obj The check object
19924 * @param state The state to use (1 == on, 0 == off)
19926 * This sets the state of the check. If set
19927 * with elm_check_state_pointer_set() the state of that variable is also
19928 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19930 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19932 * @brief Get the state of the check object
19934 * @param obj The check object
19935 * @return The boolean state
19937 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19939 * @brief Set a convenience pointer to a boolean to change
19941 * @param obj The check object
19942 * @param statep Pointer to the boolean to modify
19944 * This sets a pointer to a boolean, that, in addition to the check objects
19945 * state will also be modified directly. To stop setting the object pointed
19946 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19947 * then when this is called, the check objects state will also be modified to
19948 * reflect the value of the boolean @p statep points to, just like calling
19949 * elm_check_state_set().
19951 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19952 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19953 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19960 * @defgroup Radio Radio
19962 * @image html img/widget/radio/preview-00.png
19963 * @image latex img/widget/radio/preview-00.eps
19965 * @brief Radio is a widget that allows for 1 or more options to be displayed
19966 * and have the user choose only 1 of them.
19968 * A radio object contains an indicator, an optional Label and an optional
19969 * icon object. While it's possible to have a group of only one radio they,
19970 * are normally used in groups of 2 or more. To add a radio to a group use
19971 * elm_radio_group_add(). The radio object(s) will select from one of a set
19972 * of integer values, so any value they are configuring needs to be mapped to
19973 * a set of integers. To configure what value that radio object represents,
19974 * use elm_radio_state_value_set() to set the integer it represents. To set
19975 * the value the whole group(which one is currently selected) is to indicate
19976 * use elm_radio_value_set() on any group member, and to get the groups value
19977 * use elm_radio_value_get(). For convenience the radio objects are also able
19978 * to directly set an integer(int) to the value that is selected. To specify
19979 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19980 * The radio objects will modify this directly. That implies the pointer must
19981 * point to valid memory for as long as the radio objects exist.
19983 * Signals that you can add callbacks for are:
19984 * @li changed - This is called whenever the user changes the state of one of
19985 * the radio objects within the group of radio objects that work together.
19987 * Default contents parts of the radio widget that you can use for are:
19988 * @li "icon" - A icon of the radio
19990 * @ref tutorial_radio show most of this API in action.
19994 * @brief Add a new radio to the parent
19996 * @param parent The parent object
19997 * @return The new object or NULL if it cannot be created
19999 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20001 * @brief Set the text label of the radio object
20003 * @param obj The radio object
20004 * @param label The text label string in UTF-8
20006 * @deprecated use elm_object_text_set() instead.
20008 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20010 * @brief Get the text label of the radio object
20012 * @param obj The radio object
20013 * @return The text label string in UTF-8
20015 * @deprecated use elm_object_text_set() instead.
20017 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20019 * @brief Set the icon object of the radio object
20021 * @param obj The radio object
20022 * @param icon The icon object
20024 * Once the icon object is set, a previously set one will be deleted. If you
20025 * want to keep that old content object, use the elm_radio_icon_unset()
20028 * @deprecated use elm_object_content_part_set() instead.
20031 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20033 * @brief Get the icon object of the radio object
20035 * @param obj The radio object
20036 * @return The icon object
20038 * @see elm_radio_icon_set()
20040 * @deprecated use elm_object_content_part_get() instead.
20043 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20045 * @brief Unset the icon used for the radio object
20047 * @param obj The radio object
20048 * @return The icon object that was being used
20050 * Unparent and return the icon object which was set for this widget.
20052 * @see elm_radio_icon_set()
20053 * @deprecated use elm_object_content_part_unset() instead.
20056 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20058 * @brief Add this radio to a group of other radio objects
20060 * @param obj The radio object
20061 * @param group Any object whose group the @p obj is to join.
20063 * Radio objects work in groups. Each member should have a different integer
20064 * value assigned. In order to have them work as a group, they need to know
20065 * about each other. This adds the given radio object to the group of which
20066 * the group object indicated is a member.
20068 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20070 * @brief Set the integer value that this radio object represents
20072 * @param obj The radio object
20073 * @param value The value to use if this radio object is selected
20075 * This sets the value of the radio.
20077 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20079 * @brief Get the integer value that this radio object represents
20081 * @param obj The radio object
20082 * @return The value used if this radio object is selected
20084 * This gets the value of the radio.
20086 * @see elm_radio_value_set()
20088 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20090 * @brief Set the value of the radio.
20092 * @param obj The radio object
20093 * @param value The value to use for the group
20095 * This sets the value of the radio group and will also set the value if
20096 * pointed to, to the value supplied, but will not call any callbacks.
20098 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20100 * @brief Get the state of the radio object
20102 * @param obj The radio object
20103 * @return The integer state
20105 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20107 * @brief Set a convenience pointer to a integer to change
20109 * @param obj The radio object
20110 * @param valuep Pointer to the integer to modify
20112 * This sets a pointer to a integer, that, in addition to the radio objects
20113 * state will also be modified directly. To stop setting the object pointed
20114 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20115 * when this is called, the radio objects state will also be modified to
20116 * reflect the value of the integer valuep points to, just like calling
20117 * elm_radio_value_set().
20119 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20125 * @defgroup Pager Pager
20127 * @image html img/widget/pager/preview-00.png
20128 * @image latex img/widget/pager/preview-00.eps
20130 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
20132 * The flipping between āpagesā of objects is animated. All content in pager
20133 * is kept in a stack, the last content to be added will be on the top of the
20134 * stack(be visible).
20136 * Objects can be pushed or popped from the stack or deleted as normal.
20137 * Pushes and pops will animate (and a pop will delete the object once the
20138 * animation is finished). Any object already in the pager can be promoted to
20139 * the top(from its current stacking position) through the use of
20140 * elm_pager_content_promote(). Objects are pushed to the top with
20141 * elm_pager_content_push() and when the top item is no longer wanted, simply
20142 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20143 * object is no longer needed and is not the top item, just delete it as
20144 * normal. You can query which objects are the top and bottom with
20145 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20147 * Signals that you can add callbacks for are:
20148 * "hide,finished" - when the previous page is hided
20150 * This widget has the following styles available:
20153 * @li fade_translucide
20154 * @li fade_invisible
20155 * @note This styles affect only the flipping animations, the appearance when
20156 * not animating is unaffected by styles.
20158 * @ref tutorial_pager gives a good overview of the usage of the API.
20162 * Add a new pager to the parent
20164 * @param parent The parent object
20165 * @return The new object or NULL if it cannot be created
20169 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20171 * @brief Push an object to the top of the pager stack (and show it).
20173 * @param obj The pager object
20174 * @param content The object to push
20176 * The object pushed becomes a child of the pager, it will be controlled and
20177 * deleted when the pager is deleted.
20179 * @note If the content is already in the stack use
20180 * elm_pager_content_promote().
20181 * @warning Using this function on @p content already in the stack results in
20182 * undefined behavior.
20184 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20186 * @brief Pop the object that is on top of the stack
20188 * @param obj The pager object
20190 * This pops the object that is on the top(visible) of the pager, makes it
20191 * disappear, then deletes the object. The object that was underneath it on
20192 * the stack will become visible.
20194 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20196 * @brief Moves an object already in the pager stack to the top of the stack.
20198 * @param obj The pager object
20199 * @param content The object to promote
20201 * This will take the @p content and move it to the top of the stack as
20202 * if it had been pushed there.
20204 * @note If the content isn't already in the stack use
20205 * elm_pager_content_push().
20206 * @warning Using this function on @p content not already in the stack
20207 * results in undefined behavior.
20209 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20211 * @brief Return the object at the bottom of the pager stack
20213 * @param obj The pager object
20214 * @return The bottom object or NULL if none
20216 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20218 * @brief Return the object at the top of the pager stack
20220 * @param obj The pager object
20221 * @return The top object or NULL if none
20223 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20230 * @defgroup Slideshow Slideshow
20232 * @image html img/widget/slideshow/preview-00.png
20233 * @image latex img/widget/slideshow/preview-00.eps
20235 * This widget, as the name indicates, is a pre-made image
20236 * slideshow panel, with API functions acting on (child) image
20237 * items presentation. Between those actions, are:
20238 * - advance to next/previous image
20239 * - select the style of image transition animation
20240 * - set the exhibition time for each image
20241 * - start/stop the slideshow
20243 * The transition animations are defined in the widget's theme,
20244 * consequently new animations can be added without having to
20245 * update the widget's code.
20247 * @section Slideshow_Items Slideshow items
20249 * For slideshow items, just like for @ref Genlist "genlist" ones,
20250 * the user defines a @b classes, specifying functions that will be
20251 * called on the item's creation and deletion times.
20253 * The #Elm_Slideshow_Item_Class structure contains the following
20256 * - @c func.get - When an item is displayed, this function is
20257 * called, and it's where one should create the item object, de
20258 * facto. For example, the object can be a pure Evas image object
20259 * or an Elementary @ref Photocam "photocam" widget. See
20260 * #SlideshowItemGetFunc.
20261 * - @c func.del - When an item is no more displayed, this function
20262 * is called, where the user must delete any data associated to
20263 * the item. See #SlideshowItemDelFunc.
20265 * @section Slideshow_Caching Slideshow caching
20267 * The slideshow provides facilities to have items adjacent to the
20268 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20269 * you, so that the system does not have to decode image data
20270 * anymore at the time it has to actually switch images on its
20271 * viewport. The user is able to set the numbers of items to be
20272 * cached @b before and @b after the current item, in the widget's
20275 * Smart events one can add callbacks for are:
20277 * - @c "changed" - when the slideshow switches its view to a new
20280 * List of examples for the slideshow widget:
20281 * @li @ref slideshow_example
20285 * @addtogroup Slideshow
20289 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20290 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20291 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20292 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20293 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20296 * @struct _Elm_Slideshow_Item_Class
20298 * Slideshow item class definition. See @ref Slideshow_Items for
20301 struct _Elm_Slideshow_Item_Class
20303 struct _Elm_Slideshow_Item_Class_Func
20305 SlideshowItemGetFunc get;
20306 SlideshowItemDelFunc del;
20308 }; /**< #Elm_Slideshow_Item_Class member definitions */
20311 * Add a new slideshow widget to the given parent Elementary
20312 * (container) object
20314 * @param parent The parent object
20315 * @return A new slideshow widget handle or @c NULL, on errors
20317 * This function inserts a new slideshow widget on the canvas.
20319 * @ingroup Slideshow
20321 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20324 * Add (append) a new item in a given slideshow widget.
20326 * @param obj The slideshow object
20327 * @param itc The item class for the item
20328 * @param data The item's data
20329 * @return A handle to the item added or @c NULL, on errors
20331 * Add a new item to @p obj's internal list of items, appending it.
20332 * The item's class must contain the function really fetching the
20333 * image object to show for this item, which could be an Evas image
20334 * object or an Elementary photo, for example. The @p data
20335 * parameter is going to be passed to both class functions of the
20338 * @see #Elm_Slideshow_Item_Class
20339 * @see elm_slideshow_item_sorted_insert()
20341 * @ingroup Slideshow
20343 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20346 * Insert a new item into the given slideshow widget, using the @p func
20347 * function to sort items (by item handles).
20349 * @param obj The slideshow object
20350 * @param itc The item class for the item
20351 * @param data The item's data
20352 * @param func The comparing function to be used to sort slideshow
20353 * items <b>by #Elm_Slideshow_Item item handles</b>
20354 * @return Returns The slideshow item handle, on success, or
20355 * @c NULL, on errors
20357 * Add a new item to @p obj's internal list of items, in a position
20358 * determined by the @p func comparing function. The item's class
20359 * must contain the function really fetching the image object to
20360 * show for this item, which could be an Evas image object or an
20361 * Elementary photo, for example. The @p data parameter is going to
20362 * be passed to both class functions of the item.
20364 * @see #Elm_Slideshow_Item_Class
20365 * @see elm_slideshow_item_add()
20367 * @ingroup Slideshow
20369 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);
20372 * Display a given slideshow widget's item, programmatically.
20374 * @param obj The slideshow object
20375 * @param item The item to display on @p obj's viewport
20377 * The change between the current item and @p item will use the
20378 * transition @p obj is set to use (@see
20379 * elm_slideshow_transition_set()).
20381 * @ingroup Slideshow
20383 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20386 * Slide to the @b next item, in a given slideshow widget
20388 * @param obj The slideshow object
20390 * The sliding animation @p obj is set to use will be the
20391 * transition effect used, after this call is issued.
20393 * @note If the end of the slideshow's internal list of items is
20394 * reached, it'll wrap around to the list's beginning, again.
20396 * @ingroup Slideshow
20398 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20401 * Slide to the @b previous item, in a given slideshow widget
20403 * @param obj The slideshow object
20405 * The sliding animation @p obj is set to use will be the
20406 * transition effect used, after this call is issued.
20408 * @note If the beginning of the slideshow's internal list of items
20409 * is reached, it'll wrap around to the list's end, again.
20411 * @ingroup Slideshow
20413 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20416 * Returns the list of sliding transition/effect names available, for a
20417 * given slideshow widget.
20419 * @param obj The slideshow object
20420 * @return The list of transitions (list of @b stringshared strings
20423 * The transitions, which come from @p obj's theme, must be an EDC
20424 * data item named @c "transitions" on the theme file, with (prefix)
20425 * names of EDC programs actually implementing them.
20427 * The available transitions for slideshows on the default theme are:
20428 * - @c "fade" - the current item fades out, while the new one
20429 * fades in to the slideshow's viewport.
20430 * - @c "black_fade" - the current item fades to black, and just
20431 * then, the new item will fade in.
20432 * - @c "horizontal" - the current item slides horizontally, until
20433 * it gets out of the slideshow's viewport, while the new item
20434 * comes from the left to take its place.
20435 * - @c "vertical" - the current item slides vertically, until it
20436 * gets out of the slideshow's viewport, while the new item comes
20437 * from the bottom to take its place.
20438 * - @c "square" - the new item starts to appear from the middle of
20439 * the current one, but with a tiny size, growing until its
20440 * target (full) size and covering the old one.
20442 * @warning The stringshared strings get no new references
20443 * exclusive to the user grabbing the list, here, so if you'd like
20444 * to use them out of this call's context, you'd better @c
20445 * eina_stringshare_ref() them.
20447 * @see elm_slideshow_transition_set()
20449 * @ingroup Slideshow
20451 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20454 * Set the current slide transition/effect in use for a given
20457 * @param obj The slideshow object
20458 * @param transition The new transition's name string
20460 * If @p transition is implemented in @p obj's theme (i.e., is
20461 * contained in the list returned by
20462 * elm_slideshow_transitions_get()), this new sliding effect will
20463 * be used on the widget.
20465 * @see elm_slideshow_transitions_get() for more details
20467 * @ingroup Slideshow
20469 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20472 * Get the current slide transition/effect in use for a given
20475 * @param obj The slideshow object
20476 * @return The current transition's name
20478 * @see elm_slideshow_transition_set() for more details
20480 * @ingroup Slideshow
20482 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20485 * Set the interval between each image transition on a given
20486 * slideshow widget, <b>and start the slideshow, itself</b>
20488 * @param obj The slideshow object
20489 * @param timeout The new displaying timeout for images
20491 * After this call, the slideshow widget will start cycling its
20492 * view, sequentially and automatically, with the images of the
20493 * items it has. The time between each new image displayed is going
20494 * to be @p timeout, in @b seconds. If a different timeout was set
20495 * previously and an slideshow was in progress, it will continue
20496 * with the new time between transitions, after this call.
20498 * @note A value less than or equal to 0 on @p timeout will disable
20499 * the widget's internal timer, thus halting any slideshow which
20500 * could be happening on @p obj.
20502 * @see elm_slideshow_timeout_get()
20504 * @ingroup Slideshow
20506 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20509 * Get the interval set for image transitions on a given slideshow
20512 * @param obj The slideshow object
20513 * @return Returns the timeout set on it
20515 * @see elm_slideshow_timeout_set() for more details
20517 * @ingroup Slideshow
20519 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20522 * Set if, after a slideshow is started, for a given slideshow
20523 * widget, its items should be displayed cyclically or not.
20525 * @param obj The slideshow object
20526 * @param loop Use @c EINA_TRUE to make it cycle through items or
20527 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20530 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20531 * ignore what is set by this functions, i.e., they'll @b always
20532 * cycle through items. This affects only the "automatic"
20533 * slideshow, as set by elm_slideshow_timeout_set().
20535 * @see elm_slideshow_loop_get()
20537 * @ingroup Slideshow
20539 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20542 * Get if, after a slideshow is started, for a given slideshow
20543 * widget, its items are to be displayed cyclically or not.
20545 * @param obj The slideshow object
20546 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20547 * through or @c EINA_FALSE, otherwise
20549 * @see elm_slideshow_loop_set() for more details
20551 * @ingroup Slideshow
20553 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20556 * Remove all items from a given slideshow widget
20558 * @param obj The slideshow object
20560 * This removes (and deletes) all items in @p obj, leaving it
20563 * @see elm_slideshow_item_del(), to remove just one item.
20565 * @ingroup Slideshow
20567 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20570 * Get the internal list of items in a given slideshow widget.
20572 * @param obj The slideshow object
20573 * @return The list of items (#Elm_Slideshow_Item as data) or
20574 * @c NULL on errors.
20576 * This list is @b not to be modified in any way and must not be
20577 * freed. Use the list members with functions like
20578 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20580 * @warning This list is only valid until @p obj object's internal
20581 * items list is changed. It should be fetched again with another
20582 * call to this function when changes happen.
20584 * @ingroup Slideshow
20586 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20589 * Delete a given item from a slideshow widget.
20591 * @param item The slideshow item
20593 * @ingroup Slideshow
20595 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20598 * Return the data associated with a given slideshow item
20600 * @param item The slideshow item
20601 * @return Returns the data associated to this item
20603 * @ingroup Slideshow
20605 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20608 * Returns the currently displayed item, in a given slideshow widget
20610 * @param obj The slideshow object
20611 * @return A handle to the item being displayed in @p obj or
20612 * @c NULL, if none is (and on errors)
20614 * @ingroup Slideshow
20616 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20619 * Get the real Evas object created to implement the view of a
20620 * given slideshow item
20622 * @param item The slideshow item.
20623 * @return the Evas object implementing this item's view.
20625 * This returns the actual Evas object used to implement the
20626 * specified slideshow item's view. This may be @c NULL, as it may
20627 * not have been created or may have been deleted, at any time, by
20628 * the slideshow. <b>Do not modify this object</b> (move, resize,
20629 * show, hide, etc.), as the slideshow is controlling it. This
20630 * function is for querying, emitting custom signals or hooking
20631 * lower level callbacks for events on that object. Do not delete
20632 * this object under any circumstances.
20634 * @see elm_slideshow_item_data_get()
20636 * @ingroup Slideshow
20638 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20641 * Get the the item, in a given slideshow widget, placed at
20642 * position @p nth, in its internal items list
20644 * @param obj The slideshow object
20645 * @param nth The number of the item to grab a handle to (0 being
20647 * @return The item stored in @p obj at position @p nth or @c NULL,
20648 * if there's no item with that index (and on errors)
20650 * @ingroup Slideshow
20652 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20655 * Set the current slide layout in use for a given slideshow widget
20657 * @param obj The slideshow object
20658 * @param layout The new layout's name string
20660 * If @p layout is implemented in @p obj's theme (i.e., is contained
20661 * in the list returned by elm_slideshow_layouts_get()), this new
20662 * images layout will be used on the widget.
20664 * @see elm_slideshow_layouts_get() for more details
20666 * @ingroup Slideshow
20668 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20671 * Get the current slide layout in use for a given slideshow widget
20673 * @param obj The slideshow object
20674 * @return The current layout's name
20676 * @see elm_slideshow_layout_set() for more details
20678 * @ingroup Slideshow
20680 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20683 * Returns the list of @b layout names available, for a given
20684 * slideshow widget.
20686 * @param obj The slideshow object
20687 * @return The list of layouts (list of @b stringshared strings
20690 * Slideshow layouts will change how the widget is to dispose each
20691 * image item in its viewport, with regard to cropping, scaling,
20694 * The layouts, which come from @p obj's theme, must be an EDC
20695 * data item name @c "layouts" on the theme file, with (prefix)
20696 * names of EDC programs actually implementing them.
20698 * The available layouts for slideshows on the default theme are:
20699 * - @c "fullscreen" - item images with original aspect, scaled to
20700 * touch top and down slideshow borders or, if the image's heigh
20701 * is not enough, left and right slideshow borders.
20702 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20703 * one, but always leaving 10% of the slideshow's dimensions of
20704 * distance between the item image's borders and the slideshow
20705 * borders, for each axis.
20707 * @warning The stringshared strings get no new references
20708 * exclusive to the user grabbing the list, here, so if you'd like
20709 * to use them out of this call's context, you'd better @c
20710 * eina_stringshare_ref() them.
20712 * @see elm_slideshow_layout_set()
20714 * @ingroup Slideshow
20716 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20719 * Set the number of items to cache, on a given slideshow widget,
20720 * <b>before the current item</b>
20722 * @param obj The slideshow object
20723 * @param count Number of items to cache before the current one
20725 * The default value for this property is @c 2. See
20726 * @ref Slideshow_Caching "slideshow caching" for more details.
20728 * @see elm_slideshow_cache_before_get()
20730 * @ingroup Slideshow
20732 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20735 * Retrieve the number of items to cache, on a given slideshow widget,
20736 * <b>before the current item</b>
20738 * @param obj The slideshow object
20739 * @return The number of items set to be cached before the current one
20741 * @see elm_slideshow_cache_before_set() for more details
20743 * @ingroup Slideshow
20745 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20748 * Set the number of items to cache, on a given slideshow widget,
20749 * <b>after the current item</b>
20751 * @param obj The slideshow object
20752 * @param count Number of items to cache after the current one
20754 * The default value for this property is @c 2. See
20755 * @ref Slideshow_Caching "slideshow caching" for more details.
20757 * @see elm_slideshow_cache_after_get()
20759 * @ingroup Slideshow
20761 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20764 * Retrieve the number of items to cache, on a given slideshow widget,
20765 * <b>after the current item</b>
20767 * @param obj The slideshow object
20768 * @return The number of items set to be cached after the current one
20770 * @see elm_slideshow_cache_after_set() for more details
20772 * @ingroup Slideshow
20774 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20777 * Get the number of items stored in a given slideshow widget
20779 * @param obj The slideshow object
20780 * @return The number of items on @p obj, at the moment of this call
20782 * @ingroup Slideshow
20784 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20791 * @defgroup Fileselector File Selector
20793 * @image html img/widget/fileselector/preview-00.png
20794 * @image latex img/widget/fileselector/preview-00.eps
20796 * A file selector is a widget that allows a user to navigate
20797 * through a file system, reporting file selections back via its
20800 * It contains shortcut buttons for home directory (@c ~) and to
20801 * jump one directory upwards (..), as well as cancel/ok buttons to
20802 * confirm/cancel a given selection. After either one of those two
20803 * former actions, the file selector will issue its @c "done" smart
20806 * There's a text entry on it, too, showing the name of the current
20807 * selection. There's the possibility of making it editable, so it
20808 * is useful on file saving dialogs on applications, where one
20809 * gives a file name to save contents to, in a given directory in
20810 * the system. This custom file name will be reported on the @c
20811 * "done" smart callback (explained in sequence).
20813 * Finally, it has a view to display file system items into in two
20818 * If Elementary is built with support of the Ethumb thumbnailing
20819 * library, the second form of view will display preview thumbnails
20820 * of files which it supports.
20822 * Smart callbacks one can register to:
20824 * - @c "selected" - the user has clicked on a file (when not in
20825 * folders-only mode) or directory (when in folders-only mode)
20826 * - @c "directory,open" - the list has been populated with new
20827 * content (@c event_info is a pointer to the directory's
20828 * path, a @b stringshared string)
20829 * - @c "done" - the user has clicked on the "ok" or "cancel"
20830 * buttons (@c event_info is a pointer to the selection's
20831 * path, a @b stringshared string)
20833 * Here is an example on its usage:
20834 * @li @ref fileselector_example
20838 * @addtogroup Fileselector
20843 * Defines how a file selector widget is to layout its contents
20844 * (file system entries).
20846 typedef enum _Elm_Fileselector_Mode
20848 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20849 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20850 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20851 } Elm_Fileselector_Mode;
20854 * Add a new file selector widget to the given parent Elementary
20855 * (container) object
20857 * @param parent The parent object
20858 * @return a new file selector widget handle or @c NULL, on errors
20860 * This function inserts a new file selector widget on the canvas.
20862 * @ingroup Fileselector
20864 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20867 * Enable/disable the file name entry box where the user can type
20868 * in a name for a file, in a given file selector widget
20870 * @param obj The file selector object
20871 * @param is_save @c EINA_TRUE to make the file selector a "saving
20872 * dialog", @c EINA_FALSE otherwise
20874 * Having the entry editable is useful on file saving dialogs on
20875 * applications, where one gives a file name to save contents to,
20876 * in a given directory in the system. This custom file name will
20877 * be reported on the @c "done" smart callback.
20879 * @see elm_fileselector_is_save_get()
20881 * @ingroup Fileselector
20883 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20886 * Get whether the given file selector is in "saving dialog" mode
20888 * @param obj The file selector object
20889 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20890 * mode, @c EINA_FALSE otherwise (and on errors)
20892 * @see elm_fileselector_is_save_set() for more details
20894 * @ingroup Fileselector
20896 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20899 * Enable/disable folder-only view for a given file selector widget
20901 * @param obj The file selector object
20902 * @param only @c EINA_TRUE to make @p obj only display
20903 * directories, @c EINA_FALSE to make files to be displayed in it
20906 * If enabled, the widget's view will only display folder items,
20909 * @see elm_fileselector_folder_only_get()
20911 * @ingroup Fileselector
20913 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20916 * Get whether folder-only view is set for a given file selector
20919 * @param obj The file selector object
20920 * @return only @c EINA_TRUE if @p obj is only displaying
20921 * directories, @c EINA_FALSE if files are being displayed in it
20922 * too (and on errors)
20924 * @see elm_fileselector_folder_only_get()
20926 * @ingroup Fileselector
20928 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20931 * Enable/disable the "ok" and "cancel" buttons on a given file
20934 * @param obj The file selector object
20935 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20937 * @note A file selector without those buttons will never emit the
20938 * @c "done" smart event, and is only usable if one is just hooking
20939 * to the other two events.
20941 * @see elm_fileselector_buttons_ok_cancel_get()
20943 * @ingroup Fileselector
20945 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20948 * Get whether the "ok" and "cancel" buttons on a given file
20949 * selector widget are being shown.
20951 * @param obj The file selector object
20952 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20953 * otherwise (and on errors)
20955 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20957 * @ingroup Fileselector
20959 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20962 * Enable/disable a tree view in the given file selector widget,
20963 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20965 * @param obj The file selector object
20966 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20969 * In a tree view, arrows are created on the sides of directories,
20970 * allowing them to expand in place.
20972 * @note If it's in other mode, the changes made by this function
20973 * will only be visible when one switches back to "list" mode.
20975 * @see elm_fileselector_expandable_get()
20977 * @ingroup Fileselector
20979 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20982 * Get whether tree view is enabled for the given file selector
20985 * @param obj The file selector object
20986 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20987 * otherwise (and or errors)
20989 * @see elm_fileselector_expandable_set() for more details
20991 * @ingroup Fileselector
20993 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20996 * Set, programmatically, the @b directory that a given file
20997 * selector widget will display contents from
20999 * @param obj The file selector object
21000 * @param path The path to display in @p obj
21002 * This will change the @b directory that @p obj is displaying. It
21003 * will also clear the text entry area on the @p obj object, which
21004 * displays select files' names.
21006 * @see elm_fileselector_path_get()
21008 * @ingroup Fileselector
21010 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21013 * Get the parent directory's path that a given file selector
21014 * widget is displaying
21016 * @param obj The file selector object
21017 * @return The (full) path of the directory the file selector is
21018 * displaying, a @b stringshared string
21020 * @see elm_fileselector_path_set()
21022 * @ingroup Fileselector
21024 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027 * Set, programmatically, the currently selected file/directory in
21028 * the given file selector widget
21030 * @param obj The file selector object
21031 * @param path The (full) path to a file or directory
21032 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21033 * latter case occurs if the directory or file pointed to do not
21036 * @see elm_fileselector_selected_get()
21038 * @ingroup Fileselector
21040 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21043 * Get the currently selected item's (full) path, in the given file
21046 * @param obj The file selector object
21047 * @return The absolute path of the selected item, a @b
21048 * stringshared string
21050 * @note Custom editions on @p obj object's text entry, if made,
21051 * will appear on the return string of this function, naturally.
21053 * @see elm_fileselector_selected_set() for more details
21055 * @ingroup Fileselector
21057 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21060 * Set the mode in which a given file selector widget will display
21061 * (layout) file system entries in its view
21063 * @param obj The file selector object
21064 * @param mode The mode of the fileselector, being it one of
21065 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21066 * first one, naturally, will display the files in a list. The
21067 * latter will make the widget to display its entries in a grid
21070 * @note By using elm_fileselector_expandable_set(), the user may
21071 * trigger a tree view for that list.
21073 * @note If Elementary is built with support of the Ethumb
21074 * thumbnailing library, the second form of view will display
21075 * preview thumbnails of files which it supports. You must have
21076 * elm_need_ethumb() called in your Elementary for thumbnailing to
21079 * @see elm_fileselector_expandable_set().
21080 * @see elm_fileselector_mode_get().
21082 * @ingroup Fileselector
21084 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21087 * Get the mode in which a given file selector widget is displaying
21088 * (layouting) file system entries in its view
21090 * @param obj The fileselector object
21091 * @return The mode in which the fileselector is at
21093 * @see elm_fileselector_mode_set() for more details
21095 * @ingroup Fileselector
21097 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21104 * @defgroup Progressbar Progress bar
21106 * The progress bar is a widget for visually representing the
21107 * progress status of a given job/task.
21109 * A progress bar may be horizontal or vertical. It may display an
21110 * icon besides it, as well as primary and @b units labels. The
21111 * former is meant to label the widget as a whole, while the
21112 * latter, which is formatted with floating point values (and thus
21113 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21114 * units"</c>), is meant to label the widget's <b>progress
21115 * value</b>. Label, icon and unit strings/objects are @b optional
21116 * for progress bars.
21118 * A progress bar may be @b inverted, in which state it gets its
21119 * values inverted, with high values being on the left or top and
21120 * low values on the right or bottom, as opposed to normally have
21121 * the low values on the former and high values on the latter,
21122 * respectively, for horizontal and vertical modes.
21124 * The @b span of the progress, as set by
21125 * elm_progressbar_span_size_set(), is its length (horizontally or
21126 * vertically), unless one puts size hints on the widget to expand
21127 * on desired directions, by any container. That length will be
21128 * scaled by the object or applications scaling factor. At any
21129 * point code can query the progress bar for its value with
21130 * elm_progressbar_value_get().
21132 * Available widget styles for progress bars:
21134 * - @c "wheel" (simple style, no text, no progression, only
21135 * "pulse" effect is available)
21137 * Default contents parts of the progressbar widget that you can use for are:
21138 * @li "icon" - A icon of the progressbar
21140 * Here is an example on its usage:
21141 * @li @ref progressbar_example
21145 * Add a new progress bar widget to the given parent Elementary
21146 * (container) object
21148 * @param parent The parent object
21149 * @return a new progress bar widget handle or @c NULL, on errors
21151 * This function inserts a new progress bar widget on the canvas.
21153 * @ingroup Progressbar
21155 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21158 * Set whether a given progress bar widget is at "pulsing mode" or
21161 * @param obj The progress bar object
21162 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21163 * @c EINA_FALSE to put it back to its default one
21165 * By default, progress bars will display values from the low to
21166 * high value boundaries. There are, though, contexts in which the
21167 * state of progression of a given task is @b unknown. For those,
21168 * one can set a progress bar widget to a "pulsing state", to give
21169 * the user an idea that some computation is being held, but
21170 * without exact progress values. In the default theme it will
21171 * animate its bar with the contents filling in constantly and back
21172 * to non-filled, in a loop. To start and stop this pulsing
21173 * animation, one has to explicitly call elm_progressbar_pulse().
21175 * @see elm_progressbar_pulse_get()
21176 * @see elm_progressbar_pulse()
21178 * @ingroup Progressbar
21180 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21183 * Get whether a given progress bar widget is at "pulsing mode" or
21186 * @param obj The progress bar object
21187 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21188 * if it's in the default one (and on errors)
21190 * @ingroup Progressbar
21192 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21195 * Start/stop a given progress bar "pulsing" animation, if its
21198 * @param obj The progress bar object
21199 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21200 * @c EINA_FALSE to @b stop it
21202 * @note This call won't do anything if @p obj is not under "pulsing mode".
21204 * @see elm_progressbar_pulse_set() for more details.
21206 * @ingroup Progressbar
21208 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21211 * Set the progress value (in percentage) on a given progress bar
21214 * @param obj The progress bar object
21215 * @param val The progress value (@b must be between @c 0.0 and @c
21218 * Use this call to set progress bar levels.
21220 * @note If you passes a value out of the specified range for @p
21221 * val, it will be interpreted as the @b closest of the @b boundary
21222 * values in the range.
21224 * @ingroup Progressbar
21226 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21229 * Get the progress value (in percentage) on a given progress bar
21232 * @param obj The progress bar object
21233 * @return The value of the progressbar
21235 * @see elm_progressbar_value_set() for more details
21237 * @ingroup Progressbar
21239 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21242 * Set the label of a given progress bar widget
21244 * @param obj The progress bar object
21245 * @param label The text label string, in UTF-8
21247 * @ingroup Progressbar
21248 * @deprecated use elm_object_text_set() instead.
21250 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21253 * Get the label of a given progress bar widget
21255 * @param obj The progressbar object
21256 * @return The text label string, in UTF-8
21258 * @ingroup Progressbar
21259 * @deprecated use elm_object_text_set() instead.
21261 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21264 * Set the icon object of a given progress bar widget
21266 * @param obj The progress bar object
21267 * @param icon The icon object
21269 * Use this call to decorate @p obj with an icon next to it.
21271 * @note Once the icon object is set, a previously set one will be
21272 * deleted. If you want to keep that old content object, use the
21273 * elm_progressbar_icon_unset() function.
21275 * @see elm_progressbar_icon_get()
21276 * @deprecated use elm_object_content_part_set() instead.
21278 * @ingroup Progressbar
21280 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21283 * Retrieve the icon object set for a given progress bar widget
21285 * @param obj The progress bar object
21286 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21287 * otherwise (and on errors)
21289 * @see elm_progressbar_icon_set() for more details
21290 * @deprecated use elm_object_content_part_get() instead.
21292 * @ingroup Progressbar
21294 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21297 * Unset an icon set on a given progress bar widget
21299 * @param obj The progress bar object
21300 * @return The icon object that was being used, if any was set, or
21301 * @c NULL, otherwise (and on errors)
21303 * This call will unparent and return the icon object which was set
21304 * for this widget, previously, on success.
21306 * @see elm_progressbar_icon_set() for more details
21307 * @deprecated use elm_object_content_part_unset() instead.
21309 * @ingroup Progressbar
21311 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21314 * Set the (exact) length of the bar region of a given progress bar
21317 * @param obj The progress bar object
21318 * @param size The length of the progress bar's bar region
21320 * This sets the minimum width (when in horizontal mode) or height
21321 * (when in vertical mode) of the actual bar area of the progress
21322 * bar @p obj. This in turn affects the object's minimum size. Use
21323 * this when you're not setting other size hints expanding on the
21324 * given direction (like weight and alignment hints) and you would
21325 * like it to have a specific size.
21327 * @note Icon, label and unit text around @p obj will require their
21328 * own space, which will make @p obj to require more the @p size,
21331 * @see elm_progressbar_span_size_get()
21333 * @ingroup Progressbar
21335 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21338 * Get the length set for the bar region of a given progress bar
21341 * @param obj The progress bar object
21342 * @return The length of the progress bar's bar region
21344 * If that size was not set previously, with
21345 * elm_progressbar_span_size_set(), this call will return @c 0.
21347 * @ingroup Progressbar
21349 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21352 * Set the format string for a given progress bar widget's units
21355 * @param obj The progress bar object
21356 * @param format The format string for @p obj's units label
21358 * If @c NULL is passed on @p format, it will make @p obj's units
21359 * area to be hidden completely. If not, it'll set the <b>format
21360 * string</b> for the units label's @b text. The units label is
21361 * provided a floating point value, so the units text is up display
21362 * at most one floating point falue. Note that the units label is
21363 * optional. Use a format string such as "%1.2f meters" for
21366 * @note The default format string for a progress bar is an integer
21367 * percentage, as in @c "%.0f %%".
21369 * @see elm_progressbar_unit_format_get()
21371 * @ingroup Progressbar
21373 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21376 * Retrieve the format string set for a given progress bar widget's
21379 * @param obj The progress bar object
21380 * @return The format set string for @p obj's units label or
21381 * @c NULL, if none was set (and on errors)
21383 * @see elm_progressbar_unit_format_set() for more details
21385 * @ingroup Progressbar
21387 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21390 * Set the orientation of a given progress bar widget
21392 * @param obj The progress bar object
21393 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21394 * @b horizontal, @c EINA_FALSE to make it @b vertical
21396 * Use this function to change how your progress bar is to be
21397 * disposed: vertically or horizontally.
21399 * @see elm_progressbar_horizontal_get()
21401 * @ingroup Progressbar
21403 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21406 * Retrieve the orientation of a given progress bar widget
21408 * @param obj The progress bar object
21409 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21410 * @c EINA_FALSE if it's @b vertical (and on errors)
21412 * @see elm_progressbar_horizontal_set() for more details
21414 * @ingroup Progressbar
21416 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21419 * Invert a given progress bar widget's displaying values order
21421 * @param obj The progress bar object
21422 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21423 * @c EINA_FALSE to bring it back to default, non-inverted values.
21425 * A progress bar may be @b inverted, in which state it gets its
21426 * values inverted, with high values being on the left or top and
21427 * low values on the right or bottom, as opposed to normally have
21428 * the low values on the former and high values on the latter,
21429 * respectively, for horizontal and vertical modes.
21431 * @see elm_progressbar_inverted_get()
21433 * @ingroup Progressbar
21435 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21438 * Get whether a given progress bar widget's displaying values are
21441 * @param obj The progress bar object
21442 * @return @c EINA_TRUE, if @p obj has inverted values,
21443 * @c EINA_FALSE otherwise (and on errors)
21445 * @see elm_progressbar_inverted_set() for more details
21447 * @ingroup Progressbar
21449 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452 * @defgroup Separator Separator
21454 * @brief Separator is a very thin object used to separate other objects.
21456 * A separator can be vertical or horizontal.
21458 * @ref tutorial_separator is a good example of how to use a separator.
21462 * @brief Add a separator object to @p parent
21464 * @param parent The parent object
21466 * @return The separator object, or NULL upon failure
21468 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21470 * @brief Set the horizontal mode of a separator object
21472 * @param obj The separator object
21473 * @param horizontal If true, the separator is horizontal
21475 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21477 * @brief Get the horizontal mode of a separator object
21479 * @param obj The separator object
21480 * @return If true, the separator is horizontal
21482 * @see elm_separator_horizontal_set()
21484 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21490 * @defgroup Spinner Spinner
21491 * @ingroup Elementary
21493 * @image html img/widget/spinner/preview-00.png
21494 * @image latex img/widget/spinner/preview-00.eps
21496 * A spinner is a widget which allows the user to increase or decrease
21497 * numeric values using arrow buttons, or edit values directly, clicking
21498 * over it and typing the new value.
21500 * By default the spinner will not wrap and has a label
21501 * of "%.0f" (just showing the integer value of the double).
21503 * A spinner has a label that is formatted with floating
21504 * point values and thus accepts a printf-style format string, like
21505 * ā%1.2f unitsā.
21507 * It also allows specific values to be replaced by pre-defined labels.
21509 * Smart callbacks one can register to:
21511 * - "changed" - Whenever the spinner value is changed.
21512 * - "delay,changed" - A short time after the value is changed by the user.
21513 * This will be called only when the user stops dragging for a very short
21514 * period or when they release their finger/mouse, so it avoids possibly
21515 * expensive reactions to the value change.
21517 * Available styles for it:
21519 * - @c "vertical": up/down buttons at the right side and text left aligned.
21521 * Here is an example on its usage:
21522 * @ref spinner_example
21526 * @addtogroup Spinner
21531 * Add a new spinner widget to the given parent Elementary
21532 * (container) object.
21534 * @param parent The parent object.
21535 * @return a new spinner widget handle or @c NULL, on errors.
21537 * This function inserts a new spinner widget on the canvas.
21542 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21545 * Set the format string of the displayed label.
21547 * @param obj The spinner object.
21548 * @param fmt The format string for the label display.
21550 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21551 * string for the label text. The label text is provided a floating point
21552 * value, so the label text can display up to 1 floating point value.
21553 * Note that this is optional.
21555 * Use a format string such as "%1.2f meters" for example, and it will
21556 * display values like: "3.14 meters" for a value equal to 3.14159.
21558 * Default is "%0.f".
21560 * @see elm_spinner_label_format_get()
21564 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21567 * Get the label format of the spinner.
21569 * @param obj The spinner object.
21570 * @return The text label format string in UTF-8.
21572 * @see elm_spinner_label_format_set() for details.
21576 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21579 * Set the minimum and maximum values for the spinner.
21581 * @param obj The spinner object.
21582 * @param min The minimum value.
21583 * @param max The maximum value.
21585 * Define the allowed range of values to be selected by the user.
21587 * If actual value is less than @p min, it will be updated to @p min. If it
21588 * is bigger then @p max, will be updated to @p max. Actual value can be
21589 * get with elm_spinner_value_get().
21591 * By default, min is equal to 0, and max is equal to 100.
21593 * @warning Maximum must be greater than minimum.
21595 * @see elm_spinner_min_max_get()
21599 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21602 * Get the minimum and maximum values of the spinner.
21604 * @param obj The spinner object.
21605 * @param min Pointer where to store the minimum value.
21606 * @param max Pointer where to store the maximum value.
21608 * @note If only one value is needed, the other pointer can be passed
21611 * @see elm_spinner_min_max_set() for details.
21615 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21618 * Set the step used to increment or decrement the spinner value.
21620 * @param obj The spinner object.
21621 * @param step The step value.
21623 * This value will be incremented or decremented to the displayed value.
21624 * It will be incremented while the user keep right or top arrow pressed,
21625 * and will be decremented while the user keep left or bottom arrow pressed.
21627 * The interval to increment / decrement can be set with
21628 * elm_spinner_interval_set().
21630 * By default step value is equal to 1.
21632 * @see elm_spinner_step_get()
21636 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21639 * Get the step used to increment or decrement the spinner value.
21641 * @param obj The spinner object.
21642 * @return The step value.
21644 * @see elm_spinner_step_get() for more details.
21648 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21651 * Set the value the spinner displays.
21653 * @param obj The spinner object.
21654 * @param val The value to be displayed.
21656 * Value will be presented on the label following format specified with
21657 * elm_spinner_format_set().
21659 * @warning The value must to be between min and max values. This values
21660 * are set by elm_spinner_min_max_set().
21662 * @see elm_spinner_value_get().
21663 * @see elm_spinner_format_set().
21664 * @see elm_spinner_min_max_set().
21668 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21671 * Get the value displayed by the spinner.
21673 * @param obj The spinner object.
21674 * @return The value displayed.
21676 * @see elm_spinner_value_set() for details.
21680 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21683 * Set whether the spinner should wrap when it reaches its
21684 * minimum or maximum value.
21686 * @param obj The spinner object.
21687 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21690 * Disabled by default. If disabled, when the user tries to increment the
21692 * but displayed value plus step value is bigger than maximum value,
21694 * won't allow it. The same happens when the user tries to decrement it,
21695 * but the value less step is less than minimum value.
21697 * When wrap is enabled, in such situations it will allow these changes,
21698 * but will get the value that would be less than minimum and subtracts
21699 * from maximum. Or add the value that would be more than maximum to
21703 * @li min value = 10
21704 * @li max value = 50
21705 * @li step value = 20
21706 * @li displayed value = 20
21708 * When the user decrement value (using left or bottom arrow), it will
21709 * displays @c 40, because max - (min - (displayed - step)) is
21710 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21712 * @see elm_spinner_wrap_get().
21716 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21719 * Get whether the spinner should wrap when it reaches its
21720 * minimum or maximum value.
21722 * @param obj The spinner object
21723 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21724 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21726 * @see elm_spinner_wrap_set() for details.
21730 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21733 * Set whether the spinner can be directly edited by the user or not.
21735 * @param obj The spinner object.
21736 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21737 * don't allow users to edit it directly.
21739 * Spinner objects can have edition @b disabled, in which state they will
21740 * be changed only by arrows.
21741 * Useful for contexts
21742 * where you don't want your users to interact with it writting the value.
21744 * when using special values, the user can see real value instead
21745 * of special label on edition.
21747 * It's enabled by default.
21749 * @see elm_spinner_editable_get()
21753 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21756 * Get whether the spinner can be directly edited by the user or not.
21758 * @param obj The spinner object.
21759 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21760 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21762 * @see elm_spinner_editable_set() for details.
21766 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21769 * Set a special string to display in the place of the numerical value.
21771 * @param obj The spinner object.
21772 * @param value The value to be replaced.
21773 * @param label The label to be used.
21775 * It's useful for cases when a user should select an item that is
21776 * better indicated by a label than a value. For example, weekdays or months.
21780 * sp = elm_spinner_add(win);
21781 * elm_spinner_min_max_set(sp, 1, 3);
21782 * elm_spinner_special_value_add(sp, 1, "January");
21783 * elm_spinner_special_value_add(sp, 2, "February");
21784 * elm_spinner_special_value_add(sp, 3, "March");
21785 * evas_object_show(sp);
21790 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21793 * Set the interval on time updates for an user mouse button hold
21794 * on spinner widgets' arrows.
21796 * @param obj The spinner object.
21797 * @param interval The (first) interval value in seconds.
21799 * This interval value is @b decreased while the user holds the
21800 * mouse pointer either incrementing or decrementing spinner's value.
21802 * This helps the user to get to a given value distant from the
21803 * current one easier/faster, as it will start to change quicker and
21804 * quicker on mouse button holds.
21806 * The calculation for the next change interval value, starting from
21807 * the one set with this call, is the previous interval divided by
21808 * @c 1.05, so it decreases a little bit.
21810 * The default starting interval value for automatic changes is
21813 * @see elm_spinner_interval_get()
21817 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21820 * Get the interval on time updates for an user mouse button hold
21821 * on spinner widgets' arrows.
21823 * @param obj The spinner object.
21824 * @return The (first) interval value, in seconds, set on it.
21826 * @see elm_spinner_interval_set() for more details.
21830 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21837 * @defgroup Index Index
21839 * @image html img/widget/index/preview-00.png
21840 * @image latex img/widget/index/preview-00.eps
21842 * An index widget gives you an index for fast access to whichever
21843 * group of other UI items one might have. It's a list of text
21844 * items (usually letters, for alphabetically ordered access).
21846 * Index widgets are by default hidden and just appear when the
21847 * user clicks over it's reserved area in the canvas. In its
21848 * default theme, it's an area one @ref Fingers "finger" wide on
21849 * the right side of the index widget's container.
21851 * When items on the index are selected, smart callbacks get
21852 * called, so that its user can make other container objects to
21853 * show a given area or child object depending on the index item
21854 * selected. You'd probably be using an index together with @ref
21855 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21858 * Smart events one can add callbacks for are:
21859 * - @c "changed" - When the selected index item changes. @c
21860 * event_info is the selected item's data pointer.
21861 * - @c "delay,changed" - When the selected index item changes, but
21862 * after a small idling period. @c event_info is the selected
21863 * item's data pointer.
21864 * - @c "selected" - When the user releases a mouse button and
21865 * selects an item. @c event_info is the selected item's data
21867 * - @c "level,up" - when the user moves a finger from the first
21868 * level to the second level
21869 * - @c "level,down" - when the user moves a finger from the second
21870 * level to the first level
21872 * The @c "delay,changed" event is so that it'll wait a small time
21873 * before actually reporting those events and, moreover, just the
21874 * last event happening on those time frames will actually be
21877 * Here are some examples on its usage:
21878 * @li @ref index_example_01
21879 * @li @ref index_example_02
21883 * @addtogroup Index
21887 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21890 * Add a new index widget to the given parent Elementary
21891 * (container) object
21893 * @param parent The parent object
21894 * @return a new index widget handle or @c NULL, on errors
21896 * This function inserts a new index widget on the canvas.
21900 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21903 * Set whether a given index widget is or not visible,
21906 * @param obj The index object
21907 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21909 * Not to be confused with visible as in @c evas_object_show() --
21910 * visible with regard to the widget's auto hiding feature.
21912 * @see elm_index_active_get()
21916 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21919 * Get whether a given index widget is currently visible or not.
21921 * @param obj The index object
21922 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21924 * @see elm_index_active_set() for more details
21928 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21931 * Set the items level for a given index widget.
21933 * @param obj The index object.
21934 * @param level @c 0 or @c 1, the currently implemented levels.
21936 * @see elm_index_item_level_get()
21940 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21943 * Get the items level set for a given index widget.
21945 * @param obj The index object.
21946 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21948 * @see elm_index_item_level_set() for more information
21952 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21955 * Returns the last selected item's data, for a given index widget.
21957 * @param obj The index object.
21958 * @return The item @b data associated to the last selected item on
21959 * @p obj (or @c NULL, on errors).
21961 * @warning The returned value is @b not an #Elm_Index_Item item
21962 * handle, but the data associated to it (see the @c item parameter
21963 * in elm_index_item_append(), as an example).
21967 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21970 * Append a new item on a given index widget.
21972 * @param obj The index object.
21973 * @param letter Letter under which the item should be indexed
21974 * @param item The item data to set for the index's item
21976 * Despite the most common usage of the @p letter argument is for
21977 * single char strings, one could use arbitrary strings as index
21980 * @c item will be the pointer returned back on @c "changed", @c
21981 * "delay,changed" and @c "selected" smart events.
21985 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21988 * Prepend a new item on a given index widget.
21990 * @param obj The index object.
21991 * @param letter Letter under which the item should be indexed
21992 * @param item The item data to set for the index's item
21994 * Despite the most common usage of the @p letter argument is for
21995 * single char strings, one could use arbitrary strings as index
21998 * @c item will be the pointer returned back on @c "changed", @c
21999 * "delay,changed" and @c "selected" smart events.
22003 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22006 * Append a new item, on a given index widget, <b>after the item
22007 * having @p relative as data</b>.
22009 * @param obj The index object.
22010 * @param letter Letter under which the item should be indexed
22011 * @param item The item data to set for the index's item
22012 * @param relative The item data of the index item to be the
22013 * predecessor of this new one
22015 * Despite the most common usage of the @p letter argument is for
22016 * single char strings, one could use arbitrary strings as index
22019 * @c item will be the pointer returned back on @c "changed", @c
22020 * "delay,changed" and @c "selected" smart events.
22022 * @note If @p relative is @c NULL or if it's not found to be data
22023 * set on any previous item on @p obj, this function will behave as
22024 * elm_index_item_append().
22028 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22031 * Prepend a new item, on a given index widget, <b>after the item
22032 * having @p relative as data</b>.
22034 * @param obj The index object.
22035 * @param letter Letter under which the item should be indexed
22036 * @param item The item data to set for the index's item
22037 * @param relative The item data of the index item to be the
22038 * successor of this new one
22040 * Despite the most common usage of the @p letter argument is for
22041 * single char strings, one could use arbitrary strings as index
22044 * @c item will be the pointer returned back on @c "changed", @c
22045 * "delay,changed" and @c "selected" smart events.
22047 * @note If @p relative is @c NULL or if it's not found to be data
22048 * set on any previous item on @p obj, this function will behave as
22049 * elm_index_item_prepend().
22053 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22056 * Insert a new item into the given index widget, using @p cmp_func
22057 * function to sort items (by item handles).
22059 * @param obj The index object.
22060 * @param letter Letter under which the item should be indexed
22061 * @param item The item data to set for the index's item
22062 * @param cmp_func The comparing function to be used to sort index
22063 * items <b>by #Elm_Index_Item item handles</b>
22064 * @param cmp_data_func A @b fallback function to be called for the
22065 * sorting of index items <b>by item data</b>). It will be used
22066 * when @p cmp_func returns @c 0 (equality), which means an index
22067 * item with provided item data already exists. To decide which
22068 * data item should be pointed to by the index item in question, @p
22069 * cmp_data_func will be used. If @p cmp_data_func returns a
22070 * non-negative value, the previous index item data will be
22071 * replaced by the given @p item pointer. If the previous data need
22072 * to be freed, it should be done by the @p cmp_data_func function,
22073 * because all references to it will be lost. If this function is
22074 * not provided (@c NULL is given), index items will be @b
22075 * duplicated, if @p cmp_func returns @c 0.
22077 * Despite the most common usage of the @p letter argument is for
22078 * single char strings, one could use arbitrary strings as index
22081 * @c item will be the pointer returned back on @c "changed", @c
22082 * "delay,changed" and @c "selected" smart events.
22086 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);
22089 * Remove an item from a given index widget, <b>to be referenced by
22090 * it's data value</b>.
22092 * @param obj The index object
22093 * @param item The item's data pointer for the item to be removed
22096 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22097 * that callback function will be called by this one.
22099 * @warning The item to be removed from @p obj will be found via
22100 * its item data pointer, and not by an #Elm_Index_Item handle.
22104 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22107 * Find a given index widget's item, <b>using item data</b>.
22109 * @param obj The index object
22110 * @param item The item data pointed to by the desired index item
22111 * @return The index item handle, if found, or @c NULL otherwise
22115 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22118 * Removes @b all items from a given index widget.
22120 * @param obj The index object.
22122 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22123 * that callback function will be called for each item in @p obj.
22127 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22130 * Go to a given items level on a index widget
22132 * @param obj The index object
22133 * @param level The index level (one of @c 0 or @c 1)
22137 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22140 * Return the data associated with a given index widget item
22142 * @param it The index widget item handle
22143 * @return The data associated with @p it
22145 * @see elm_index_item_data_set()
22149 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22152 * Set the data associated with a given index widget item
22154 * @param it The index widget item handle
22155 * @param data The new data pointer to set to @p it
22157 * This sets new item data on @p it.
22159 * @warning The old data pointer won't be touched by this function, so
22160 * the user had better to free that old data himself/herself.
22164 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22167 * Set the function to be called when a given index widget item is freed.
22169 * @param it The item to set the callback on
22170 * @param func The function to call on the item's deletion
22172 * When called, @p func will have both @c data and @c event_info
22173 * arguments with the @p it item's data value and, naturally, the
22174 * @c obj argument with a handle to the parent index widget.
22178 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22181 * Get the letter (string) set on a given index widget item.
22183 * @param it The index item handle
22184 * @return The letter string set on @p it
22188 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22195 * @defgroup Photocam Photocam
22197 * @image html img/widget/photocam/preview-00.png
22198 * @image latex img/widget/photocam/preview-00.eps
22200 * This is a widget specifically for displaying high-resolution digital
22201 * camera photos giving speedy feedback (fast load), low memory footprint
22202 * and zooming and panning as well as fitting logic. It is entirely focused
22203 * on jpeg images, and takes advantage of properties of the jpeg format (via
22204 * evas loader features in the jpeg loader).
22206 * Signals that you can add callbacks for are:
22207 * @li "clicked" - This is called when a user has clicked the photo without
22209 * @li "press" - This is called when a user has pressed down on the photo.
22210 * @li "longpressed" - This is called when a user has pressed down on the
22211 * photo for a long time without dragging around.
22212 * @li "clicked,double" - This is called when a user has double-clicked the
22214 * @li "load" - Photo load begins.
22215 * @li "loaded" - This is called when the image file load is complete for the
22216 * first view (low resolution blurry version).
22217 * @li "load,detail" - Photo detailed data load begins.
22218 * @li "loaded,detail" - This is called when the image file load is complete
22219 * for the detailed image data (full resolution needed).
22220 * @li "zoom,start" - Zoom animation started.
22221 * @li "zoom,stop" - Zoom animation stopped.
22222 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22223 * @li "scroll" - the content has been scrolled (moved)
22224 * @li "scroll,anim,start" - scrolling animation has started
22225 * @li "scroll,anim,stop" - scrolling animation has stopped
22226 * @li "scroll,drag,start" - dragging the contents around has started
22227 * @li "scroll,drag,stop" - dragging the contents around has stopped
22229 * @ref tutorial_photocam shows the API in action.
22233 * @brief Types of zoom available.
22235 typedef enum _Elm_Photocam_Zoom_Mode
22237 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22238 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22239 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22240 ELM_PHOTOCAM_ZOOM_MODE_LAST
22241 } Elm_Photocam_Zoom_Mode;
22243 * @brief Add a new Photocam object
22245 * @param parent The parent object
22246 * @return The new object or NULL if it cannot be created
22248 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22250 * @brief Set the photo file to be shown
22252 * @param obj The photocam object
22253 * @param file The photo file
22254 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22256 * This sets (and shows) the specified file (with a relative or absolute
22257 * path) and will return a load error (same error that
22258 * evas_object_image_load_error_get() will return). The image will change and
22259 * adjust its size at this point and begin a background load process for this
22260 * photo that at some time in the future will be displayed at the full
22263 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22265 * @brief Returns the path of the current image file
22267 * @param obj The photocam object
22268 * @return Returns the path
22270 * @see elm_photocam_file_set()
22272 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22274 * @brief Set the zoom level of the photo
22276 * @param obj The photocam object
22277 * @param zoom The zoom level to set
22279 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22280 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22281 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22282 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22285 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22287 * @brief Get the zoom level of the photo
22289 * @param obj The photocam object
22290 * @return The current zoom level
22292 * This returns the current zoom level of the photocam object. Note that if
22293 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22294 * (which is the default), the zoom level may be changed at any time by the
22295 * photocam object itself to account for photo size and photocam viewpoer
22298 * @see elm_photocam_zoom_set()
22299 * @see elm_photocam_zoom_mode_set()
22301 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22303 * @brief Set the zoom mode
22305 * @param obj The photocam object
22306 * @param mode The desired mode
22308 * This sets the zoom mode to manual or one of several automatic levels.
22309 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22310 * elm_photocam_zoom_set() and will stay at that level until changed by code
22311 * or until zoom mode is changed. This is the default mode. The Automatic
22312 * modes will allow the photocam object to automatically adjust zoom mode
22313 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22314 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22315 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22316 * pixels within the frame are left unfilled.
22318 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22320 * @brief Get the zoom mode
22322 * @param obj The photocam object
22323 * @return The current zoom mode
22325 * This gets the current zoom mode of the photocam object.
22327 * @see elm_photocam_zoom_mode_set()
22329 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22331 * @brief Get the current image pixel width and height
22333 * @param obj The photocam object
22334 * @param w A pointer to the width return
22335 * @param h A pointer to the height return
22337 * This gets the current photo pixel width and height (for the original).
22338 * The size will be returned in the integers @p w and @p h that are pointed
22341 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22343 * @brief Get the area of the image that is currently shown
22346 * @param x A pointer to the X-coordinate of region
22347 * @param y A pointer to the Y-coordinate of region
22348 * @param w A pointer to the width
22349 * @param h A pointer to the height
22351 * @see elm_photocam_image_region_show()
22352 * @see elm_photocam_image_region_bring_in()
22354 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22356 * @brief Set the viewed portion of the image
22358 * @param obj The photocam object
22359 * @param x X-coordinate of region in image original pixels
22360 * @param y Y-coordinate of region in image original pixels
22361 * @param w Width of region in image original pixels
22362 * @param h Height of region in image original pixels
22364 * This shows the region of the image without using animation.
22366 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22368 * @brief Bring in the viewed portion of the image
22370 * @param obj The photocam object
22371 * @param x X-coordinate of region in image original pixels
22372 * @param y Y-coordinate of region in image original pixels
22373 * @param w Width of region in image original pixels
22374 * @param h Height of region in image original pixels
22376 * This shows the region of the image using animation.
22378 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22380 * @brief Set the paused state for photocam
22382 * @param obj The photocam object
22383 * @param paused The pause state to set
22385 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22386 * photocam. The default is off. This will stop zooming using animation on
22387 * zoom levels changes and change instantly. This will stop any existing
22388 * animations that are running.
22390 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22392 * @brief Get the paused state for photocam
22394 * @param obj The photocam object
22395 * @return The current paused state
22397 * This gets the current paused state for the photocam object.
22399 * @see elm_photocam_paused_set()
22401 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22403 * @brief Get the internal low-res image used for photocam
22405 * @param obj The photocam object
22406 * @return The internal image object handle, or NULL if none exists
22408 * This gets the internal image object inside photocam. Do not modify it. It
22409 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22410 * deleted at any time as well.
22412 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22414 * @brief Set the photocam scrolling bouncing.
22416 * @param obj The photocam object
22417 * @param h_bounce bouncing for horizontal
22418 * @param v_bounce bouncing for vertical
22420 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22422 * @brief Get the photocam scrolling bouncing.
22424 * @param obj The photocam object
22425 * @param h_bounce bouncing for horizontal
22426 * @param v_bounce bouncing for vertical
22428 * @see elm_photocam_bounce_set()
22430 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22436 * @defgroup Map Map
22437 * @ingroup Elementary
22439 * @image html img/widget/map/preview-00.png
22440 * @image latex img/widget/map/preview-00.eps
22442 * This is a widget specifically for displaying a map. It uses basically
22443 * OpenStreetMap provider http://www.openstreetmap.org/,
22444 * but custom providers can be added.
22446 * It supports some basic but yet nice features:
22447 * @li zoom and scroll
22448 * @li markers with content to be displayed when user clicks over it
22449 * @li group of markers
22452 * Smart callbacks one can listen to:
22454 * - "clicked" - This is called when a user has clicked the map without
22456 * - "press" - This is called when a user has pressed down on the map.
22457 * - "longpressed" - This is called when a user has pressed down on the map
22458 * for a long time without dragging around.
22459 * - "clicked,double" - This is called when a user has double-clicked
22461 * - "load,detail" - Map detailed data load begins.
22462 * - "loaded,detail" - This is called when all currently visible parts of
22463 * the map are loaded.
22464 * - "zoom,start" - Zoom animation started.
22465 * - "zoom,stop" - Zoom animation stopped.
22466 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22467 * - "scroll" - the content has been scrolled (moved).
22468 * - "scroll,anim,start" - scrolling animation has started.
22469 * - "scroll,anim,stop" - scrolling animation has stopped.
22470 * - "scroll,drag,start" - dragging the contents around has started.
22471 * - "scroll,drag,stop" - dragging the contents around has stopped.
22472 * - "downloaded" - This is called when all currently required map images
22474 * - "route,load" - This is called when route request begins.
22475 * - "route,loaded" - This is called when route request ends.
22476 * - "name,load" - This is called when name request begins.
22477 * - "name,loaded- This is called when name request ends.
22479 * Available style for map widget:
22482 * Available style for markers:
22487 * Available style for marker bubble:
22490 * List of examples:
22491 * @li @ref map_example_01
22492 * @li @ref map_example_02
22493 * @li @ref map_example_03
22502 * @enum _Elm_Map_Zoom_Mode
22503 * @typedef Elm_Map_Zoom_Mode
22505 * Set map's zoom behavior. It can be set to manual or automatic.
22507 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22509 * Values <b> don't </b> work as bitmask, only one can be choosen.
22511 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22512 * than the scroller view.
22514 * @see elm_map_zoom_mode_set()
22515 * @see elm_map_zoom_mode_get()
22519 typedef enum _Elm_Map_Zoom_Mode
22521 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22522 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22523 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22524 ELM_MAP_ZOOM_MODE_LAST
22525 } Elm_Map_Zoom_Mode;
22528 * @enum _Elm_Map_Route_Sources
22529 * @typedef Elm_Map_Route_Sources
22531 * Set route service to be used. By default used source is
22532 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22534 * @see elm_map_route_source_set()
22535 * @see elm_map_route_source_get()
22539 typedef enum _Elm_Map_Route_Sources
22541 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22542 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. */
22543 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22544 ELM_MAP_ROUTE_SOURCE_LAST
22545 } Elm_Map_Route_Sources;
22547 typedef enum _Elm_Map_Name_Sources
22549 ELM_MAP_NAME_SOURCE_NOMINATIM,
22550 ELM_MAP_NAME_SOURCE_LAST
22551 } Elm_Map_Name_Sources;
22554 * @enum _Elm_Map_Route_Type
22555 * @typedef Elm_Map_Route_Type
22557 * Set type of transport used on route.
22559 * @see elm_map_route_add()
22563 typedef enum _Elm_Map_Route_Type
22565 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22566 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22567 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22568 ELM_MAP_ROUTE_TYPE_LAST
22569 } Elm_Map_Route_Type;
22572 * @enum _Elm_Map_Route_Method
22573 * @typedef Elm_Map_Route_Method
22575 * Set the routing method, what should be priorized, time or distance.
22577 * @see elm_map_route_add()
22581 typedef enum _Elm_Map_Route_Method
22583 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22584 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22585 ELM_MAP_ROUTE_METHOD_LAST
22586 } Elm_Map_Route_Method;
22588 typedef enum _Elm_Map_Name_Method
22590 ELM_MAP_NAME_METHOD_SEARCH,
22591 ELM_MAP_NAME_METHOD_REVERSE,
22592 ELM_MAP_NAME_METHOD_LAST
22593 } Elm_Map_Name_Method;
22595 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(). */
22596 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(). */
22597 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(). */
22598 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(). */
22599 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22600 typedef struct _Elm_Map_Track Elm_Map_Track;
22602 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. */
22603 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22604 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22605 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22607 typedef char *(*ElmMapModuleSourceFunc) (void);
22608 typedef int (*ElmMapModuleZoomMinFunc) (void);
22609 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22610 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22611 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22612 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22613 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22614 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22615 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22618 * Add a new map widget to the given parent Elementary (container) object.
22620 * @param parent The parent object.
22621 * @return a new map widget handle or @c NULL, on errors.
22623 * This function inserts a new map widget on the canvas.
22627 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22630 * Set the zoom level of the map.
22632 * @param obj The map object.
22633 * @param zoom The zoom level to set.
22635 * This sets the zoom level.
22637 * It will respect limits defined by elm_map_source_zoom_min_set() and
22638 * elm_map_source_zoom_max_set().
22640 * By default these values are 0 (world map) and 18 (maximum zoom).
22642 * This function should be used when zoom mode is set to
22643 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22644 * with elm_map_zoom_mode_set().
22646 * @see elm_map_zoom_mode_set().
22647 * @see elm_map_zoom_get().
22651 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22654 * Get the zoom level of the map.
22656 * @param obj The map object.
22657 * @return The current zoom level.
22659 * This returns the current zoom level of the map object.
22661 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22662 * (which is the default), the zoom level may be changed at any time by the
22663 * map object itself to account for map size and map viewport size.
22665 * @see elm_map_zoom_set() for details.
22669 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22672 * Set the zoom mode used by the map object.
22674 * @param obj The map object.
22675 * @param mode The zoom mode of the map, being it one of
22676 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22677 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22679 * This sets the zoom mode to manual or one of the automatic levels.
22680 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22681 * elm_map_zoom_set() and will stay at that level until changed by code
22682 * or until zoom mode is changed. This is the default mode.
22684 * The Automatic modes will allow the map object to automatically
22685 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22686 * adjust zoom so the map fits inside the scroll frame with no pixels
22687 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22688 * ensure no pixels within the frame are left unfilled. Do not forget that
22689 * the valid sizes are 2^zoom, consequently the map may be smaller than
22690 * the scroller view.
22692 * @see elm_map_zoom_set()
22696 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22699 * Get the zoom mode used by the map object.
22701 * @param obj The map object.
22702 * @return The zoom mode of the map, being it one of
22703 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22704 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22706 * This function returns the current zoom mode used by the map object.
22708 * @see elm_map_zoom_mode_set() for more details.
22712 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22715 * Get the current coordinates of the map.
22717 * @param obj The map object.
22718 * @param lon Pointer where to store longitude.
22719 * @param lat Pointer where to store latitude.
22721 * This gets the current center coordinates of the map object. It can be
22722 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22724 * @see elm_map_geo_region_bring_in()
22725 * @see elm_map_geo_region_show()
22729 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22732 * Animatedly bring in given coordinates to the center of the map.
22734 * @param obj The map object.
22735 * @param lon Longitude to center at.
22736 * @param lat Latitude to center at.
22738 * This causes map to jump to the given @p lat and @p lon coordinates
22739 * and show it (by scrolling) in the center of the viewport, if it is not
22740 * already centered. This will use animation to do so and take a period
22741 * of time to complete.
22743 * @see elm_map_geo_region_show() for a function to avoid animation.
22744 * @see elm_map_geo_region_get()
22748 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22751 * Show the given coordinates at the center of the map, @b immediately.
22753 * @param obj The map object.
22754 * @param lon Longitude to center at.
22755 * @param lat Latitude to center at.
22757 * This causes map to @b redraw its viewport's contents to the
22758 * region contining the given @p lat and @p lon, that will be moved to the
22759 * center of the map.
22761 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22762 * @see elm_map_geo_region_get()
22766 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22769 * Pause or unpause the map.
22771 * @param obj The map object.
22772 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22775 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22778 * The default is off.
22780 * This will stop zooming using animation, changing zoom levels will
22781 * change instantly. This will stop any existing animations that are running.
22783 * @see elm_map_paused_get()
22787 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22790 * Get a value whether map is paused or not.
22792 * @param obj The map object.
22793 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22794 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22796 * This gets the current paused state for the map object.
22798 * @see elm_map_paused_set() for details.
22802 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22805 * Set to show markers during zoom level changes or not.
22807 * @param obj The map object.
22808 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22811 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22814 * The default is off.
22816 * This will stop zooming using animation, changing zoom levels will
22817 * change instantly. This will stop any existing animations that are running.
22819 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22822 * The default is off.
22824 * Enabling it will force the map to stop displaying the markers during
22825 * zoom level changes. Set to on if you have a large number of markers.
22827 * @see elm_map_paused_markers_get()
22831 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22834 * Get a value whether markers will be displayed on zoom level changes or not
22836 * @param obj The map object.
22837 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22838 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22840 * This gets the current markers paused state for the map object.
22842 * @see elm_map_paused_markers_set() for details.
22846 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22849 * Get the information of downloading status.
22851 * @param obj The map object.
22852 * @param try_num Pointer where to store number of tiles being downloaded.
22853 * @param finish_num Pointer where to store number of tiles successfully
22856 * This gets the current downloading status for the map object, the number
22857 * of tiles being downloaded and the number of tiles already downloaded.
22861 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22864 * Convert a pixel coordinate (x,y) into a geographic coordinate
22865 * (longitude, latitude).
22867 * @param obj The map object.
22868 * @param x the coordinate.
22869 * @param y the coordinate.
22870 * @param size the size in pixels of the map.
22871 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22872 * @param lon Pointer where to store the longitude that correspond to x.
22873 * @param lat Pointer where to store the latitude that correspond to y.
22875 * @note Origin pixel point is the top left corner of the viewport.
22876 * Map zoom and size are taken on account.
22878 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22882 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);
22885 * Convert a geographic coordinate (longitude, latitude) into a pixel
22886 * coordinate (x, y).
22888 * @param obj The map object.
22889 * @param lon the longitude.
22890 * @param lat the latitude.
22891 * @param size the size in pixels of the map. The map is a square
22892 * and generally his size is : pow(2.0, zoom)*256.
22893 * @param x Pointer where to store the horizontal pixel coordinate that
22894 * correspond to the longitude.
22895 * @param y Pointer where to store the vertical pixel coordinate that
22896 * correspond to the latitude.
22898 * @note Origin pixel point is the top left corner of the viewport.
22899 * Map zoom and size are taken on account.
22901 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22905 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);
22908 * Convert a geographic coordinate (longitude, latitude) into a name
22911 * @param obj The map object.
22912 * @param lon the longitude.
22913 * @param lat the latitude.
22914 * @return name A #Elm_Map_Name handle for this coordinate.
22916 * To get the string for this address, elm_map_name_address_get()
22919 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22923 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22926 * Convert a name (address) into a geographic coordinate
22927 * (longitude, latitude).
22929 * @param obj The map object.
22930 * @param name The address.
22931 * @return name A #Elm_Map_Name handle for this address.
22933 * To get the longitude and latitude, elm_map_name_region_get()
22936 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22940 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22943 * Convert a pixel coordinate into a rotated pixel coordinate.
22945 * @param obj The map object.
22946 * @param x horizontal coordinate of the point to rotate.
22947 * @param y vertical coordinate of the point to rotate.
22948 * @param cx rotation's center horizontal position.
22949 * @param cy rotation's center vertical position.
22950 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22951 * @param xx Pointer where to store rotated x.
22952 * @param yy Pointer where to store rotated y.
22956 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);
22959 * Add a new marker to the map object.
22961 * @param obj The map object.
22962 * @param lon The longitude of the marker.
22963 * @param lat The latitude of the marker.
22964 * @param clas The class, to use when marker @b isn't grouped to others.
22965 * @param clas_group The class group, to use when marker is grouped to others
22966 * @param data The data passed to the callbacks.
22968 * @return The created marker or @c NULL upon failure.
22970 * A marker will be created and shown in a specific point of the map, defined
22971 * by @p lon and @p lat.
22973 * It will be displayed using style defined by @p class when this marker
22974 * is displayed alone (not grouped). A new class can be created with
22975 * elm_map_marker_class_new().
22977 * If the marker is grouped to other markers, it will be displayed with
22978 * style defined by @p class_group. Markers with the same group are grouped
22979 * if they are close. A new group class can be created with
22980 * elm_map_marker_group_class_new().
22982 * Markers created with this method can be deleted with
22983 * elm_map_marker_remove().
22985 * A marker can have associated content to be displayed by a bubble,
22986 * when a user click over it, as well as an icon. These objects will
22987 * be fetch using class' callback functions.
22989 * @see elm_map_marker_class_new()
22990 * @see elm_map_marker_group_class_new()
22991 * @see elm_map_marker_remove()
22995 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);
22998 * Set the maximum numbers of markers' content to be displayed in a group.
23000 * @param obj The map object.
23001 * @param max The maximum numbers of items displayed in a bubble.
23003 * A bubble will be displayed when the user clicks over the group,
23004 * and will place the content of markers that belong to this group
23007 * A group can have a long list of markers, consequently the creation
23008 * of the content of the bubble can be very slow.
23010 * In order to avoid this, a maximum number of items is displayed
23013 * By default this number is 30.
23015 * Marker with the same group class are grouped if they are close.
23017 * @see elm_map_marker_add()
23021 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23024 * Remove a marker from the map.
23026 * @param marker The marker to remove.
23028 * @see elm_map_marker_add()
23032 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23035 * Get the current coordinates of the marker.
23037 * @param marker marker.
23038 * @param lat Pointer where to store the marker's latitude.
23039 * @param lon Pointer where to store the marker's longitude.
23041 * These values are set when adding markers, with function
23042 * elm_map_marker_add().
23044 * @see elm_map_marker_add()
23048 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23051 * Animatedly bring in given marker to the center of the map.
23053 * @param marker The marker to center at.
23055 * This causes map to jump to the given @p marker's coordinates
23056 * and show it (by scrolling) in the center of the viewport, if it is not
23057 * already centered. This will use animation to do so and take a period
23058 * of time to complete.
23060 * @see elm_map_marker_show() for a function to avoid animation.
23061 * @see elm_map_marker_region_get()
23065 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23068 * Show the given marker at the center of the map, @b immediately.
23070 * @param marker The marker to center at.
23072 * This causes map to @b redraw its viewport's contents to the
23073 * region contining the given @p marker's coordinates, that will be
23074 * moved to the center of the map.
23076 * @see elm_map_marker_bring_in() for a function to move with animation.
23077 * @see elm_map_markers_list_show() if more than one marker need to be
23079 * @see elm_map_marker_region_get()
23083 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23086 * Move and zoom the map to display a list of markers.
23088 * @param markers A list of #Elm_Map_Marker handles.
23090 * The map will be centered on the center point of the markers in the list.
23091 * Then the map will be zoomed in order to fit the markers using the maximum
23092 * zoom which allows display of all the markers.
23094 * @warning All the markers should belong to the same map object.
23096 * @see elm_map_marker_show() to show a single marker.
23097 * @see elm_map_marker_bring_in()
23101 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23104 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23106 * @param marker The marker wich content should be returned.
23107 * @return Return the evas object if it exists, else @c NULL.
23109 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23110 * elm_map_marker_class_get_cb_set() should be used.
23112 * This content is what will be inside the bubble that will be displayed
23113 * when an user clicks over the marker.
23115 * This returns the actual Evas object used to be placed inside
23116 * the bubble. This may be @c NULL, as it may
23117 * not have been created or may have been deleted, at any time, by
23118 * the map. <b>Do not modify this object</b> (move, resize,
23119 * show, hide, etc.), as the map is controlling it. This
23120 * function is for querying, emitting custom signals or hooking
23121 * lower level callbacks for events on that object. Do not delete
23122 * this object under any circumstances.
23126 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23129 * Update the marker
23131 * @param marker The marker to be updated.
23133 * If a content is set to this marker, it will call function to delete it,
23134 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23135 * #ElmMapMarkerGetFunc.
23137 * These functions are set for the marker class with
23138 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23142 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23145 * Close all the bubbles opened by the user.
23147 * @param obj The map object.
23149 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23150 * when the user clicks on a marker.
23152 * This functions is set for the marker class with
23153 * elm_map_marker_class_get_cb_set().
23157 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23160 * Create a new group class.
23162 * @param obj The map object.
23163 * @return Returns the new group class.
23165 * Each marker must be associated to a group class. Markers in the same
23166 * group are grouped if they are close.
23168 * The group class defines the style of the marker when a marker is grouped
23169 * to others markers. When it is alone, another class will be used.
23171 * A group class will need to be provided when creating a marker with
23172 * elm_map_marker_add().
23174 * Some properties and functions can be set by class, as:
23175 * - style, with elm_map_group_class_style_set()
23176 * - data - to be associated to the group class. It can be set using
23177 * elm_map_group_class_data_set().
23178 * - min zoom to display markers, set with
23179 * elm_map_group_class_zoom_displayed_set().
23180 * - max zoom to group markers, set using
23181 * elm_map_group_class_zoom_grouped_set().
23182 * - visibility - set if markers will be visible or not, set with
23183 * elm_map_group_class_hide_set().
23184 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23185 * It can be set using elm_map_group_class_icon_cb_set().
23187 * @see elm_map_marker_add()
23188 * @see elm_map_group_class_style_set()
23189 * @see elm_map_group_class_data_set()
23190 * @see elm_map_group_class_zoom_displayed_set()
23191 * @see elm_map_group_class_zoom_grouped_set()
23192 * @see elm_map_group_class_hide_set()
23193 * @see elm_map_group_class_icon_cb_set()
23197 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23200 * Set the marker's style of a group class.
23202 * @param clas The group class.
23203 * @param style The style to be used by markers.
23205 * Each marker must be associated to a group class, and will use the style
23206 * defined by such class when grouped to other markers.
23208 * The following styles are provided by default theme:
23209 * @li @c radio - blue circle
23210 * @li @c radio2 - green circle
23213 * @see elm_map_group_class_new() for more details.
23214 * @see elm_map_marker_add()
23218 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23221 * Set the icon callback function of a group class.
23223 * @param clas The group class.
23224 * @param icon_get The callback function that will return the icon.
23226 * Each marker must be associated to a group class, and it can display a
23227 * custom icon. The function @p icon_get must return this icon.
23229 * @see elm_map_group_class_new() for more details.
23230 * @see elm_map_marker_add()
23234 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23237 * Set the data associated to the group class.
23239 * @param clas The group class.
23240 * @param data The new user data.
23242 * This data will be passed for callback functions, like icon get callback,
23243 * that can be set with elm_map_group_class_icon_cb_set().
23245 * If a data was previously set, the object will lose the pointer for it,
23246 * so if needs to be freed, you must do it yourself.
23248 * @see elm_map_group_class_new() for more details.
23249 * @see elm_map_group_class_icon_cb_set()
23250 * @see elm_map_marker_add()
23254 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23257 * Set the minimum zoom from where the markers are displayed.
23259 * @param clas The group class.
23260 * @param zoom The minimum zoom.
23262 * Markers only will be displayed when the map is displayed at @p zoom
23265 * @see elm_map_group_class_new() for more details.
23266 * @see elm_map_marker_add()
23270 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23273 * Set the zoom from where the markers are no more grouped.
23275 * @param clas The group class.
23276 * @param zoom The maximum zoom.
23278 * Markers only will be grouped when the map is displayed at
23279 * less than @p zoom.
23281 * @see elm_map_group_class_new() for more details.
23282 * @see elm_map_marker_add()
23286 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23289 * Set if the markers associated to the group class @clas are hidden or not.
23291 * @param clas The group class.
23292 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23295 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23300 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23303 * Create a new marker class.
23305 * @param obj The map object.
23306 * @return Returns the new group class.
23308 * Each marker must be associated to a class.
23310 * The marker class defines the style of the marker when a marker is
23311 * displayed alone, i.e., not grouped to to others markers. When grouped
23312 * it will use group class style.
23314 * A marker class will need to be provided when creating a marker with
23315 * elm_map_marker_add().
23317 * Some properties and functions can be set by class, as:
23318 * - style, with elm_map_marker_class_style_set()
23319 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23320 * It can be set using elm_map_marker_class_icon_cb_set().
23321 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23322 * Set using elm_map_marker_class_get_cb_set().
23323 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23324 * Set using elm_map_marker_class_del_cb_set().
23326 * @see elm_map_marker_add()
23327 * @see elm_map_marker_class_style_set()
23328 * @see elm_map_marker_class_icon_cb_set()
23329 * @see elm_map_marker_class_get_cb_set()
23330 * @see elm_map_marker_class_del_cb_set()
23334 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23337 * Set the marker's style of a marker class.
23339 * @param clas The marker class.
23340 * @param style The style to be used by markers.
23342 * Each marker must be associated to a marker class, and will use the style
23343 * defined by such class when alone, i.e., @b not grouped to other markers.
23345 * The following styles are provided by default theme:
23350 * @see elm_map_marker_class_new() for more details.
23351 * @see elm_map_marker_add()
23355 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23358 * Set the icon callback function of a marker class.
23360 * @param clas The marker class.
23361 * @param icon_get The callback function that will return the icon.
23363 * Each marker must be associated to a marker class, and it can display a
23364 * custom icon. The function @p icon_get must return this icon.
23366 * @see elm_map_marker_class_new() for more details.
23367 * @see elm_map_marker_add()
23371 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23374 * Set the bubble content callback function of a marker class.
23376 * @param clas The marker class.
23377 * @param get The callback function that will return the content.
23379 * Each marker must be associated to a marker class, and it can display a
23380 * a content on a bubble that opens when the user click over the marker.
23381 * The function @p get must return this content object.
23383 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23386 * @see elm_map_marker_class_new() for more details.
23387 * @see elm_map_marker_class_del_cb_set()
23388 * @see elm_map_marker_add()
23392 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23395 * Set the callback function used to delete bubble content of a marker class.
23397 * @param clas The marker class.
23398 * @param del The callback function that will delete the content.
23400 * Each marker must be associated to a marker class, and it can display a
23401 * a content on a bubble that opens when the user click over the marker.
23402 * The function to return such content can be set with
23403 * elm_map_marker_class_get_cb_set().
23405 * If this content must be freed, a callback function need to be
23406 * set for that task with this function.
23408 * If this callback is defined it will have to delete (or not) the
23409 * object inside, but if the callback is not defined the object will be
23410 * destroyed with evas_object_del().
23412 * @see elm_map_marker_class_new() for more details.
23413 * @see elm_map_marker_class_get_cb_set()
23414 * @see elm_map_marker_add()
23418 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23421 * Get the list of available sources.
23423 * @param obj The map object.
23424 * @return The source names list.
23426 * It will provide a list with all available sources, that can be set as
23427 * current source with elm_map_source_name_set(), or get with
23428 * elm_map_source_name_get().
23430 * Available sources:
23436 * @see elm_map_source_name_set() for more details.
23437 * @see elm_map_source_name_get()
23441 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23444 * Set the source of the map.
23446 * @param obj The map object.
23447 * @param source The source to be used.
23449 * Map widget retrieves images that composes the map from a web service.
23450 * This web service can be set with this method.
23452 * A different service can return a different maps with different
23453 * information and it can use different zoom values.
23455 * The @p source_name need to match one of the names provided by
23456 * elm_map_source_names_get().
23458 * The current source can be get using elm_map_source_name_get().
23460 * @see elm_map_source_names_get()
23461 * @see elm_map_source_name_get()
23466 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23469 * Get the name of currently used source.
23471 * @param obj The map object.
23472 * @return Returns the name of the source in use.
23474 * @see elm_map_source_name_set() for more details.
23478 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23481 * Set the source of the route service to be used by the map.
23483 * @param obj The map object.
23484 * @param source The route service to be used, being it one of
23485 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23486 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23488 * Each one has its own algorithm, so the route retrieved may
23489 * differ depending on the source route. Now, only the default is working.
23491 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23492 * http://www.yournavigation.org/.
23494 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23495 * assumptions. Its routing core is based on Contraction Hierarchies.
23497 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23499 * @see elm_map_route_source_get().
23503 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23506 * Get the current route source.
23508 * @param obj The map object.
23509 * @return The source of the route service used by the map.
23511 * @see elm_map_route_source_set() for details.
23515 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23518 * Set the minimum zoom of the source.
23520 * @param obj The map object.
23521 * @param zoom New minimum zoom value to be used.
23523 * By default, it's 0.
23527 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23530 * Get the minimum zoom of the source.
23532 * @param obj The map object.
23533 * @return Returns the minimum zoom of the source.
23535 * @see elm_map_source_zoom_min_set() for details.
23539 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23542 * Set the maximum zoom of the source.
23544 * @param obj The map object.
23545 * @param zoom New maximum zoom value to be used.
23547 * By default, it's 18.
23551 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23554 * Get the maximum zoom of the source.
23556 * @param obj The map object.
23557 * @return Returns the maximum zoom of the source.
23559 * @see elm_map_source_zoom_min_set() for details.
23563 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23566 * Set the user agent used by the map object to access routing services.
23568 * @param obj The map object.
23569 * @param user_agent The user agent to be used by the map.
23571 * User agent is a client application implementing a network protocol used
23572 * in communications within a clientāserver distributed computing system
23574 * The @p user_agent identification string will transmitted in a header
23575 * field @c User-Agent.
23577 * @see elm_map_user_agent_get()
23581 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23584 * Get the user agent used by the map object.
23586 * @param obj The map object.
23587 * @return The user agent identification string used by the map.
23589 * @see elm_map_user_agent_set() for details.
23593 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23596 * Add a new route to the map object.
23598 * @param obj The map object.
23599 * @param type The type of transport to be considered when tracing a route.
23600 * @param method The routing method, what should be priorized.
23601 * @param flon The start longitude.
23602 * @param flat The start latitude.
23603 * @param tlon The destination longitude.
23604 * @param tlat The destination latitude.
23606 * @return The created route or @c NULL upon failure.
23608 * A route will be traced by point on coordinates (@p flat, @p flon)
23609 * to point on coordinates (@p tlat, @p tlon), using the route service
23610 * set with elm_map_route_source_set().
23612 * It will take @p type on consideration to define the route,
23613 * depending if the user will be walking or driving, the route may vary.
23614 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23615 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23617 * Another parameter is what the route should priorize, the minor distance
23618 * or the less time to be spend on the route. So @p method should be one
23619 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23621 * Routes created with this method can be deleted with
23622 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23623 * and distance can be get with elm_map_route_distance_get().
23625 * @see elm_map_route_remove()
23626 * @see elm_map_route_color_set()
23627 * @see elm_map_route_distance_get()
23628 * @see elm_map_route_source_set()
23632 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);
23635 * Remove a route from the map.
23637 * @param route The route to remove.
23639 * @see elm_map_route_add()
23643 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23646 * Set the route color.
23648 * @param route The route object.
23649 * @param r Red channel value, from 0 to 255.
23650 * @param g Green channel value, from 0 to 255.
23651 * @param b Blue channel value, from 0 to 255.
23652 * @param a Alpha channel value, from 0 to 255.
23654 * It uses an additive color model, so each color channel represents
23655 * how much of each primary colors must to be used. 0 represents
23656 * ausence of this color, so if all of the three are set to 0,
23657 * the color will be black.
23659 * These component values should be integers in the range 0 to 255,
23660 * (single 8-bit byte).
23662 * This sets the color used for the route. By default, it is set to
23663 * solid red (r = 255, g = 0, b = 0, a = 255).
23665 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23667 * @see elm_map_route_color_get()
23671 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23674 * Get the route color.
23676 * @param route The route object.
23677 * @param r Pointer where to store the red channel value.
23678 * @param g Pointer where to store the green channel value.
23679 * @param b Pointer where to store the blue channel value.
23680 * @param a Pointer where to store the alpha channel value.
23682 * @see elm_map_route_color_set() for details.
23686 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23689 * Get the route distance in kilometers.
23691 * @param route The route object.
23692 * @return The distance of route (unit : km).
23696 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23699 * Get the information of route nodes.
23701 * @param route The route object.
23702 * @return Returns a string with the nodes of route.
23706 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23709 * Get the information of route waypoint.
23711 * @param route the route object.
23712 * @return Returns a string with information about waypoint of route.
23716 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23719 * Get the address of the name.
23721 * @param name The name handle.
23722 * @return Returns the address string of @p name.
23724 * This gets the coordinates of the @p name, created with one of the
23725 * conversion functions.
23727 * @see elm_map_utils_convert_name_into_coord()
23728 * @see elm_map_utils_convert_coord_into_name()
23732 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23735 * Get the current coordinates of the name.
23737 * @param name The name handle.
23738 * @param lat Pointer where to store the latitude.
23739 * @param lon Pointer where to store The longitude.
23741 * This gets the coordinates of the @p name, created with one of the
23742 * conversion functions.
23744 * @see elm_map_utils_convert_name_into_coord()
23745 * @see elm_map_utils_convert_coord_into_name()
23749 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23752 * Remove a name from the map.
23754 * @param name The name to remove.
23756 * Basically the struct handled by @p name will be freed, so convertions
23757 * between address and coordinates will be lost.
23759 * @see elm_map_utils_convert_name_into_coord()
23760 * @see elm_map_utils_convert_coord_into_name()
23764 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23769 * @param obj The map object.
23770 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23771 * @param cx Rotation's center horizontal position.
23772 * @param cy Rotation's center vertical position.
23774 * @see elm_map_rotate_get()
23778 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23781 * Get the rotate degree of the map
23783 * @param obj The map object
23784 * @param degree Pointer where to store degrees from 0.0 to 360.0
23785 * to rotate arount Z axis.
23786 * @param cx Pointer where to store rotation's center horizontal position.
23787 * @param cy Pointer where to store rotation's center vertical position.
23789 * @see elm_map_rotate_set() to set map rotation.
23793 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);
23796 * Enable or disable mouse wheel to be used to zoom in / out the map.
23798 * @param obj The map object.
23799 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23802 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23804 * It's disabled by default.
23806 * @see elm_map_wheel_disabled_get()
23810 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23813 * Get a value whether mouse wheel is enabled or not.
23815 * @param obj The map object.
23816 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23817 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23819 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23821 * @see elm_map_wheel_disabled_set() for details.
23825 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23829 * Add a track on the map
23831 * @param obj The map object.
23832 * @param emap The emap route object.
23833 * @return The route object. This is an elm object of type Route.
23835 * @see elm_route_add() for details.
23839 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23843 * Remove a track from the map
23845 * @param obj The map object.
23846 * @param route The track to remove.
23850 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23857 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23859 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23861 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23862 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23863 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23864 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23868 * @defgroup Panel Panel
23870 * @image html img/widget/panel/preview-00.png
23871 * @image latex img/widget/panel/preview-00.eps
23873 * @brief A panel is a type of animated container that contains subobjects.
23874 * It can be expanded or contracted by clicking the button on it's edge.
23876 * Orientations are as follows:
23877 * @li ELM_PANEL_ORIENT_TOP
23878 * @li ELM_PANEL_ORIENT_LEFT
23879 * @li ELM_PANEL_ORIENT_RIGHT
23881 * Default contents parts of the panel widget that you can use for are:
23882 * @li "default" - A content of the panel
23884 * @ref tutorial_panel shows one way to use this widget.
23887 typedef enum _Elm_Panel_Orient
23889 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23890 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23891 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23892 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23893 } Elm_Panel_Orient;
23895 * @brief Adds a panel object
23897 * @param parent The parent object
23899 * @return The panel object, or NULL on failure
23901 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23903 * @brief Sets the orientation of the panel
23905 * @param parent The parent object
23906 * @param orient The panel orientation. Can be one of the following:
23907 * @li ELM_PANEL_ORIENT_TOP
23908 * @li ELM_PANEL_ORIENT_LEFT
23909 * @li ELM_PANEL_ORIENT_RIGHT
23911 * Sets from where the panel will (dis)appear.
23913 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23915 * @brief Get the orientation of the panel.
23917 * @param obj The panel object
23918 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23920 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23922 * @brief Set the content of the panel.
23924 * @param obj The panel object
23925 * @param content The panel content
23927 * Once the content object is set, a previously set one will be deleted.
23928 * If you want to keep that old content object, use the
23929 * elm_panel_content_unset() function.
23931 * @deprecated use elm_object_content_set() instead
23934 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23936 * @brief Get the content of the panel.
23938 * @param obj The panel object
23939 * @return The content that is being used
23941 * Return the content object which is set for this widget.
23943 * @see elm_panel_content_set()
23945 * @deprecated use elm_object_content_get() instead
23948 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23950 * @brief Unset the content of the panel.
23952 * @param obj The panel object
23953 * @return The content that was being used
23955 * Unparent and return the content object which was set for this widget.
23957 * @see elm_panel_content_set()
23959 * @deprecated use elm_object_content_unset() instead
23962 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23964 * @brief Set the state of the panel.
23966 * @param obj The panel object
23967 * @param hidden If true, the panel will run the animation to contract
23969 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23971 * @brief Get the state of the panel.
23973 * @param obj The panel object
23974 * @param hidden If true, the panel is in the "hide" state
23976 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23978 * @brief Toggle the hidden state of the panel from code
23980 * @param obj The panel object
23982 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23988 * @defgroup Panes Panes
23989 * @ingroup Elementary
23991 * @image html img/widget/panes/preview-00.png
23992 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23994 * @image html img/panes.png
23995 * @image latex img/panes.eps width=\textwidth
23997 * The panes adds a dragable bar between two contents. When dragged
23998 * this bar will resize contents size.
24000 * Panes can be displayed vertically or horizontally, and contents
24001 * size proportion can be customized (homogeneous by default).
24003 * Smart callbacks one can listen to:
24004 * - "press" - The panes has been pressed (button wasn't released yet).
24005 * - "unpressed" - The panes was released after being pressed.
24006 * - "clicked" - The panes has been clicked>
24007 * - "clicked,double" - The panes has been double clicked
24009 * Available styles for it:
24012 * Default contents parts of the panes widget that you can use for are:
24013 * @li "left" - A leftside content of the panes
24014 * @li "right" - A rightside content of the panes
24016 * If panes is displayed vertically, left content will be displayed at
24019 * Here is an example on its usage:
24020 * @li @ref panes_example
24024 * @addtogroup Panes
24029 * Add a new panes widget to the given parent Elementary
24030 * (container) object.
24032 * @param parent The parent object.
24033 * @return a new panes widget handle or @c NULL, on errors.
24035 * This function inserts a new panes widget on the canvas.
24039 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24042 * Set the left content of the panes widget.
24044 * @param obj The panes object.
24045 * @param content The new left content object.
24047 * Once the content object is set, a previously set one will be deleted.
24048 * If you want to keep that old content object, use the
24049 * elm_panes_content_left_unset() function.
24051 * If panes is displayed vertically, left content will be displayed at
24054 * @see elm_panes_content_left_get()
24055 * @see elm_panes_content_right_set() to set content on the other side.
24057 * @deprecated use elm_object_content_part_set() instead
24061 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24064 * Set the right content of the panes widget.
24066 * @param obj The panes object.
24067 * @param content The new right content object.
24069 * Once the content object is set, a previously set one will be deleted.
24070 * If you want to keep that old content object, use the
24071 * elm_panes_content_right_unset() function.
24073 * If panes is displayed vertically, left content will be displayed at
24076 * @see elm_panes_content_right_get()
24077 * @see elm_panes_content_left_set() to set content on the other side.
24079 * @deprecated use elm_object_content_part_set() instead
24083 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24086 * Get the left content of the panes.
24088 * @param obj The panes object.
24089 * @return The left content object that is being used.
24091 * Return the left content object which is set for this widget.
24093 * @see elm_panes_content_left_set() for details.
24095 * @deprecated use elm_object_content_part_get() instead
24099 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24102 * Get the right content of the panes.
24104 * @param obj The panes object
24105 * @return The right content object that is being used
24107 * Return the right content object which is set for this widget.
24109 * @see elm_panes_content_right_set() for details.
24111 * @deprecated use elm_object_content_part_get() instead
24115 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24118 * Unset the left content used for the panes.
24120 * @param obj The panes object.
24121 * @return The left content object that was being used.
24123 * Unparent and return the left content object which was set for this widget.
24125 * @see elm_panes_content_left_set() for details.
24126 * @see elm_panes_content_left_get().
24128 * @deprecated use elm_object_content_part_unset() instead
24132 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24135 * Unset the right content used for the panes.
24137 * @param obj The panes object.
24138 * @return The right content object that was being used.
24140 * Unparent and return the right content object which was set for this
24143 * @see elm_panes_content_right_set() for details.
24144 * @see elm_panes_content_right_get().
24146 * @deprecated use elm_object_content_part_unset() instead
24150 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24153 * Get the size proportion of panes widget's left side.
24155 * @param obj The panes object.
24156 * @return float value between 0.0 and 1.0 representing size proportion
24159 * @see elm_panes_content_left_size_set() for more details.
24163 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24166 * Set the size proportion of panes widget's left side.
24168 * @param obj The panes object.
24169 * @param size Value between 0.0 and 1.0 representing size proportion
24172 * By default it's homogeneous, i.e., both sides have the same size.
24174 * If something different is required, it can be set with this function.
24175 * For example, if the left content should be displayed over
24176 * 75% of the panes size, @p size should be passed as @c 0.75.
24177 * This way, right content will be resized to 25% of panes size.
24179 * If displayed vertically, left content is displayed at top, and
24180 * right content at bottom.
24182 * @note This proportion will change when user drags the panes bar.
24184 * @see elm_panes_content_left_size_get()
24188 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24191 * Set the orientation of a given panes widget.
24193 * @param obj The panes object.
24194 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24195 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24197 * Use this function to change how your panes is to be
24198 * disposed: vertically or horizontally.
24200 * By default it's displayed horizontally.
24202 * @see elm_panes_horizontal_get()
24206 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24209 * Retrieve the orientation of a given panes widget.
24211 * @param obj The panes object.
24212 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24213 * @c EINA_FALSE if it's @b vertical (and on errors).
24215 * @see elm_panes_horizontal_set() for more details.
24219 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24220 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24221 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24228 * @defgroup Flip Flip
24230 * @image html img/widget/flip/preview-00.png
24231 * @image latex img/widget/flip/preview-00.eps
24233 * This widget holds 2 content objects(Evas_Object): one on the front and one
24234 * on the back. It allows you to flip from front to back and vice-versa using
24235 * various animations.
24237 * If either the front or back contents are not set the flip will treat that
24238 * as transparent. So if you wore to set the front content but not the back,
24239 * and then call elm_flip_go() you would see whatever is below the flip.
24241 * For a list of supported animations see elm_flip_go().
24243 * Signals that you can add callbacks for are:
24244 * "animate,begin" - when a flip animation was started
24245 * "animate,done" - when a flip animation is finished
24247 * @ref tutorial_flip show how to use most of the API.
24251 typedef enum _Elm_Flip_Mode
24253 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24254 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24255 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24256 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24257 ELM_FLIP_CUBE_LEFT,
24258 ELM_FLIP_CUBE_RIGHT,
24260 ELM_FLIP_CUBE_DOWN,
24261 ELM_FLIP_PAGE_LEFT,
24262 ELM_FLIP_PAGE_RIGHT,
24266 typedef enum _Elm_Flip_Interaction
24268 ELM_FLIP_INTERACTION_NONE,
24269 ELM_FLIP_INTERACTION_ROTATE,
24270 ELM_FLIP_INTERACTION_CUBE,
24271 ELM_FLIP_INTERACTION_PAGE
24272 } Elm_Flip_Interaction;
24273 typedef enum _Elm_Flip_Direction
24275 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24276 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24277 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24278 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24279 } Elm_Flip_Direction;
24281 * @brief Add a new flip to the parent
24283 * @param parent The parent object
24284 * @return The new object or NULL if it cannot be created
24286 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24288 * @brief Set the front content of the flip widget.
24290 * @param obj The flip object
24291 * @param content The new front content object
24293 * Once the content object is set, a previously set one will be deleted.
24294 * If you want to keep that old content object, use the
24295 * elm_flip_content_front_unset() function.
24297 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24299 * @brief Set the back content of the flip widget.
24301 * @param obj The flip object
24302 * @param content The new back content object
24304 * Once the content object is set, a previously set one will be deleted.
24305 * If you want to keep that old content object, use the
24306 * elm_flip_content_back_unset() function.
24308 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24310 * @brief Get the front content used for the flip
24312 * @param obj The flip object
24313 * @return The front content object that is being used
24315 * Return the front content object which is set for this widget.
24317 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24319 * @brief Get the back content used for the flip
24321 * @param obj The flip object
24322 * @return The back content object that is being used
24324 * Return the back content object which is set for this widget.
24326 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24328 * @brief Unset the front content used for the flip
24330 * @param obj The flip object
24331 * @return The front content object that was being used
24333 * Unparent and return the front content object which was set for this widget.
24335 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24337 * @brief Unset the back content used for the flip
24339 * @param obj The flip object
24340 * @return The back content object that was being used
24342 * Unparent and return the back content object which was set for this widget.
24344 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24346 * @brief Get flip front visibility state
24348 * @param obj The flip objct
24349 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24352 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24354 * @brief Set flip perspective
24356 * @param obj The flip object
24357 * @param foc The coordinate to set the focus on
24358 * @param x The X coordinate
24359 * @param y The Y coordinate
24361 * @warning This function currently does nothing.
24363 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24365 * @brief Runs the flip animation
24367 * @param obj The flip object
24368 * @param mode The mode type
24370 * Flips the front and back contents using the @p mode animation. This
24371 * efectively hides the currently visible content and shows the hidden one.
24373 * There a number of possible animations to use for the flipping:
24374 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24375 * around a horizontal axis in the middle of its height, the other content
24376 * is shown as the other side of the flip.
24377 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24378 * around a vertical axis in the middle of its width, the other content is
24379 * shown as the other side of the flip.
24380 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24381 * around a diagonal axis in the middle of its width, the other content is
24382 * shown as the other side of the flip.
24383 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24384 * around a diagonal axis in the middle of its height, the other content is
24385 * shown as the other side of the flip.
24386 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24387 * as if the flip was a cube, the other content is show as the right face of
24389 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24390 * right as if the flip was a cube, the other content is show as the left
24391 * face of the cube.
24392 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24393 * flip was a cube, the other content is show as the bottom face of the cube.
24394 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24395 * the flip was a cube, the other content is show as the upper face of the
24397 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24398 * if the flip was a book, the other content is shown as the page below that.
24399 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24400 * as if the flip was a book, the other content is shown as the page below
24402 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24403 * flip was a book, the other content is shown as the page below that.
24404 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24405 * flip was a book, the other content is shown as the page below that.
24407 * @image html elm_flip.png
24408 * @image latex elm_flip.eps width=\textwidth
24410 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24412 * @brief Set the interactive flip mode
24414 * @param obj The flip object
24415 * @param mode The interactive flip mode to use
24417 * This sets if the flip should be interactive (allow user to click and
24418 * drag a side of the flip to reveal the back page and cause it to flip).
24419 * By default a flip is not interactive. You may also need to set which
24420 * sides of the flip are "active" for flipping and how much space they use
24421 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24422 * and elm_flip_interacton_direction_hitsize_set()
24424 * The four avilable mode of interaction are:
24425 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24426 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24427 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24428 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24430 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24431 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24432 * happen, those can only be acheived with elm_flip_go();
24434 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24436 * @brief Get the interactive flip mode
24438 * @param obj The flip object
24439 * @return The interactive flip mode
24441 * Returns the interactive flip mode set by elm_flip_interaction_set()
24443 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24445 * @brief Set which directions of the flip respond to interactive flip
24447 * @param obj The flip object
24448 * @param dir The direction to change
24449 * @param enabled If that direction is enabled or not
24451 * By default all directions are disabled, so you may want to enable the
24452 * desired directions for flipping if you need interactive flipping. You must
24453 * call this function once for each direction that should be enabled.
24455 * @see elm_flip_interaction_set()
24457 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24459 * @brief Get the enabled state of that flip direction
24461 * @param obj The flip object
24462 * @param dir The direction to check
24463 * @return If that direction is enabled or not
24465 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24467 * @see elm_flip_interaction_set()
24469 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24471 * @brief Set the amount of the flip that is sensitive to interactive flip
24473 * @param obj The flip object
24474 * @param dir The direction to modify
24475 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24477 * Set the amount of the flip that is sensitive to interactive flip, with 0
24478 * representing no area in the flip and 1 representing the entire flip. There
24479 * is however a consideration to be made in that the area will never be
24480 * smaller than the finger size set(as set in your Elementary configuration).
24482 * @see elm_flip_interaction_set()
24484 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24486 * @brief Get the amount of the flip that is sensitive to interactive flip
24488 * @param obj The flip object
24489 * @param dir The direction to check
24490 * @return The size set for that direction
24492 * Returns the amount os sensitive area set by
24493 * elm_flip_interacton_direction_hitsize_set().
24495 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24500 /* scrolledentry */
24501 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24502 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24503 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24504 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24505 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24506 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24507 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24508 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24509 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24510 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24511 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24512 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24513 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24514 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24515 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24516 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24517 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24518 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24519 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24520 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24521 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24522 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24523 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24524 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24525 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24526 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24527 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24528 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24529 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24530 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24531 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24532 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24533 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24534 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24535 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24536 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);
24537 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24538 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24539 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);
24540 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24541 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);
24542 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24543 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24544 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24545 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24546 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24547 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24548 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24549 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24550 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);
24551 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);
24552 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);
24553 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);
24554 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);
24555 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);
24556 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24557 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24558 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24559 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24560 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24561 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24562 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24565 * @defgroup Conformant Conformant
24566 * @ingroup Elementary
24568 * @image html img/widget/conformant/preview-00.png
24569 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24571 * @image html img/conformant.png
24572 * @image latex img/conformant.eps width=\textwidth
24574 * The aim is to provide a widget that can be used in elementary apps to
24575 * account for space taken up by the indicator, virtual keypad & softkey
24576 * windows when running the illume2 module of E17.
24578 * So conformant content will be sized and positioned considering the
24579 * space required for such stuff, and when they popup, as a keyboard
24580 * shows when an entry is selected, conformant content won't change.
24582 * Available styles for it:
24585 * Default contents parts of the conformant widget that you can use for are:
24586 * @li "default" - A content of the conformant
24588 * See how to use this widget in this example:
24589 * @ref conformant_example
24593 * @addtogroup Conformant
24598 * Add a new conformant widget to the given parent Elementary
24599 * (container) object.
24601 * @param parent The parent object.
24602 * @return A new conformant widget handle or @c NULL, on errors.
24604 * This function inserts a new conformant widget on the canvas.
24606 * @ingroup Conformant
24608 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24611 * Set the content of the conformant widget.
24613 * @param obj The conformant object.
24614 * @param content The content to be displayed by the conformant.
24616 * Content will be sized and positioned considering the space required
24617 * to display a virtual keyboard. So it won't fill all the conformant
24618 * size. This way is possible to be sure that content won't resize
24619 * or be re-positioned after the keyboard is displayed.
24621 * Once the content object is set, a previously set one will be deleted.
24622 * If you want to keep that old content object, use the
24623 * elm_object_content_unset() function.
24625 * @see elm_object_content_unset()
24626 * @see elm_object_content_get()
24628 * @deprecated use elm_object_content_set() instead
24630 * @ingroup Conformant
24632 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24635 * Get the content of the conformant widget.
24637 * @param obj The conformant object.
24638 * @return The content that is being used.
24640 * Return the content object which is set for this widget.
24641 * It won't be unparent from conformant. For that, use
24642 * elm_object_content_unset().
24644 * @see elm_object_content_set().
24645 * @see elm_object_content_unset()
24647 * @deprecated use elm_object_content_get() instead
24649 * @ingroup Conformant
24651 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24654 * Unset the content of the conformant widget.
24656 * @param obj The conformant object.
24657 * @return The content that was being used.
24659 * Unparent and return the content object which was set for this widget.
24661 * @see elm_object_content_set().
24663 * @deprecated use elm_object_content_unset() instead
24665 * @ingroup Conformant
24667 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24670 * Returns the Evas_Object that represents the content area.
24672 * @param obj The conformant object.
24673 * @return The content area of the widget.
24675 * @ingroup Conformant
24677 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24684 * @defgroup Mapbuf Mapbuf
24685 * @ingroup Elementary
24687 * @image html img/widget/mapbuf/preview-00.png
24688 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24690 * This holds one content object and uses an Evas Map of transformation
24691 * points to be later used with this content. So the content will be
24692 * moved, resized, etc as a single image. So it will improve performance
24693 * when you have a complex interafce, with a lot of elements, and will
24694 * need to resize or move it frequently (the content object and its
24697 * Default contents parts of the mapbuf widget that you can use for are:
24698 * @li "default" - A content of the mapbuf
24700 * To enable map, elm_mapbuf_enabled_set() should be used.
24702 * See how to use this widget in this example:
24703 * @ref mapbuf_example
24707 * @addtogroup Mapbuf
24712 * Add a new mapbuf widget to the given parent Elementary
24713 * (container) object.
24715 * @param parent The parent object.
24716 * @return A new mapbuf widget handle or @c NULL, on errors.
24718 * This function inserts a new mapbuf widget on the canvas.
24722 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24725 * Set the content of the mapbuf.
24727 * @param obj The mapbuf object.
24728 * @param content The content that will be filled in this mapbuf object.
24730 * Once the content object is set, a previously set one will be deleted.
24731 * If you want to keep that old content object, use the
24732 * elm_mapbuf_content_unset() function.
24734 * To enable map, elm_mapbuf_enabled_set() should be used.
24736 * @deprecated use elm_object_content_set() instead
24740 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24743 * Get the content of the mapbuf.
24745 * @param obj The mapbuf object.
24746 * @return The content that is being used.
24748 * Return the content object which is set for this widget.
24750 * @see elm_mapbuf_content_set() for details.
24752 * @deprecated use elm_object_content_get() instead
24756 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24759 * Unset the content of the mapbuf.
24761 * @param obj The mapbuf object.
24762 * @return The content that was being used.
24764 * Unparent and return the content object which was set for this widget.
24766 * @see elm_mapbuf_content_set() for details.
24768 * @deprecated use elm_object_content_unset() instead
24772 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24775 * Enable or disable the map.
24777 * @param obj The mapbuf object.
24778 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24780 * This enables the map that is set or disables it. On enable, the object
24781 * geometry will be saved, and the new geometry will change (position and
24782 * size) to reflect the map geometry set.
24784 * Also, when enabled, alpha and smooth states will be used, so if the
24785 * content isn't solid, alpha should be enabled, for example, otherwise
24786 * a black retangle will fill the content.
24788 * When disabled, the stored map will be freed and geometry prior to
24789 * enabling the map will be restored.
24791 * It's disabled by default.
24793 * @see elm_mapbuf_alpha_set()
24794 * @see elm_mapbuf_smooth_set()
24798 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24801 * Get a value whether map is enabled or not.
24803 * @param obj The mapbuf object.
24804 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24805 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24807 * @see elm_mapbuf_enabled_set() for details.
24811 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24814 * Enable or disable smooth map rendering.
24816 * @param obj The mapbuf object.
24817 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24820 * This sets smoothing for map rendering. If the object is a type that has
24821 * its own smoothing settings, then both the smooth settings for this object
24822 * and the map must be turned off.
24824 * By default smooth maps are enabled.
24828 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24831 * Get a value whether smooth map rendering is enabled or not.
24833 * @param obj The mapbuf object.
24834 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24835 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24837 * @see elm_mapbuf_smooth_set() for details.
24841 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24844 * Set or unset alpha flag for map rendering.
24846 * @param obj The mapbuf object.
24847 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24850 * This sets alpha flag for map rendering. If the object is a type that has
24851 * its own alpha settings, then this will take precedence. Only image objects
24852 * have this currently. It stops alpha blending of the map area, and is
24853 * useful if you know the object and/or all sub-objects is 100% solid.
24855 * Alpha is enabled by default.
24859 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24862 * Get a value whether alpha blending is enabled or not.
24864 * @param obj The mapbuf object.
24865 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24866 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24868 * @see elm_mapbuf_alpha_set() for details.
24872 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24879 * @defgroup Flipselector Flip Selector
24881 * @image html img/widget/flipselector/preview-00.png
24882 * @image latex img/widget/flipselector/preview-00.eps
24884 * A flip selector is a widget to show a set of @b text items, one
24885 * at a time, with the same sheet switching style as the @ref Clock
24886 * "clock" widget, when one changes the current displaying sheet
24887 * (thus, the "flip" in the name).
24889 * User clicks to flip sheets which are @b held for some time will
24890 * make the flip selector to flip continuosly and automatically for
24891 * the user. The interval between flips will keep growing in time,
24892 * so that it helps the user to reach an item which is distant from
24893 * the current selection.
24895 * Smart callbacks one can register to:
24896 * - @c "selected" - when the widget's selected text item is changed
24897 * - @c "overflowed" - when the widget's current selection is changed
24898 * from the first item in its list to the last
24899 * - @c "underflowed" - when the widget's current selection is changed
24900 * from the last item in its list to the first
24902 * Available styles for it:
24905 * To set/get the label of the flipselector item, you can use
24906 * elm_object_item_text_set/get APIs.
24907 * Once the text is set, a previously set one will be deleted.
24909 * Here is an example on its usage:
24910 * @li @ref flipselector_example
24914 * @addtogroup Flipselector
24919 * Add a new flip selector widget to the given parent Elementary
24920 * (container) widget
24922 * @param parent The parent object
24923 * @return a new flip selector widget handle or @c NULL, on errors
24925 * This function inserts a new flip selector widget on the canvas.
24927 * @ingroup Flipselector
24929 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24932 * Programmatically select the next item of a flip selector widget
24934 * @param obj The flipselector object
24936 * @note The selection will be animated. Also, if it reaches the
24937 * end of its list of member items, it will continue with the first
24940 * @ingroup Flipselector
24942 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24945 * Programmatically select the previous item of a flip selector
24948 * @param obj The flipselector object
24950 * @note The selection will be animated. Also, if it reaches the
24951 * beginning of its list of member items, it will continue with the
24952 * last one backwards.
24954 * @ingroup Flipselector
24956 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24959 * Append a (text) item to a flip selector widget
24961 * @param obj The flipselector object
24962 * @param label The (text) label of the new item
24963 * @param func Convenience callback function to take place when
24965 * @param data Data passed to @p func, above
24966 * @return A handle to the item added or @c NULL, on errors
24968 * The widget's list of labels to show will be appended with the
24969 * given value. If the user wishes so, a callback function pointer
24970 * can be passed, which will get called when this same item is
24973 * @note The current selection @b won't be modified by appending an
24974 * element to the list.
24976 * @note The maximum length of the text label is going to be
24977 * determined <b>by the widget's theme</b>. Strings larger than
24978 * that value are going to be @b truncated.
24980 * @ingroup Flipselector
24982 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24985 * Prepend a (text) item to a flip selector widget
24987 * @param obj The flipselector object
24988 * @param label The (text) label of the new item
24989 * @param func Convenience callback function to take place when
24991 * @param data Data passed to @p func, above
24992 * @return A handle to the item added or @c NULL, on errors
24994 * The widget's list of labels to show will be prepended with the
24995 * given value. If the user wishes so, a callback function pointer
24996 * can be passed, which will get called when this same item is
24999 * @note The current selection @b won't be modified by prepending
25000 * an element to the list.
25002 * @note The maximum length of the text label is going to be
25003 * determined <b>by the widget's theme</b>. Strings larger than
25004 * that value are going to be @b truncated.
25006 * @ingroup Flipselector
25008 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25011 * Get the internal list of items in a given flip selector widget.
25013 * @param obj The flipselector object
25014 * @return The list of items (#Elm_Object_Item as data) or
25015 * @c NULL on errors.
25017 * This list is @b not to be modified in any way and must not be
25018 * freed. Use the list members with functions like
25019 * elm_object_item_text_set(),
25020 * elm_object_item_text_get(),
25021 * elm_flipselector_item_del(),
25022 * elm_flipselector_item_selected_get(),
25023 * elm_flipselector_item_selected_set().
25025 * @warning This list is only valid until @p obj object's internal
25026 * items list is changed. It should be fetched again with another
25027 * call to this function when changes happen.
25029 * @ingroup Flipselector
25031 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25034 * Get the first item in the given flip selector widget's list of
25037 * @param obj The flipselector object
25038 * @return The first item or @c NULL, if it has no items (and on
25041 * @see elm_flipselector_item_append()
25042 * @see elm_flipselector_last_item_get()
25044 * @ingroup Flipselector
25046 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25049 * Get the last item in the given flip selector widget's list of
25052 * @param obj The flipselector object
25053 * @return The last item or @c NULL, if it has no items (and on
25056 * @see elm_flipselector_item_prepend()
25057 * @see elm_flipselector_first_item_get()
25059 * @ingroup Flipselector
25061 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25064 * Get the currently selected item in a flip selector widget.
25066 * @param obj The flipselector object
25067 * @return The selected item or @c NULL, if the widget has no items
25070 * @ingroup Flipselector
25072 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25075 * Set whether a given flip selector widget's item should be the
25076 * currently selected one.
25078 * @param it The flip selector item
25079 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25081 * This sets whether @p item is or not the selected (thus, under
25082 * display) one. If @p item is different than one under display,
25083 * the latter will be unselected. If the @p item is set to be
25084 * unselected, on the other hand, the @b first item in the widget's
25085 * internal members list will be the new selected one.
25087 * @see elm_flipselector_item_selected_get()
25089 * @ingroup Flipselector
25091 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25094 * Get whether a given flip selector widget's item is the currently
25097 * @param it The flip selector item
25098 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25101 * @see elm_flipselector_item_selected_set()
25103 * @ingroup Flipselector
25105 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25108 * Delete a given item from a flip selector widget.
25110 * @param it The item to delete
25112 * @ingroup Flipselector
25114 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25117 * Get the label of a given flip selector widget's item.
25119 * @param it The item to get label from
25120 * @return The text label of @p item or @c NULL, on errors
25122 * @see elm_object_item_text_set()
25124 * @deprecated see elm_object_item_text_get() instead
25125 * @ingroup Flipselector
25127 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25130 * Set the label of a given flip selector widget's item.
25132 * @param it The item to set label on
25133 * @param label The text label string, in UTF-8 encoding
25135 * @see elm_object_item_text_get()
25137 * @deprecated see elm_object_item_text_set() instead
25138 * @ingroup Flipselector
25140 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25143 * Gets the item before @p item in a flip selector widget's
25144 * internal list of items.
25146 * @param it The item to fetch previous from
25147 * @return The item before the @p item, in its parent's list. If
25148 * there is no previous item for @p item or there's an
25149 * error, @c NULL is returned.
25151 * @see elm_flipselector_item_next_get()
25153 * @ingroup Flipselector
25155 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25158 * Gets the item after @p item in a flip selector widget's
25159 * internal list of items.
25161 * @param it The item to fetch next from
25162 * @return The item after the @p item, in its parent's list. If
25163 * there is no next item for @p item or there's an
25164 * error, @c NULL is returned.
25166 * @see elm_flipselector_item_next_get()
25168 * @ingroup Flipselector
25170 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25173 * Set the interval on time updates for an user mouse button hold
25174 * on a flip selector widget.
25176 * @param obj The flip selector object
25177 * @param interval The (first) interval value in seconds
25179 * This interval value is @b decreased while the user holds the
25180 * mouse pointer either flipping up or flipping doww a given flip
25183 * This helps the user to get to a given item distant from the
25184 * current one easier/faster, as it will start to flip quicker and
25185 * quicker on mouse button holds.
25187 * The calculation for the next flip interval value, starting from
25188 * the one set with this call, is the previous interval divided by
25189 * 1.05, so it decreases a little bit.
25191 * The default starting interval value for automatic flips is
25194 * @see elm_flipselector_interval_get()
25196 * @ingroup Flipselector
25198 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25201 * Get the interval on time updates for an user mouse button hold
25202 * on a flip selector widget.
25204 * @param obj The flip selector object
25205 * @return The (first) interval value, in seconds, set on it
25207 * @see elm_flipselector_interval_set() for more details
25209 * @ingroup Flipselector
25211 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25217 * @addtogroup Calendar
25222 * @enum _Elm_Calendar_Mark_Repeat
25223 * @typedef Elm_Calendar_Mark_Repeat
25225 * Event periodicity, used to define if a mark should be repeated
25226 * @b beyond event's day. It's set when a mark is added.
25228 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25229 * there will be marks every week after this date. Marks will be displayed
25230 * at 13th, 20th, 27th, 3rd June ...
25232 * Values don't work as bitmask, only one can be choosen.
25234 * @see elm_calendar_mark_add()
25236 * @ingroup Calendar
25238 typedef enum _Elm_Calendar_Mark_Repeat
25240 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25241 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25242 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25243 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*/
25244 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. */
25245 } Elm_Calendar_Mark_Repeat;
25247 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(). */
25250 * Add a new calendar widget to the given parent Elementary
25251 * (container) object.
25253 * @param parent The parent object.
25254 * @return a new calendar widget handle or @c NULL, on errors.
25256 * This function inserts a new calendar widget on the canvas.
25258 * @ref calendar_example_01
25260 * @ingroup Calendar
25262 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25265 * Get weekdays names displayed by the calendar.
25267 * @param obj The calendar object.
25268 * @return Array of seven strings to be used as weekday names.
25270 * By default, weekdays abbreviations get from system are displayed:
25271 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25272 * The first string is related to Sunday, the second to Monday...
25274 * @see elm_calendar_weekdays_name_set()
25276 * @ref calendar_example_05
25278 * @ingroup Calendar
25280 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25283 * Set weekdays names to be displayed by the calendar.
25285 * @param obj The calendar object.
25286 * @param weekdays Array of seven strings to be used as weekday names.
25287 * @warning It must have 7 elements, or it will access invalid memory.
25288 * @warning The strings must be NULL terminated ('@\0').
25290 * By default, weekdays abbreviations get from system are displayed:
25291 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25293 * The first string should be related to Sunday, the second to Monday...
25295 * The usage should be like this:
25297 * const char *weekdays[] =
25299 * "Sunday", "Monday", "Tuesday", "Wednesday",
25300 * "Thursday", "Friday", "Saturday"
25302 * elm_calendar_weekdays_names_set(calendar, weekdays);
25305 * @see elm_calendar_weekdays_name_get()
25307 * @ref calendar_example_02
25309 * @ingroup Calendar
25311 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25314 * Set the minimum and maximum values for the year
25316 * @param obj The calendar object
25317 * @param min The minimum year, greater than 1901;
25318 * @param max The maximum year;
25320 * Maximum must be greater than minimum, except if you don't wan't to set
25322 * Default values are 1902 and -1.
25324 * If the maximum year is a negative value, it will be limited depending
25325 * on the platform architecture (year 2037 for 32 bits);
25327 * @see elm_calendar_min_max_year_get()
25329 * @ref calendar_example_03
25331 * @ingroup Calendar
25333 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25336 * Get the minimum and maximum values for the year
25338 * @param obj The calendar object.
25339 * @param min The minimum year.
25340 * @param max The maximum year.
25342 * Default values are 1902 and -1.
25344 * @see elm_calendar_min_max_year_get() for more details.
25346 * @ref calendar_example_05
25348 * @ingroup Calendar
25350 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25353 * Enable or disable day selection
25355 * @param obj The calendar object.
25356 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25359 * Enabled by default. If disabled, the user still can select months,
25360 * but not days. Selected days are highlighted on calendar.
25361 * It should be used if you won't need such selection for the widget usage.
25363 * When a day is selected, or month is changed, smart callbacks for
25364 * signal "changed" will be called.
25366 * @see elm_calendar_day_selection_enable_get()
25368 * @ref calendar_example_04
25370 * @ingroup Calendar
25372 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25375 * Get a value whether day selection is enabled or not.
25377 * @see elm_calendar_day_selection_enable_set() for details.
25379 * @param obj The calendar object.
25380 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25381 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25383 * @ref calendar_example_05
25385 * @ingroup Calendar
25387 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25391 * Set selected date to be highlighted on calendar.
25393 * @param obj The calendar object.
25394 * @param selected_time A @b tm struct to represent the selected date.
25396 * Set the selected date, changing the displayed month if needed.
25397 * Selected date changes when the user goes to next/previous month or
25398 * select a day pressing over it on calendar.
25400 * @see elm_calendar_selected_time_get()
25402 * @ref calendar_example_04
25404 * @ingroup Calendar
25406 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25409 * Get selected date.
25411 * @param obj The calendar object
25412 * @param selected_time A @b tm struct to point to selected date
25413 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25416 * Get date selected by the user or set by function
25417 * elm_calendar_selected_time_set().
25418 * Selected date changes when the user goes to next/previous month or
25419 * select a day pressing over it on calendar.
25421 * @see elm_calendar_selected_time_get()
25423 * @ref calendar_example_05
25425 * @ingroup Calendar
25427 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25430 * Set a function to format the string that will be used to display
25433 * @param obj The calendar object
25434 * @param format_function Function to set the month-year string given
25435 * the selected date
25437 * By default it uses strftime with "%B %Y" format string.
25438 * It should allocate the memory that will be used by the string,
25439 * that will be freed by the widget after usage.
25440 * A pointer to the string and a pointer to the time struct will be provided.
25445 * _format_month_year(struct tm *selected_time)
25448 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25449 * return strdup(buf);
25452 * elm_calendar_format_function_set(calendar, _format_month_year);
25455 * @ref calendar_example_02
25457 * @ingroup Calendar
25459 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25462 * Add a new mark to the calendar
25464 * @param obj The calendar object
25465 * @param mark_type A string used to define the type of mark. It will be
25466 * emitted to the theme, that should display a related modification on these
25467 * days representation.
25468 * @param mark_time A time struct to represent the date of inclusion of the
25469 * mark. For marks that repeats it will just be displayed after the inclusion
25470 * date in the calendar.
25471 * @param repeat Repeat the event following this periodicity. Can be a unique
25472 * mark (that don't repeat), daily, weekly, monthly or annually.
25473 * @return The created mark or @p NULL upon failure.
25475 * Add a mark that will be drawn in the calendar respecting the insertion
25476 * time and periodicity. It will emit the type as signal to the widget theme.
25477 * Default theme supports "holiday" and "checked", but it can be extended.
25479 * It won't immediately update the calendar, drawing the marks.
25480 * For this, call elm_calendar_marks_draw(). However, when user selects
25481 * next or previous month calendar forces marks drawn.
25483 * Marks created with this method can be deleted with
25484 * elm_calendar_mark_del().
25488 * struct tm selected_time;
25489 * time_t current_time;
25491 * current_time = time(NULL) + 5 * 84600;
25492 * localtime_r(¤t_time, &selected_time);
25493 * elm_calendar_mark_add(cal, "holiday", selected_time,
25494 * ELM_CALENDAR_ANNUALLY);
25496 * current_time = time(NULL) + 1 * 84600;
25497 * localtime_r(¤t_time, &selected_time);
25498 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25500 * elm_calendar_marks_draw(cal);
25503 * @see elm_calendar_marks_draw()
25504 * @see elm_calendar_mark_del()
25506 * @ref calendar_example_06
25508 * @ingroup Calendar
25510 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);
25513 * Delete mark from the calendar.
25515 * @param mark The mark to be deleted.
25517 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25518 * should be used instead of getting marks list and deleting each one.
25520 * @see elm_calendar_mark_add()
25522 * @ref calendar_example_06
25524 * @ingroup Calendar
25526 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25529 * Remove all calendar's marks
25531 * @param obj The calendar object.
25533 * @see elm_calendar_mark_add()
25534 * @see elm_calendar_mark_del()
25536 * @ingroup Calendar
25538 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25542 * Get a list of all the calendar marks.
25544 * @param obj The calendar object.
25545 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25547 * @see elm_calendar_mark_add()
25548 * @see elm_calendar_mark_del()
25549 * @see elm_calendar_marks_clear()
25551 * @ingroup Calendar
25553 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25556 * Draw calendar marks.
25558 * @param obj The calendar object.
25560 * Should be used after adding, removing or clearing marks.
25561 * It will go through the entire marks list updating the calendar.
25562 * If lots of marks will be added, add all the marks and then call
25565 * When the month is changed, i.e. user selects next or previous month,
25566 * marks will be drawed.
25568 * @see elm_calendar_mark_add()
25569 * @see elm_calendar_mark_del()
25570 * @see elm_calendar_marks_clear()
25572 * @ref calendar_example_06
25574 * @ingroup Calendar
25576 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25579 * Set a day text color to the same that represents Saturdays.
25581 * @param obj The calendar object.
25582 * @param pos The text position. Position is the cell counter, from left
25583 * to right, up to down. It starts on 0 and ends on 41.
25585 * @deprecated use elm_calendar_mark_add() instead like:
25588 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25589 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25592 * @see elm_calendar_mark_add()
25594 * @ingroup Calendar
25596 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25599 * Set a day text color to the same that represents Sundays.
25601 * @param obj The calendar object.
25602 * @param pos The text position. Position is the cell counter, from left
25603 * to right, up to down. It starts on 0 and ends on 41.
25605 * @deprecated use elm_calendar_mark_add() instead like:
25608 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25609 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25612 * @see elm_calendar_mark_add()
25614 * @ingroup Calendar
25616 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25619 * Set a day text color to the same that represents Weekdays.
25621 * @param obj The calendar object
25622 * @param pos The text position. Position is the cell counter, from left
25623 * to right, up to down. It starts on 0 and ends on 41.
25625 * @deprecated use elm_calendar_mark_add() instead like:
25628 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25630 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25631 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25632 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25633 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25634 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25635 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25636 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25637 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25638 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25641 * @see elm_calendar_mark_add()
25643 * @ingroup Calendar
25645 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25648 * Set the interval on time updates for an user mouse button hold
25649 * on calendar widgets' month selection.
25651 * @param obj The calendar object
25652 * @param interval The (first) interval value in seconds
25654 * This interval value is @b decreased while the user holds the
25655 * mouse pointer either selecting next or previous month.
25657 * This helps the user to get to a given month distant from the
25658 * current one easier/faster, as it will start to change quicker and
25659 * quicker on mouse button holds.
25661 * The calculation for the next change interval value, starting from
25662 * the one set with this call, is the previous interval divided by
25663 * 1.05, so it decreases a little bit.
25665 * The default starting interval value for automatic changes is
25668 * @see elm_calendar_interval_get()
25670 * @ingroup Calendar
25672 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25675 * Get the interval on time updates for an user mouse button hold
25676 * on calendar widgets' month selection.
25678 * @param obj The calendar object
25679 * @return The (first) interval value, in seconds, set on it
25681 * @see elm_calendar_interval_set() for more details
25683 * @ingroup Calendar
25685 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25692 * @defgroup Diskselector Diskselector
25693 * @ingroup Elementary
25695 * @image html img/widget/diskselector/preview-00.png
25696 * @image latex img/widget/diskselector/preview-00.eps
25698 * A diskselector is a kind of list widget. It scrolls horizontally,
25699 * and can contain label and icon objects. Three items are displayed
25700 * with the selected one in the middle.
25702 * It can act like a circular list with round mode and labels can be
25703 * reduced for a defined length for side items.
25705 * Smart callbacks one can listen to:
25706 * - "selected" - when item is selected, i.e. scroller stops.
25708 * Available styles for it:
25711 * List of examples:
25712 * @li @ref diskselector_example_01
25713 * @li @ref diskselector_example_02
25717 * @addtogroup Diskselector
25721 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(). */
25724 * Add a new diskselector widget to the given parent Elementary
25725 * (container) object.
25727 * @param parent The parent object.
25728 * @return a new diskselector widget handle or @c NULL, on errors.
25730 * This function inserts a new diskselector widget on the canvas.
25732 * @ingroup Diskselector
25734 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25737 * Enable or disable round mode.
25739 * @param obj The diskselector object.
25740 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25743 * Disabled by default. If round mode is enabled the items list will
25744 * work like a circle list, so when the user reaches the last item,
25745 * the first one will popup.
25747 * @see elm_diskselector_round_get()
25749 * @ingroup Diskselector
25751 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25754 * Get a value whether round mode is enabled or not.
25756 * @see elm_diskselector_round_set() for details.
25758 * @param obj The diskselector object.
25759 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25760 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25762 * @ingroup Diskselector
25764 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25767 * Get the side labels max length.
25769 * @deprecated use elm_diskselector_side_label_length_get() instead:
25771 * @param obj The diskselector object.
25772 * @return The max length defined for side labels, or 0 if not a valid
25775 * @ingroup Diskselector
25777 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25780 * Set the side labels max length.
25782 * @deprecated use elm_diskselector_side_label_length_set() instead:
25784 * @param obj The diskselector object.
25785 * @param len The max length defined for side labels.
25787 * @ingroup Diskselector
25789 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25792 * Get the side labels max length.
25794 * @see elm_diskselector_side_label_length_set() for details.
25796 * @param obj The diskselector object.
25797 * @return The max length defined for side labels, or 0 if not a valid
25800 * @ingroup Diskselector
25802 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25805 * Set the side labels max length.
25807 * @param obj The diskselector object.
25808 * @param len The max length defined for side labels.
25810 * Length is the number of characters of items' label that will be
25811 * visible when it's set on side positions. It will just crop
25812 * the string after defined size. E.g.:
25814 * An item with label "January" would be displayed on side position as
25815 * "Jan" if max length is set to 3, or "Janu", if this property
25818 * When it's selected, the entire label will be displayed, except for
25819 * width restrictions. In this case label will be cropped and "..."
25820 * will be concatenated.
25822 * Default side label max length is 3.
25824 * This property will be applyed over all items, included before or
25825 * later this function call.
25827 * @ingroup Diskselector
25829 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25832 * Set the number of items to be displayed.
25834 * @param obj The diskselector object.
25835 * @param num The number of items the diskselector will display.
25837 * Default value is 3, and also it's the minimun. If @p num is less
25838 * than 3, it will be set to 3.
25840 * Also, it can be set on theme, using data item @c display_item_num
25841 * on group "elm/diskselector/item/X", where X is style set.
25844 * group { name: "elm/diskselector/item/X";
25846 * item: "display_item_num" "5";
25849 * @ingroup Diskselector
25851 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25854 * Get the number of items in the diskselector object.
25856 * @param obj The diskselector object.
25858 * @ingroup Diskselector
25860 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25863 * Set bouncing behaviour when the scrolled content reaches an edge.
25865 * Tell the internal scroller object whether it should bounce or not
25866 * when it reaches the respective edges for each axis.
25868 * @param obj The diskselector object.
25869 * @param h_bounce Whether to bounce or not in the horizontal axis.
25870 * @param v_bounce Whether to bounce or not in the vertical axis.
25872 * @see elm_scroller_bounce_set()
25874 * @ingroup Diskselector
25876 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25879 * Get the bouncing behaviour of the internal scroller.
25881 * Get whether the internal scroller should bounce when the edge of each
25882 * axis is reached scrolling.
25884 * @param obj The diskselector object.
25885 * @param h_bounce Pointer where to store the bounce state of the horizontal
25887 * @param v_bounce Pointer where to store the bounce state of the vertical
25890 * @see elm_scroller_bounce_get()
25891 * @see elm_diskselector_bounce_set()
25893 * @ingroup Diskselector
25895 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25898 * Get the scrollbar policy.
25900 * @see elm_diskselector_scroller_policy_get() for details.
25902 * @param obj The diskselector object.
25903 * @param policy_h Pointer where to store horizontal scrollbar policy.
25904 * @param policy_v Pointer where to store vertical scrollbar policy.
25906 * @ingroup Diskselector
25908 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);
25911 * Set the scrollbar policy.
25913 * @param obj The diskselector object.
25914 * @param policy_h Horizontal scrollbar policy.
25915 * @param policy_v Vertical scrollbar policy.
25917 * This sets the scrollbar visibility policy for the given scroller.
25918 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25919 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25920 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25921 * This applies respectively for the horizontal and vertical scrollbars.
25923 * The both are disabled by default, i.e., are set to
25924 * #ELM_SCROLLER_POLICY_OFF.
25926 * @ingroup Diskselector
25928 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25931 * Remove all diskselector's items.
25933 * @param obj The diskselector object.
25935 * @see elm_diskselector_item_del()
25936 * @see elm_diskselector_item_append()
25938 * @ingroup Diskselector
25940 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25943 * Get a list of all the diskselector items.
25945 * @param obj The diskselector object.
25946 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25947 * or @c NULL on failure.
25949 * @see elm_diskselector_item_append()
25950 * @see elm_diskselector_item_del()
25951 * @see elm_diskselector_clear()
25953 * @ingroup Diskselector
25955 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25958 * Appends a new item to the diskselector object.
25960 * @param obj The diskselector object.
25961 * @param label The label of the diskselector item.
25962 * @param icon The icon object to use at left side of the item. An
25963 * icon can be any Evas object, but usually it is an icon created
25964 * with elm_icon_add().
25965 * @param func The function to call when the item is selected.
25966 * @param data The data to associate with the item for related callbacks.
25968 * @return The created item or @c NULL upon failure.
25970 * A new item will be created and appended to the diskselector, i.e., will
25971 * be set as last item. Also, if there is no selected item, it will
25972 * be selected. This will always happens for the first appended item.
25974 * If no icon is set, label will be centered on item position, otherwise
25975 * the icon will be placed at left of the label, that will be shifted
25978 * Items created with this method can be deleted with
25979 * elm_diskselector_item_del().
25981 * Associated @p data can be properly freed when item is deleted if a
25982 * callback function is set with elm_diskselector_item_del_cb_set().
25984 * If a function is passed as argument, it will be called everytime this item
25985 * is selected, i.e., the user stops the diskselector with this
25986 * item on center position. If such function isn't needed, just passing
25987 * @c NULL as @p func is enough. The same should be done for @p data.
25989 * Simple example (with no function callback or data associated):
25991 * disk = elm_diskselector_add(win);
25992 * ic = elm_icon_add(win);
25993 * elm_icon_file_set(ic, "path/to/image", NULL);
25994 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25995 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25998 * @see elm_diskselector_item_del()
25999 * @see elm_diskselector_item_del_cb_set()
26000 * @see elm_diskselector_clear()
26001 * @see elm_icon_add()
26003 * @ingroup Diskselector
26005 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);
26009 * Delete them item from the diskselector.
26011 * @param it The item of diskselector to be deleted.
26013 * If deleting all diskselector items is required, elm_diskselector_clear()
26014 * should be used instead of getting items list and deleting each one.
26016 * @see elm_diskselector_clear()
26017 * @see elm_diskselector_item_append()
26018 * @see elm_diskselector_item_del_cb_set()
26020 * @ingroup Diskselector
26022 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26025 * Set the function called when a diskselector item is freed.
26027 * @param it The item to set the callback on
26028 * @param func The function called
26030 * If there is a @p func, then it will be called prior item's memory release.
26031 * That will be called with the following arguments:
26033 * @li item's Evas object;
26036 * This way, a data associated to a diskselector item could be properly
26039 * @ingroup Diskselector
26041 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26044 * Get the data associated to the item.
26046 * @param it The diskselector item
26047 * @return The data associated to @p it
26049 * The return value is a pointer to data associated to @p item when it was
26050 * created, with function elm_diskselector_item_append(). If no data
26051 * was passed as argument, it will return @c NULL.
26053 * @see elm_diskselector_item_append()
26055 * @ingroup Diskselector
26057 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26060 * Set the icon associated to the item.
26062 * @param it The diskselector item
26063 * @param icon The icon object to associate with @p it
26065 * The icon object to use at left side of the item. An
26066 * icon can be any Evas object, but usually it is an icon created
26067 * with elm_icon_add().
26069 * Once the icon object is set, a previously set one will be deleted.
26070 * @warning Setting the same icon for two items will cause the icon to
26071 * dissapear from the first item.
26073 * If an icon was passed as argument on item creation, with function
26074 * elm_diskselector_item_append(), it will be already
26075 * associated to the item.
26077 * @see elm_diskselector_item_append()
26078 * @see elm_diskselector_item_icon_get()
26080 * @ingroup Diskselector
26082 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26085 * Get the icon associated to the item.
26087 * @param it The diskselector item
26088 * @return The icon associated to @p it
26090 * The return value is a pointer to the icon associated to @p item when it was
26091 * created, with function elm_diskselector_item_append(), or later
26092 * with function elm_diskselector_item_icon_set. If no icon
26093 * was passed as argument, it will return @c NULL.
26095 * @see elm_diskselector_item_append()
26096 * @see elm_diskselector_item_icon_set()
26098 * @ingroup Diskselector
26100 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26103 * Set the label of item.
26105 * @param it The item of diskselector.
26106 * @param label The label of item.
26108 * The label to be displayed by the item.
26110 * If no icon is set, label will be centered on item position, otherwise
26111 * the icon will be placed at left of the label, that will be shifted
26114 * An item with label "January" would be displayed on side position as
26115 * "Jan" if max length is set to 3 with function
26116 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26119 * When this @p item is selected, the entire label will be displayed,
26120 * except for width restrictions.
26121 * In this case label will be cropped and "..." will be concatenated,
26122 * but only for display purposes. It will keep the entire string, so
26123 * if diskselector is resized the remaining characters will be displayed.
26125 * If a label was passed as argument on item creation, with function
26126 * elm_diskselector_item_append(), it will be already
26127 * displayed by the item.
26129 * @see elm_diskselector_side_label_lenght_set()
26130 * @see elm_diskselector_item_label_get()
26131 * @see elm_diskselector_item_append()
26133 * @ingroup Diskselector
26135 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26138 * Get the label of item.
26140 * @param it The item of diskselector.
26141 * @return The label of item.
26143 * The return value is a pointer to the label associated to @p item when it was
26144 * created, with function elm_diskselector_item_append(), or later
26145 * with function elm_diskselector_item_label_set. If no label
26146 * was passed as argument, it will return @c NULL.
26148 * @see elm_diskselector_item_label_set() for more details.
26149 * @see elm_diskselector_item_append()
26151 * @ingroup Diskselector
26153 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26156 * Get the selected item.
26158 * @param obj The diskselector object.
26159 * @return The selected diskselector item.
26161 * The selected item can be unselected with function
26162 * elm_diskselector_item_selected_set(), and the first item of
26163 * diskselector will be selected.
26165 * The selected item always will be centered on diskselector, with
26166 * full label displayed, i.e., max lenght set to side labels won't
26167 * apply on the selected item. More details on
26168 * elm_diskselector_side_label_length_set().
26170 * @ingroup Diskselector
26172 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26175 * Set the selected state of an item.
26177 * @param it The diskselector item
26178 * @param selected The selected state
26180 * This sets the selected state of the given item @p it.
26181 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26183 * If a new item is selected the previosly selected will be unselected.
26184 * Previoulsy selected item can be get with function
26185 * elm_diskselector_selected_item_get().
26187 * If the item @p it is unselected, the first item of diskselector will
26190 * Selected items will be visible on center position of diskselector.
26191 * So if it was on another position before selected, or was invisible,
26192 * diskselector will animate items until the selected item reaches center
26195 * @see elm_diskselector_item_selected_get()
26196 * @see elm_diskselector_selected_item_get()
26198 * @ingroup Diskselector
26200 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26203 * Get whether the @p item is selected or not.
26205 * @param it The diskselector item.
26206 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26207 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26209 * @see elm_diskselector_selected_item_set() for details.
26210 * @see elm_diskselector_item_selected_get()
26212 * @ingroup Diskselector
26214 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26217 * Get the first item of the diskselector.
26219 * @param obj The diskselector object.
26220 * @return The first item, or @c NULL if none.
26222 * The list of items follows append order. So it will return the first
26223 * item appended to the widget that wasn't deleted.
26225 * @see elm_diskselector_item_append()
26226 * @see elm_diskselector_items_get()
26228 * @ingroup Diskselector
26230 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26233 * Get the last item of the diskselector.
26235 * @param obj The diskselector object.
26236 * @return The last item, or @c NULL if none.
26238 * The list of items follows append order. So it will return last first
26239 * item appended to the widget that wasn't deleted.
26241 * @see elm_diskselector_item_append()
26242 * @see elm_diskselector_items_get()
26244 * @ingroup Diskselector
26246 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26249 * Get the item before @p item in diskselector.
26251 * @param it The diskselector item.
26252 * @return The item before @p item, or @c NULL if none or on failure.
26254 * The list of items follows append order. So it will return item appended
26255 * just before @p item and that wasn't deleted.
26257 * If it is the first item, @c NULL will be returned.
26258 * First item can be get by elm_diskselector_first_item_get().
26260 * @see elm_diskselector_item_append()
26261 * @see elm_diskselector_items_get()
26263 * @ingroup Diskselector
26265 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26268 * Get the item after @p item in diskselector.
26270 * @param it The diskselector item.
26271 * @return The item after @p item, or @c NULL if none or on failure.
26273 * The list of items follows append order. So it will return item appended
26274 * just after @p item and that wasn't deleted.
26276 * If it is the last item, @c NULL will be returned.
26277 * Last item can be get by elm_diskselector_last_item_get().
26279 * @see elm_diskselector_item_append()
26280 * @see elm_diskselector_items_get()
26282 * @ingroup Diskselector
26284 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26287 * Set the text to be shown in the diskselector item.
26289 * @param item Target item
26290 * @param text The text to set in the content
26292 * Setup the text as tooltip to object. The item can have only one tooltip,
26293 * so any previous tooltip data is removed.
26295 * @see elm_object_tooltip_text_set() for more details.
26297 * @ingroup Diskselector
26299 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26302 * Set the content to be shown in the tooltip item.
26304 * Setup the tooltip to item. The item can have only one tooltip,
26305 * so any previous tooltip data is removed. @p func(with @p data) will
26306 * be called every time that need show the tooltip and it should
26307 * return a valid Evas_Object. This object is then managed fully by
26308 * tooltip system and is deleted when the tooltip is gone.
26310 * @param item the diskselector item being attached a tooltip.
26311 * @param func the function used to create the tooltip contents.
26312 * @param data what to provide to @a func as callback data/context.
26313 * @param del_cb called when data is not needed anymore, either when
26314 * another callback replaces @p func, the tooltip is unset with
26315 * elm_diskselector_item_tooltip_unset() or the owner @a item
26316 * dies. This callback receives as the first parameter the
26317 * given @a data, and @c event_info is the item.
26319 * @see elm_object_tooltip_content_cb_set() for more details.
26321 * @ingroup Diskselector
26323 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);
26326 * Unset tooltip from item.
26328 * @param item diskselector item to remove previously set tooltip.
26330 * Remove tooltip from item. The callback provided as del_cb to
26331 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26332 * it is not used anymore.
26334 * @see elm_object_tooltip_unset() for more details.
26335 * @see elm_diskselector_item_tooltip_content_cb_set()
26337 * @ingroup Diskselector
26339 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26343 * Sets a different style for this item tooltip.
26345 * @note before you set a style you should define a tooltip with
26346 * elm_diskselector_item_tooltip_content_cb_set() or
26347 * elm_diskselector_item_tooltip_text_set()
26349 * @param item diskselector item with tooltip already set.
26350 * @param style the theme style to use (default, transparent, ...)
26352 * @see elm_object_tooltip_style_set() for more details.
26354 * @ingroup Diskselector
26356 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26359 * Get the style for this item tooltip.
26361 * @param item diskselector item with tooltip already set.
26362 * @return style the theme style in use, defaults to "default". If the
26363 * object does not have a tooltip set, then NULL is returned.
26365 * @see elm_object_tooltip_style_get() for more details.
26366 * @see elm_diskselector_item_tooltip_style_set()
26368 * @ingroup Diskselector
26370 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26373 * Set the cursor to be shown when mouse is over the diskselector item
26375 * @param item Target item
26376 * @param cursor the cursor name to be used.
26378 * @see elm_object_cursor_set() for more details.
26380 * @ingroup Diskselector
26382 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26385 * Get the cursor to be shown when mouse is over the diskselector item
26387 * @param item diskselector item with cursor already set.
26388 * @return the cursor name.
26390 * @see elm_object_cursor_get() for more details.
26391 * @see elm_diskselector_cursor_set()
26393 * @ingroup Diskselector
26395 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26399 * Unset the cursor to be shown when mouse is over the diskselector item
26401 * @param item Target item
26403 * @see elm_object_cursor_unset() for more details.
26404 * @see elm_diskselector_cursor_set()
26406 * @ingroup Diskselector
26408 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26411 * Sets a different style for this item cursor.
26413 * @note before you set a style you should define a cursor with
26414 * elm_diskselector_item_cursor_set()
26416 * @param item diskselector item with cursor already set.
26417 * @param style the theme style to use (default, transparent, ...)
26419 * @see elm_object_cursor_style_set() for more details.
26421 * @ingroup Diskselector
26423 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26427 * Get the style for this item cursor.
26429 * @param item diskselector item with cursor already set.
26430 * @return style the theme style in use, defaults to "default". If the
26431 * object does not have a cursor set, then @c NULL is returned.
26433 * @see elm_object_cursor_style_get() for more details.
26434 * @see elm_diskselector_item_cursor_style_set()
26436 * @ingroup Diskselector
26438 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26442 * Set if the cursor set should be searched on the theme or should use
26443 * the provided by the engine, only.
26445 * @note before you set if should look on theme you should define a cursor
26446 * with elm_diskselector_item_cursor_set().
26447 * By default it will only look for cursors provided by the engine.
26449 * @param item widget item with cursor already set.
26450 * @param engine_only boolean to define if cursors set with
26451 * elm_diskselector_item_cursor_set() should be searched only
26452 * between cursors provided by the engine or searched on widget's
26455 * @see elm_object_cursor_engine_only_set() for more details.
26457 * @ingroup Diskselector
26459 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26462 * Get the cursor engine only usage for this item cursor.
26464 * @param item widget item with cursor already set.
26465 * @return engine_only boolean to define it cursors should be looked only
26466 * between the provided by the engine or searched on widget's theme as well.
26467 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26469 * @see elm_object_cursor_engine_only_get() for more details.
26470 * @see elm_diskselector_item_cursor_engine_only_set()
26472 * @ingroup Diskselector
26474 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26481 * @defgroup Colorselector Colorselector
26485 * @image html img/widget/colorselector/preview-00.png
26486 * @image latex img/widget/colorselector/preview-00.eps
26488 * @brief Widget for user to select a color.
26490 * Signals that you can add callbacks for are:
26491 * "changed" - When the color value changes(event_info is NULL).
26493 * See @ref tutorial_colorselector.
26496 * @brief Add a new colorselector to the parent
26498 * @param parent The parent object
26499 * @return The new object or NULL if it cannot be created
26501 * @ingroup Colorselector
26503 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26505 * Set a color for the colorselector
26507 * @param obj Colorselector object
26508 * @param r r-value of color
26509 * @param g g-value of color
26510 * @param b b-value of color
26511 * @param a a-value of color
26513 * @ingroup Colorselector
26515 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26517 * Get a color from the colorselector
26519 * @param obj Colorselector object
26520 * @param r integer pointer for r-value of color
26521 * @param g integer pointer for g-value of color
26522 * @param b integer pointer for b-value of color
26523 * @param a integer pointer for a-value of color
26525 * @ingroup Colorselector
26527 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26533 * @defgroup Ctxpopup Ctxpopup
26535 * @image html img/widget/ctxpopup/preview-00.png
26536 * @image latex img/widget/ctxpopup/preview-00.eps
26538 * @brief Context popup widet.
26540 * A ctxpopup is a widget that, when shown, pops up a list of items.
26541 * It automatically chooses an area inside its parent object's view
26542 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26543 * optimally fit into it. In the default theme, it will also point an
26544 * arrow to it's top left position at the time one shows it. Ctxpopup
26545 * items have a label and/or an icon. It is intended for a small
26546 * number of items (hence the use of list, not genlist).
26548 * @note Ctxpopup is a especialization of @ref Hover.
26550 * Signals that you can add callbacks for are:
26551 * "dismissed" - the ctxpopup was dismissed
26553 * Default contents parts of the ctxpopup widget that you can use for are:
26554 * @li "default" - A content of the ctxpopup
26556 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26559 typedef enum _Elm_Ctxpopup_Direction
26561 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26563 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26564 the clicked area */
26565 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26566 the clicked area */
26567 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26569 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26570 } Elm_Ctxpopup_Direction;
26573 * @brief Add a new Ctxpopup object to the parent.
26575 * @param parent Parent object
26576 * @return New object or @c NULL, if it cannot be created
26578 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26580 * @brief Set the Ctxpopup's parent
26582 * @param obj The ctxpopup object
26583 * @param area The parent to use
26585 * Set the parent object.
26587 * @note elm_ctxpopup_add() will automatically call this function
26588 * with its @c parent argument.
26590 * @see elm_ctxpopup_add()
26591 * @see elm_hover_parent_set()
26593 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26595 * @brief Get the Ctxpopup's parent
26597 * @param obj The ctxpopup object
26599 * @see elm_ctxpopup_hover_parent_set() for more information
26601 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26603 * @brief Clear all items in the given ctxpopup object.
26605 * @param obj Ctxpopup object
26607 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26609 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26611 * @param obj Ctxpopup object
26612 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26614 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26616 * @brief Get the value of current ctxpopup object's orientation.
26618 * @param obj Ctxpopup object
26619 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26621 * @see elm_ctxpopup_horizontal_set()
26623 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26625 * @brief Add a new item to a ctxpopup object.
26627 * @param obj Ctxpopup object
26628 * @param icon Icon to be set on new item
26629 * @param label The Label of the new item
26630 * @param func Convenience function called when item selected
26631 * @param data Data passed to @p func
26632 * @return A handle to the item added or @c NULL, on errors
26634 * @warning Ctxpopup can't hold both an item list and a content at the same
26635 * time. When an item is added, any previous content will be removed.
26637 * @see elm_ctxpopup_content_set()
26639 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);
26641 * @brief Delete the given item in a ctxpopup object.
26643 * @param it Ctxpopup item to be deleted
26645 * @see elm_ctxpopup_item_append()
26647 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26649 * @brief Set the ctxpopup item's state as disabled or enabled.
26651 * @param it Ctxpopup item to be enabled/disabled
26652 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26654 * When disabled the item is greyed out to indicate it's state.
26656 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26658 * @brief Get the ctxpopup item's disabled/enabled state.
26660 * @param it Ctxpopup item to be enabled/disabled
26661 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26663 * @see elm_ctxpopup_item_disabled_set()
26665 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26667 * @brief Get the icon object for the given ctxpopup item.
26669 * @param it Ctxpopup item
26670 * @return icon object or @c NULL, if the item does not have icon or an error
26673 * @see elm_ctxpopup_item_append()
26674 * @see elm_ctxpopup_item_icon_set()
26676 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26678 * @brief Sets the side icon associated with the ctxpopup item
26680 * @param it Ctxpopup item
26681 * @param icon Icon object to be set
26683 * Once the icon object is set, a previously set one will be deleted.
26684 * @warning Setting the same icon for two items will cause the icon to
26685 * dissapear from the first item.
26687 * @see elm_ctxpopup_item_append()
26689 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26691 * @brief Get the label for the given ctxpopup item.
26693 * @param it Ctxpopup item
26694 * @return label string or @c NULL, if the item does not have label or an
26697 * @see elm_ctxpopup_item_append()
26698 * @see elm_ctxpopup_item_label_set()
26700 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26702 * @brief (Re)set the label on the given ctxpopup item.
26704 * @param it Ctxpopup item
26705 * @param label String to set as label
26707 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26709 * @brief Set an elm widget as the content of the ctxpopup.
26711 * @param obj Ctxpopup object
26712 * @param content Content to be swallowed
26714 * If the content object is already set, a previous one will bedeleted. If
26715 * you want to keep that old content object, use the
26716 * elm_ctxpopup_content_unset() function.
26718 * @warning Ctxpopup can't hold both a item list and a content at the same
26719 * time. When a content is set, any previous items will be removed.
26721 * @deprecated use elm_object_content_set() instead
26724 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26726 * @brief Unset the ctxpopup content
26728 * @param obj Ctxpopup object
26729 * @return The content that was being used
26731 * Unparent and return the content object which was set for this widget.
26733 * @deprecated use elm_object_content_unset()
26735 * @see elm_ctxpopup_content_set()
26737 * @deprecated use elm_object_content_unset() instead
26740 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26742 * @brief Set the direction priority of a ctxpopup.
26744 * @param obj Ctxpopup object
26745 * @param first 1st priority of direction
26746 * @param second 2nd priority of direction
26747 * @param third 3th priority of direction
26748 * @param fourth 4th priority of direction
26750 * This functions gives a chance to user to set the priority of ctxpopup
26751 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26752 * requested direction.
26754 * @see Elm_Ctxpopup_Direction
26756 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);
26758 * @brief Get the direction priority of a ctxpopup.
26760 * @param obj Ctxpopup object
26761 * @param first 1st priority of direction to be returned
26762 * @param second 2nd priority of direction to be returned
26763 * @param third 3th priority of direction to be returned
26764 * @param fourth 4th priority of direction to be returned
26766 * @see elm_ctxpopup_direction_priority_set() for more information.
26768 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);
26771 * @brief Get the current direction of a ctxpopup.
26773 * @param obj Ctxpopup object
26774 * @return current direction of a ctxpopup
26776 * @warning Once the ctxpopup showed up, the direction would be determined
26778 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26787 * @defgroup Transit Transit
26788 * @ingroup Elementary
26790 * Transit is designed to apply various animated transition effects to @c
26791 * Evas_Object, such like translation, rotation, etc. For using these
26792 * effects, create an @ref Elm_Transit and add the desired transition effects.
26794 * Once the effects are added into transit, they will be automatically
26795 * managed (their callback will be called until the duration is ended, and
26796 * they will be deleted on completion).
26800 * Elm_Transit *trans = elm_transit_add();
26801 * elm_transit_object_add(trans, obj);
26802 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26803 * elm_transit_duration_set(transit, 1);
26804 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26805 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26806 * elm_transit_repeat_times_set(transit, 3);
26809 * Some transition effects are used to change the properties of objects. They
26811 * @li @ref elm_transit_effect_translation_add
26812 * @li @ref elm_transit_effect_color_add
26813 * @li @ref elm_transit_effect_rotation_add
26814 * @li @ref elm_transit_effect_wipe_add
26815 * @li @ref elm_transit_effect_zoom_add
26816 * @li @ref elm_transit_effect_resizing_add
26818 * Other transition effects are used to make one object disappear and another
26819 * object appear on its old place. These effects are:
26821 * @li @ref elm_transit_effect_flip_add
26822 * @li @ref elm_transit_effect_resizable_flip_add
26823 * @li @ref elm_transit_effect_fade_add
26824 * @li @ref elm_transit_effect_blend_add
26826 * It's also possible to make a transition chain with @ref
26827 * elm_transit_chain_transit_add.
26829 * @warning We strongly recommend to use elm_transit just when edje can not do
26830 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26831 * animations can be manipulated inside the theme.
26833 * List of examples:
26834 * @li @ref transit_example_01_explained
26835 * @li @ref transit_example_02_explained
26836 * @li @ref transit_example_03_c
26837 * @li @ref transit_example_04_c
26843 * @enum Elm_Transit_Tween_Mode
26845 * The type of acceleration used in the transition.
26849 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26850 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26851 over time, then decrease again
26853 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26855 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26857 } Elm_Transit_Tween_Mode;
26860 * @enum Elm_Transit_Effect_Flip_Axis
26862 * The axis where flip effect should be applied.
26866 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26867 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26868 } Elm_Transit_Effect_Flip_Axis;
26870 * @enum Elm_Transit_Effect_Wipe_Dir
26872 * The direction where the wipe effect should occur.
26876 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26877 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26878 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26879 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26880 } Elm_Transit_Effect_Wipe_Dir;
26881 /** @enum Elm_Transit_Effect_Wipe_Type
26883 * Whether the wipe effect should show or hide the object.
26887 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26889 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26891 } Elm_Transit_Effect_Wipe_Type;
26894 * @typedef Elm_Transit
26896 * The Transit created with elm_transit_add(). This type has the information
26897 * about the objects which the transition will be applied, and the
26898 * transition effects that will be used. It also contains info about
26899 * duration, number of repetitions, auto-reverse, etc.
26901 typedef struct _Elm_Transit Elm_Transit;
26902 typedef void Elm_Transit_Effect;
26904 * @typedef Elm_Transit_Effect_Transition_Cb
26906 * Transition callback called for this effect on each transition iteration.
26908 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26910 * Elm_Transit_Effect_End_Cb
26912 * Transition callback called for this effect when the transition is over.
26914 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26917 * Elm_Transit_Del_Cb
26919 * A callback called when the transit is deleted.
26921 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26926 * @note Is not necessary to delete the transit object, it will be deleted at
26927 * the end of its operation.
26928 * @note The transit will start playing when the program enter in the main loop, is not
26929 * necessary to give a start to the transit.
26931 * @return The transit object.
26935 EAPI Elm_Transit *elm_transit_add(void);
26938 * Stops the animation and delete the @p transit object.
26940 * Call this function if you wants to stop the animation before the duration
26941 * time. Make sure the @p transit object is still alive with
26942 * elm_transit_del_cb_set() function.
26943 * All added effects will be deleted, calling its repective data_free_cb
26944 * functions. The function setted by elm_transit_del_cb_set() will be called.
26946 * @see elm_transit_del_cb_set()
26948 * @param transit The transit object to be deleted.
26951 * @warning Just call this function if you are sure the transit is alive.
26953 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26956 * Add a new effect to the transit.
26958 * @note The cb function and the data are the key to the effect. If you try to
26959 * add an already added effect, nothing is done.
26960 * @note After the first addition of an effect in @p transit, if its
26961 * effect list become empty again, the @p transit will be killed by
26962 * elm_transit_del(transit) function.
26966 * Elm_Transit *transit = elm_transit_add();
26967 * elm_transit_effect_add(transit,
26968 * elm_transit_effect_blend_op,
26969 * elm_transit_effect_blend_context_new(),
26970 * elm_transit_effect_blend_context_free);
26973 * @param transit The transit object.
26974 * @param transition_cb The operation function. It is called when the
26975 * animation begins, it is the function that actually performs the animation.
26976 * It is called with the @p data, @p transit and the time progression of the
26977 * animation (a double value between 0.0 and 1.0).
26978 * @param effect The context data of the effect.
26979 * @param end_cb The function to free the context data, it will be called
26980 * at the end of the effect, it must finalize the animation and free the
26984 * @warning The transit free the context data at the and of the transition with
26985 * the data_free_cb function, do not use the context data in another transit.
26987 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);
26990 * Delete an added effect.
26992 * This function will remove the effect from the @p transit, calling the
26993 * data_free_cb to free the @p data.
26995 * @see elm_transit_effect_add()
26997 * @note If the effect is not found, nothing is done.
26998 * @note If the effect list become empty, this function will call
26999 * elm_transit_del(transit), that is, it will kill the @p transit.
27001 * @param transit The transit object.
27002 * @param transition_cb The operation function.
27003 * @param effect The context data of the effect.
27007 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);
27010 * Add new object to apply the effects.
27012 * @note After the first addition of an object in @p transit, if its
27013 * object list become empty again, the @p transit will be killed by
27014 * elm_transit_del(transit) function.
27015 * @note If the @p obj belongs to another transit, the @p obj will be
27016 * removed from it and it will only belong to the @p transit. If the old
27017 * transit stays without objects, it will die.
27018 * @note When you add an object into the @p transit, its state from
27019 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27020 * transit ends, if you change this state whith evas_object_pass_events_set()
27021 * after add the object, this state will change again when @p transit stops to
27024 * @param transit The transit object.
27025 * @param obj Object to be animated.
27028 * @warning It is not allowed to add a new object after transit begins to go.
27030 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27033 * Removes an added object from the transit.
27035 * @note If the @p obj is not in the @p transit, nothing is done.
27036 * @note If the list become empty, this function will call
27037 * elm_transit_del(transit), that is, it will kill the @p transit.
27039 * @param transit The transit object.
27040 * @param obj Object to be removed from @p transit.
27043 * @warning It is not allowed to remove objects after transit begins to go.
27045 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27048 * Get the objects of the transit.
27050 * @param transit The transit object.
27051 * @return a Eina_List with the objects from the transit.
27055 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27058 * Enable/disable keeping up the objects states.
27059 * If it is not kept, the objects states will be reset when transition ends.
27061 * @note @p transit can not be NULL.
27062 * @note One state includes geometry, color, map data.
27064 * @param transit The transit object.
27065 * @param state_keep Keeping or Non Keeping.
27069 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27072 * Get a value whether the objects states will be reset or not.
27074 * @note @p transit can not be NULL
27076 * @see elm_transit_objects_final_state_keep_set()
27078 * @param transit The transit object.
27079 * @return EINA_TRUE means the states of the objects will be reset.
27080 * If @p transit is NULL, EINA_FALSE is returned
27084 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27087 * Set the event enabled when transit is operating.
27089 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27090 * events from mouse and keyboard during the animation.
27091 * @note When you add an object with elm_transit_object_add(), its state from
27092 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27093 * transit ends, if you change this state with evas_object_pass_events_set()
27094 * after adding the object, this state will change again when @p transit stops
27097 * @param transit The transit object.
27098 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27099 * ignored otherwise.
27103 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27106 * Get the value of event enabled status.
27108 * @see elm_transit_event_enabled_set()
27110 * @param transit The Transit object
27111 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27112 * EINA_FALSE is returned
27116 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27119 * Set the user-callback function when the transit is deleted.
27121 * @note Using this function twice will overwrite the first function setted.
27122 * @note the @p transit object will be deleted after call @p cb function.
27124 * @param transit The transit object.
27125 * @param cb Callback function pointer. This function will be called before
27126 * the deletion of the transit.
27127 * @param data Callback funtion user data. It is the @p op parameter.
27131 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27134 * Set reverse effect automatically.
27136 * If auto reverse is setted, after running the effects with the progress
27137 * parameter from 0 to 1, it will call the effecs again with the progress
27138 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27139 * where the duration was setted with the function elm_transit_add and
27140 * the repeat with the function elm_transit_repeat_times_set().
27142 * @param transit The transit object.
27143 * @param reverse EINA_TRUE means the auto_reverse is on.
27147 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27150 * Get if the auto reverse is on.
27152 * @see elm_transit_auto_reverse_set()
27154 * @param transit The transit object.
27155 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27156 * EINA_FALSE is returned
27160 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27163 * Set the transit repeat count. Effect will be repeated by repeat count.
27165 * This function sets the number of repetition the transit will run after
27166 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27167 * If the @p repeat is a negative number, it will repeat infinite times.
27169 * @note If this function is called during the transit execution, the transit
27170 * will run @p repeat times, ignoring the times it already performed.
27172 * @param transit The transit object
27173 * @param repeat Repeat count
27177 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27180 * Get the transit repeat count.
27182 * @see elm_transit_repeat_times_set()
27184 * @param transit The Transit object.
27185 * @return The repeat count. If @p transit is NULL
27190 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27193 * Set the transit animation acceleration type.
27195 * This function sets the tween mode of the transit that can be:
27196 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27197 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27198 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27199 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27201 * @param transit The transit object.
27202 * @param tween_mode The tween type.
27206 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27209 * Get the transit animation acceleration type.
27211 * @note @p transit can not be NULL
27213 * @param transit The transit object.
27214 * @return The tween type. If @p transit is NULL
27215 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27219 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27222 * Set the transit animation time
27224 * @note @p transit can not be NULL
27226 * @param transit The transit object.
27227 * @param duration The animation time.
27231 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27234 * Get the transit animation time
27236 * @note @p transit can not be NULL
27238 * @param transit The transit object.
27240 * @return The transit animation time.
27244 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27247 * Starts the transition.
27248 * Once this API is called, the transit begins to measure the time.
27250 * @note @p transit can not be NULL
27252 * @param transit The transit object.
27256 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27259 * Pause/Resume the transition.
27261 * If you call elm_transit_go again, the transit will be started from the
27262 * beginning, and will be unpaused.
27264 * @note @p transit can not be NULL
27266 * @param transit The transit object.
27267 * @param paused Whether the transition should be paused or not.
27271 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27274 * Get the value of paused status.
27276 * @see elm_transit_paused_set()
27278 * @note @p transit can not be NULL
27280 * @param transit The transit object.
27281 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27282 * EINA_FALSE is returned
27286 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27289 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27291 * The value returned is a fraction (current time / total time). It
27292 * represents the progression position relative to the total.
27294 * @note @p transit can not be NULL
27296 * @param transit The transit object.
27298 * @return The time progression value. If @p transit is NULL
27303 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27306 * Makes the chain relationship between two transits.
27308 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27309 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27311 * @param transit The transit object.
27312 * @param chain_transit The chain transit object. This transit will be operated
27313 * after transit is done.
27315 * This function adds @p chain_transit transition to a chain after the @p
27316 * transit, and will be started as soon as @p transit ends. See @ref
27317 * transit_example_02_explained for a full example.
27321 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27324 * Cut off the chain relationship between two transits.
27326 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27327 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27329 * @param transit The transit object.
27330 * @param chain_transit The chain transit object.
27332 * This function remove the @p chain_transit transition from the @p transit.
27336 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27339 * Get the current chain transit list.
27341 * @note @p transit can not be NULL.
27343 * @param transit The transit object.
27344 * @return chain transit list.
27348 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27351 * Add the Resizing Effect to Elm_Transit.
27353 * @note This API is one of the facades. It creates resizing effect context
27354 * and add it's required APIs to elm_transit_effect_add.
27356 * @see elm_transit_effect_add()
27358 * @param transit Transit object.
27359 * @param from_w Object width size when effect begins.
27360 * @param from_h Object height size when effect begins.
27361 * @param to_w Object width size when effect ends.
27362 * @param to_h Object height size when effect ends.
27363 * @return Resizing effect context data.
27367 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);
27370 * Add the Translation Effect to Elm_Transit.
27372 * @note This API is one of the facades. It creates translation effect context
27373 * and add it's required APIs to elm_transit_effect_add.
27375 * @see elm_transit_effect_add()
27377 * @param transit Transit object.
27378 * @param from_dx X Position variation when effect begins.
27379 * @param from_dy Y Position variation when effect begins.
27380 * @param to_dx X Position variation when effect ends.
27381 * @param to_dy Y Position variation when effect ends.
27382 * @return Translation effect context data.
27385 * @warning It is highly recommended just create a transit with this effect when
27386 * the window that the objects of the transit belongs has already been created.
27387 * This is because this effect needs the geometry information about the objects,
27388 * and if the window was not created yet, it can get a wrong information.
27390 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);
27393 * Add the Zoom Effect to Elm_Transit.
27395 * @note This API is one of the facades. It creates zoom effect context
27396 * and add it's required APIs to elm_transit_effect_add.
27398 * @see elm_transit_effect_add()
27400 * @param transit Transit object.
27401 * @param from_rate Scale rate when effect begins (1 is current rate).
27402 * @param to_rate Scale rate when effect ends.
27403 * @return Zoom effect context data.
27406 * @warning It is highly recommended just create a transit with this effect when
27407 * the window that the objects of the transit belongs has already been created.
27408 * This is because this effect needs the geometry information about the objects,
27409 * and if the window was not created yet, it can get a wrong information.
27411 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27414 * Add the Flip Effect to Elm_Transit.
27416 * @note This API is one of the facades. It creates flip effect context
27417 * and add it's required APIs to elm_transit_effect_add.
27418 * @note This effect is applied to each pair of objects in the order they are listed
27419 * in the transit list of objects. The first object in the pair will be the
27420 * "front" object and the second will be the "back" object.
27422 * @see elm_transit_effect_add()
27424 * @param transit Transit object.
27425 * @param axis Flipping Axis(X or Y).
27426 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27427 * @return Flip effect context data.
27430 * @warning It is highly recommended just create a transit with this effect when
27431 * the window that the objects of the transit belongs has already been created.
27432 * This is because this effect needs the geometry information about the objects,
27433 * and if the window was not created yet, it can get a wrong information.
27435 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27438 * Add the Resizable Flip Effect to Elm_Transit.
27440 * @note This API is one of the facades. It creates resizable flip effect context
27441 * and add it's required APIs to elm_transit_effect_add.
27442 * @note This effect is applied to each pair of objects in the order they are listed
27443 * in the transit list of objects. The first object in the pair will be the
27444 * "front" object and the second will be the "back" object.
27446 * @see elm_transit_effect_add()
27448 * @param transit Transit object.
27449 * @param axis Flipping Axis(X or Y).
27450 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27451 * @return Resizable flip effect context data.
27454 * @warning It is highly recommended just create a transit with this effect when
27455 * the window that the objects of the transit belongs has already been created.
27456 * This is because this effect needs the geometry information about the objects,
27457 * and if the window was not created yet, it can get a wrong information.
27459 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27462 * Add the Wipe Effect to Elm_Transit.
27464 * @note This API is one of the facades. It creates wipe effect context
27465 * and add it's required APIs to elm_transit_effect_add.
27467 * @see elm_transit_effect_add()
27469 * @param transit Transit object.
27470 * @param type Wipe type. Hide or show.
27471 * @param dir Wipe Direction.
27472 * @return Wipe effect context data.
27475 * @warning It is highly recommended just create a transit with this effect when
27476 * the window that the objects of the transit belongs has already been created.
27477 * This is because this effect needs the geometry information about the objects,
27478 * and if the window was not created yet, it can get a wrong information.
27480 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27483 * Add the Color Effect to Elm_Transit.
27485 * @note This API is one of the facades. It creates color effect context
27486 * and add it's required APIs to elm_transit_effect_add.
27488 * @see elm_transit_effect_add()
27490 * @param transit Transit object.
27491 * @param from_r RGB R when effect begins.
27492 * @param from_g RGB G when effect begins.
27493 * @param from_b RGB B when effect begins.
27494 * @param from_a RGB A when effect begins.
27495 * @param to_r RGB R when effect ends.
27496 * @param to_g RGB G when effect ends.
27497 * @param to_b RGB B when effect ends.
27498 * @param to_a RGB A when effect ends.
27499 * @return Color effect context data.
27503 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);
27506 * Add the Fade Effect to Elm_Transit.
27508 * @note This API is one of the facades. It creates fade effect context
27509 * and add it's required APIs to elm_transit_effect_add.
27510 * @note This effect is applied to each pair of objects in the order they are listed
27511 * in the transit list of objects. The first object in the pair will be the
27512 * "before" object and the second will be the "after" object.
27514 * @see elm_transit_effect_add()
27516 * @param transit Transit object.
27517 * @return Fade effect context data.
27520 * @warning It is highly recommended just create a transit with this effect when
27521 * the window that the objects of the transit belongs has already been created.
27522 * This is because this effect needs the color information about the objects,
27523 * and if the window was not created yet, it can get a wrong information.
27525 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27528 * Add the Blend Effect to Elm_Transit.
27530 * @note This API is one of the facades. It creates blend effect context
27531 * and add it's required APIs to elm_transit_effect_add.
27532 * @note This effect is applied to each pair of objects in the order they are listed
27533 * in the transit list of objects. The first object in the pair will be the
27534 * "before" object and the second will be the "after" object.
27536 * @see elm_transit_effect_add()
27538 * @param transit Transit object.
27539 * @return Blend effect context data.
27542 * @warning It is highly recommended just create a transit with this effect when
27543 * the window that the objects of the transit belongs has already been created.
27544 * This is because this effect needs the color information about the objects,
27545 * and if the window was not created yet, it can get a wrong information.
27547 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27550 * Add the Rotation Effect to Elm_Transit.
27552 * @note This API is one of the facades. It creates rotation effect context
27553 * and add it's required APIs to elm_transit_effect_add.
27555 * @see elm_transit_effect_add()
27557 * @param transit Transit object.
27558 * @param from_degree Degree when effect begins.
27559 * @param to_degree Degree when effect is ends.
27560 * @return Rotation effect context data.
27563 * @warning It is highly recommended just create a transit with this effect when
27564 * the window that the objects of the transit belongs has already been created.
27565 * This is because this effect needs the geometry information about the objects,
27566 * and if the window was not created yet, it can get a wrong information.
27568 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27571 * Add the ImageAnimation Effect to Elm_Transit.
27573 * @note This API is one of the facades. It creates image animation effect context
27574 * and add it's required APIs to elm_transit_effect_add.
27575 * The @p images parameter is a list images paths. This list and
27576 * its contents will be deleted at the end of the effect by
27577 * elm_transit_effect_image_animation_context_free() function.
27581 * char buf[PATH_MAX];
27582 * Eina_List *images = NULL;
27583 * Elm_Transit *transi = elm_transit_add();
27585 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27586 * images = eina_list_append(images, eina_stringshare_add(buf));
27588 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27589 * images = eina_list_append(images, eina_stringshare_add(buf));
27590 * elm_transit_effect_image_animation_add(transi, images);
27594 * @see elm_transit_effect_add()
27596 * @param transit Transit object.
27597 * @param images Eina_List of images file paths. This list and
27598 * its contents will be deleted at the end of the effect by
27599 * elm_transit_effect_image_animation_context_free() function.
27600 * @return Image Animation effect context data.
27604 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27609 typedef struct _Elm_Store Elm_Store;
27610 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27611 typedef struct _Elm_Store_Item Elm_Store_Item;
27612 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27613 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27614 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27615 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27616 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27617 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27618 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27619 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27621 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27622 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27623 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27624 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27628 ELM_STORE_ITEM_MAPPING_NONE = 0,
27629 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27630 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27631 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27632 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27633 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27634 // can add more here as needed by common apps
27635 ELM_STORE_ITEM_MAPPING_LAST
27636 } Elm_Store_Item_Mapping_Type;
27638 struct _Elm_Store_Item_Mapping_Icon
27640 // FIXME: allow edje file icons
27642 Elm_Icon_Lookup_Order lookup_order;
27643 Eina_Bool standard_name : 1;
27644 Eina_Bool no_scale : 1;
27645 Eina_Bool smooth : 1;
27646 Eina_Bool scale_up : 1;
27647 Eina_Bool scale_down : 1;
27650 struct _Elm_Store_Item_Mapping_Empty
27655 struct _Elm_Store_Item_Mapping_Photo
27660 struct _Elm_Store_Item_Mapping_Custom
27662 Elm_Store_Item_Mapping_Cb func;
27665 struct _Elm_Store_Item_Mapping
27667 Elm_Store_Item_Mapping_Type type;
27672 Elm_Store_Item_Mapping_Empty empty;
27673 Elm_Store_Item_Mapping_Icon icon;
27674 Elm_Store_Item_Mapping_Photo photo;
27675 Elm_Store_Item_Mapping_Custom custom;
27676 // add more types here
27680 struct _Elm_Store_Item_Info
27682 Elm_Genlist_Item_Class *item_class;
27683 const Elm_Store_Item_Mapping *mapping;
27688 struct _Elm_Store_Item_Info_Filesystem
27690 Elm_Store_Item_Info base;
27694 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27695 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27697 EAPI void elm_store_free(Elm_Store *st);
27699 EAPI Elm_Store *elm_store_filesystem_new(void);
27700 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27701 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27702 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27704 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27706 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27707 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27708 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27709 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27710 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27711 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27713 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27714 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27715 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27716 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27717 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27718 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27719 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27722 * @defgroup SegmentControl SegmentControl
27723 * @ingroup Elementary
27725 * @image html img/widget/segment_control/preview-00.png
27726 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27728 * @image html img/segment_control.png
27729 * @image latex img/segment_control.eps width=\textwidth
27731 * Segment control widget is a horizontal control made of multiple segment
27732 * items, each segment item functioning similar to discrete two state button.
27733 * A segment control groups the items together and provides compact
27734 * single button with multiple equal size segments.
27736 * Segment item size is determined by base widget
27737 * size and the number of items added.
27738 * Only one segment item can be at selected state. A segment item can display
27739 * combination of Text and any Evas_Object like Images or other widget.
27741 * Smart callbacks one can listen to:
27742 * - "changed" - When the user clicks on a segment item which is not
27743 * previously selected and get selected. The event_info parameter is the
27744 * segment item pointer.
27746 * Available styles for it:
27749 * Here is an example on its usage:
27750 * @li @ref segment_control_example
27754 * @addtogroup SegmentControl
27758 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27761 * Add a new segment control widget to the given parent Elementary
27762 * (container) object.
27764 * @param parent The parent object.
27765 * @return a new segment control widget handle or @c NULL, on errors.
27767 * This function inserts a new segment control widget on the canvas.
27769 * @ingroup SegmentControl
27771 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27774 * Append a new item to the segment control object.
27776 * @param obj The segment control object.
27777 * @param icon The icon object to use for the left side of the item. An
27778 * icon can be any Evas object, but usually it is an icon created
27779 * with elm_icon_add().
27780 * @param label The label of the item.
27781 * Note that, NULL is different from empty string "".
27782 * @return The created item or @c NULL upon failure.
27784 * A new item will be created and appended to the segment control, i.e., will
27785 * be set as @b last item.
27787 * If it should be inserted at another position,
27788 * elm_segment_control_item_insert_at() should be used instead.
27790 * Items created with this function can be deleted with function
27791 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27793 * @note @p label set to @c NULL is different from empty string "".
27795 * only has icon, it will be displayed bigger and centered. If it has
27796 * icon and label, even that an empty string, icon will be smaller and
27797 * positioned at left.
27801 * sc = elm_segment_control_add(win);
27802 * ic = elm_icon_add(win);
27803 * elm_icon_file_set(ic, "path/to/image", NULL);
27804 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27805 * elm_segment_control_item_add(sc, ic, "label");
27806 * evas_object_show(sc);
27809 * @see elm_segment_control_item_insert_at()
27810 * @see elm_segment_control_item_del()
27812 * @ingroup SegmentControl
27814 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27817 * Insert a new item to the segment control object at specified position.
27819 * @param obj The segment control object.
27820 * @param icon The icon object to use for the left side of the item. An
27821 * icon can be any Evas object, but usually it is an icon created
27822 * with elm_icon_add().
27823 * @param label The label of the item.
27824 * @param index Item position. Value should be between 0 and items count.
27825 * @return The created item or @c NULL upon failure.
27827 * Index values must be between @c 0, when item will be prepended to
27828 * segment control, and items count, that can be get with
27829 * elm_segment_control_item_count_get(), case when item will be appended
27830 * to segment control, just like elm_segment_control_item_add().
27832 * Items created with this function can be deleted with function
27833 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27835 * @note @p label set to @c NULL is different from empty string "".
27837 * only has icon, it will be displayed bigger and centered. If it has
27838 * icon and label, even that an empty string, icon will be smaller and
27839 * positioned at left.
27841 * @see elm_segment_control_item_add()
27842 * @see elm_segment_control_item_count_get()
27843 * @see elm_segment_control_item_del()
27845 * @ingroup SegmentControl
27847 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);
27850 * Remove a segment control item from its parent, deleting it.
27852 * @param it The item to be removed.
27854 * Items can be added with elm_segment_control_item_add() or
27855 * elm_segment_control_item_insert_at().
27857 * @ingroup SegmentControl
27859 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27862 * Remove a segment control item at given index from its parent,
27865 * @param obj The segment control object.
27866 * @param index The position of the segment control item to be deleted.
27868 * Items can be added with elm_segment_control_item_add() or
27869 * elm_segment_control_item_insert_at().
27871 * @ingroup SegmentControl
27873 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27876 * Get the Segment items count from segment control.
27878 * @param obj The segment control object.
27879 * @return Segment items count.
27881 * It will just return the number of items added to segment control @p obj.
27883 * @ingroup SegmentControl
27885 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27888 * Get the item placed at specified index.
27890 * @param obj The segment control object.
27891 * @param index The index of the segment item.
27892 * @return The segment control item or @c NULL on failure.
27894 * Index is the position of an item in segment control widget. Its
27895 * range is from @c 0 to <tt> count - 1 </tt>.
27896 * Count is the number of items, that can be get with
27897 * elm_segment_control_item_count_get().
27899 * @ingroup SegmentControl
27901 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27904 * Get the label of item.
27906 * @param obj The segment control object.
27907 * @param index The index of the segment item.
27908 * @return The label of the item at @p index.
27910 * The return value is a pointer to the label associated to the item when
27911 * it was created, with function elm_segment_control_item_add(), or later
27912 * with function elm_segment_control_item_label_set. If no label
27913 * was passed as argument, it will return @c NULL.
27915 * @see elm_segment_control_item_label_set() for more details.
27916 * @see elm_segment_control_item_add()
27918 * @ingroup SegmentControl
27920 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27923 * Set the label of item.
27925 * @param it The item of segment control.
27926 * @param text The label of item.
27928 * The label to be displayed by the item.
27929 * Label will be at right of the icon (if set).
27931 * If a label was passed as argument on item creation, with function
27932 * elm_control_segment_item_add(), it will be already
27933 * displayed by the item.
27935 * @see elm_segment_control_item_label_get()
27936 * @see elm_segment_control_item_add()
27938 * @ingroup SegmentControl
27940 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27943 * Get the icon associated to the item.
27945 * @param obj The segment control object.
27946 * @param index The index of the segment item.
27947 * @return The left side icon associated to the item at @p index.
27949 * The return value is a pointer to the icon associated to the item when
27950 * it was created, with function elm_segment_control_item_add(), or later
27951 * with function elm_segment_control_item_icon_set(). If no icon
27952 * was passed as argument, it will return @c NULL.
27954 * @see elm_segment_control_item_add()
27955 * @see elm_segment_control_item_icon_set()
27957 * @ingroup SegmentControl
27959 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27962 * Set the icon associated to the item.
27964 * @param it The segment control item.
27965 * @param icon The icon object to associate with @p it.
27967 * The icon object to use at left side of the item. An
27968 * icon can be any Evas object, but usually it is an icon created
27969 * with elm_icon_add().
27971 * Once the icon object is set, a previously set one will be deleted.
27972 * @warning Setting the same icon for two items will cause the icon to
27973 * dissapear from the first item.
27975 * If an icon was passed as argument on item creation, with function
27976 * elm_segment_control_item_add(), it will be already
27977 * associated to the item.
27979 * @see elm_segment_control_item_add()
27980 * @see elm_segment_control_item_icon_get()
27982 * @ingroup SegmentControl
27984 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27987 * Get the index of an item.
27989 * @param it The segment control item.
27990 * @return The position of item in segment control widget.
27992 * Index is the position of an item in segment control widget. Its
27993 * range is from @c 0 to <tt> count - 1 </tt>.
27994 * Count is the number of items, that can be get with
27995 * elm_segment_control_item_count_get().
27997 * @ingroup SegmentControl
27999 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28002 * Get the base object of the item.
28004 * @param it The segment control item.
28005 * @return The base object associated with @p it.
28007 * Base object is the @c Evas_Object that represents that item.
28009 * @ingroup SegmentControl
28011 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28014 * Get the selected item.
28016 * @param obj The segment control object.
28017 * @return The selected item or @c NULL if none of segment items is
28020 * The selected item can be unselected with function
28021 * elm_segment_control_item_selected_set().
28023 * The selected item always will be highlighted on segment control.
28025 * @ingroup SegmentControl
28027 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28030 * Set the selected state of an item.
28032 * @param it The segment control item
28033 * @param select The selected state
28035 * This sets the selected state of the given item @p it.
28036 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28038 * If a new item is selected the previosly selected will be unselected.
28039 * Previoulsy selected item can be get with function
28040 * elm_segment_control_item_selected_get().
28042 * The selected item always will be highlighted on segment control.
28044 * @see elm_segment_control_item_selected_get()
28046 * @ingroup SegmentControl
28048 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28055 * @defgroup Grid Grid
28057 * The grid is a grid layout widget that lays out a series of children as a
28058 * fixed "grid" of widgets using a given percentage of the grid width and
28059 * height each using the child object.
28061 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28062 * widgets size itself. The default is 100 x 100, so that means the
28063 * position and sizes of children will effectively be percentages (0 to 100)
28064 * of the width or height of the grid widget
28070 * Add a new grid to the parent
28072 * @param parent The parent object
28073 * @return The new object or NULL if it cannot be created
28077 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28080 * Set the virtual size of the grid
28082 * @param obj The grid object
28083 * @param w The virtual width of the grid
28084 * @param h The virtual height of the grid
28088 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28091 * Get the virtual size of the grid
28093 * @param obj The grid object
28094 * @param w Pointer to integer to store the virtual width of the grid
28095 * @param h Pointer to integer to store the virtual height of the grid
28099 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28102 * Pack child at given position and size
28104 * @param obj The grid object
28105 * @param subobj The child to pack
28106 * @param x The virtual x coord at which to pack it
28107 * @param y The virtual y coord at which to pack it
28108 * @param w The virtual width at which to pack it
28109 * @param h The virtual height at which to pack it
28113 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28116 * Unpack a child from a grid object
28118 * @param obj The grid object
28119 * @param subobj The child to unpack
28123 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28126 * Faster way to remove all child objects from a grid object.
28128 * @param obj The grid object
28129 * @param clear If true, it will delete just removed children
28133 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28136 * Set packing of an existing child at to position and size
28138 * @param subobj The child to set packing of
28139 * @param x The virtual x coord at which to pack it
28140 * @param y The virtual y coord at which to pack it
28141 * @param w The virtual width at which to pack it
28142 * @param h The virtual height at which to pack it
28146 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28149 * get packing of a child
28151 * @param subobj The child to query
28152 * @param x Pointer to integer to store the virtual x coord
28153 * @param y Pointer to integer to store the virtual y coord
28154 * @param w Pointer to integer to store the virtual width
28155 * @param h Pointer to integer to store the virtual height
28159 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28165 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28166 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28167 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28168 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28169 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28170 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28173 * @defgroup Video Video
28175 * @addtogroup Video
28178 * Elementary comes with two object that help design application that need
28179 * to display video. The main one, Elm_Video, display a video by using Emotion.
28180 * It does embedded the video inside an Edje object, so you can do some
28181 * animation depending on the video state change. It does also implement a
28182 * ressource management policy to remove this burden from the application writer.
28184 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28185 * It take care of updating its content according to Emotion event and provide a
28186 * way to theme itself. It also does automatically raise the priority of the
28187 * linked Elm_Video so it will use the video decoder if available. It also does
28188 * activate the remember function on the linked Elm_Video object.
28190 * Signals that you can add callback for are :
28192 * "forward,clicked" - the user clicked the forward button.
28193 * "info,clicked" - the user clicked the info button.
28194 * "next,clicked" - the user clicked the next button.
28195 * "pause,clicked" - the user clicked the pause button.
28196 * "play,clicked" - the user clicked the play button.
28197 * "prev,clicked" - the user clicked the prev button.
28198 * "rewind,clicked" - the user clicked the rewind button.
28199 * "stop,clicked" - the user clicked the stop button.
28201 * Default contents parts of the player widget that you can use for are:
28202 * @li "video" - A video of the player
28207 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28209 * @param parent The parent object
28210 * @return a new player widget handle or @c NULL, on errors.
28212 * This function inserts a new player widget on the canvas.
28214 * @see elm_object_content_part_set()
28218 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28221 * @brief Link a Elm_Payer with an Elm_Video object.
28223 * @param player the Elm_Player object.
28224 * @param video The Elm_Video object.
28226 * This mean that action on the player widget will affect the
28227 * video object and the state of the video will be reflected in
28228 * the player itself.
28230 * @see elm_player_add()
28231 * @see elm_video_add()
28232 * @deprecated use elm_object_content_part_set() instead
28236 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28239 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28241 * @param parent The parent object
28242 * @return a new video widget handle or @c NULL, on errors.
28244 * This function inserts a new video widget on the canvas.
28246 * @seeelm_video_file_set()
28247 * @see elm_video_uri_set()
28251 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28254 * @brief Define the file that will be the video source.
28256 * @param video The video object to define the file for.
28257 * @param filename The file to target.
28259 * This function will explicitly define a filename as a source
28260 * for the video of the Elm_Video object.
28262 * @see elm_video_uri_set()
28263 * @see elm_video_add()
28264 * @see elm_player_add()
28268 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28271 * @brief Define the uri that will be the video source.
28273 * @param video The video object to define the file for.
28274 * @param uri The uri to target.
28276 * This function will define an uri as a source for the video of the
28277 * Elm_Video object. URI could be remote source of video, like http:// or local source
28278 * like for example WebCam who are most of the time v4l2:// (but that depend and
28279 * you should use Emotion API to request and list the available Webcam on your system).
28281 * @see elm_video_file_set()
28282 * @see elm_video_add()
28283 * @see elm_player_add()
28287 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28290 * @brief Get the underlying Emotion object.
28292 * @param video The video object to proceed the request on.
28293 * @return the underlying Emotion object.
28297 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28300 * @brief Start to play the video
28302 * @param video The video object to proceed the request on.
28304 * Start to play the video and cancel all suspend state.
28308 EAPI void elm_video_play(Evas_Object *video);
28311 * @brief Pause the video
28313 * @param video The video object to proceed the request on.
28315 * Pause the video and start a timer to trigger suspend mode.
28319 EAPI void elm_video_pause(Evas_Object *video);
28322 * @brief Stop the video
28324 * @param video The video object to proceed the request on.
28326 * Stop the video and put the emotion in deep sleep mode.
28330 EAPI void elm_video_stop(Evas_Object *video);
28333 * @brief Is the video actually playing.
28335 * @param video The video object to proceed the request on.
28336 * @return EINA_TRUE if the video is actually playing.
28338 * You should consider watching event on the object instead of polling
28339 * the object state.
28343 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28346 * @brief Is it possible to seek inside the video.
28348 * @param video The video object to proceed the request on.
28349 * @return EINA_TRUE if is possible to seek inside the video.
28353 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28356 * @brief Is the audio muted.
28358 * @param video The video object to proceed the request on.
28359 * @return EINA_TRUE if the audio is muted.
28363 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28366 * @brief Change the mute state of the Elm_Video object.
28368 * @param video The video object to proceed the request on.
28369 * @param mute The new mute state.
28373 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28376 * @brief Get the audio level of the current video.
28378 * @param video The video object to proceed the request on.
28379 * @return the current audio level.
28383 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28386 * @brief Set the audio level of anElm_Video object.
28388 * @param video The video object to proceed the request on.
28389 * @param volume The new audio volume.
28393 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28395 EAPI double elm_video_play_position_get(const Evas_Object *video);
28396 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28397 EAPI double elm_video_play_length_get(const Evas_Object *video);
28398 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28399 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28400 EAPI const char *elm_video_title_get(const Evas_Object *video);
28406 * @defgroup Naviframe Naviframe
28407 * @ingroup Elementary
28409 * @brief Naviframe is a kind of view manager for the applications.
28411 * Naviframe provides functions to switch different pages with stack
28412 * mechanism. It means if one page(item) needs to be changed to the new one,
28413 * then naviframe would push the new page to it's internal stack. Of course,
28414 * it can be back to the previous page by popping the top page. Naviframe
28415 * provides some transition effect while the pages are switching (same as
28418 * Since each item could keep the different styles, users could keep the
28419 * same look & feel for the pages or different styles for the items in it's
28422 * Signals that you can add callback for are:
28423 * @li "transition,finished" - When the transition is finished in changing
28425 * @li "title,clicked" - User clicked title area
28427 * Default contents parts of the naviframe items that you can use for are:
28428 * @li "default" - A main content of the page
28429 * @li "icon" - A icon in the title area
28430 * @li "prev_btn" - A button to go to the previous page
28431 * @li "next_btn" - A button to go to the next page
28433 * Default text parts of the naviframe items that you can use for are:
28434 * @li "default" - Title label in the title area
28435 * @li "subtitle" - Sub-title label in the title area
28437 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28441 * @addtogroup Naviframe
28446 * @brief Add a new Naviframe object to the parent.
28448 * @param parent Parent object
28449 * @return New object or @c NULL, if it cannot be created
28451 * @ingroup Naviframe
28453 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28455 * @brief Push a new item to the top of the naviframe stack (and show it).
28457 * @param obj The naviframe object
28458 * @param title_label The label in the title area. The name of the title
28459 * label part is "elm.text.title"
28460 * @param prev_btn The button to go to the previous item. If it is NULL,
28461 * then naviframe will create a back button automatically. The name of
28462 * the prev_btn part is "elm.swallow.prev_btn"
28463 * @param next_btn The button to go to the next item. Or It could be just an
28464 * extra function button. The name of the next_btn part is
28465 * "elm.swallow.next_btn"
28466 * @param content The main content object. The name of content part is
28467 * "elm.swallow.content"
28468 * @param item_style The current item style name. @c NULL would be default.
28469 * @return The created item or @c NULL upon failure.
28471 * The item pushed becomes one page of the naviframe, this item will be
28472 * deleted when it is popped.
28474 * @see also elm_naviframe_item_style_set()
28475 * @see also elm_naviframe_item_insert_before()
28476 * @see also elm_naviframe_item_insert_after()
28478 * The following styles are available for this item:
28481 * @ingroup Naviframe
28483 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);
28485 * @brief Insert a new item into the naviframe before item @p before.
28487 * @param before The naviframe item to insert before.
28488 * @param title_label The label in the title area. The name of the title
28489 * label part is "elm.text.title"
28490 * @param prev_btn The button to go to the previous item. If it is NULL,
28491 * then naviframe will create a back button automatically. The name of
28492 * the prev_btn part is "elm.swallow.prev_btn"
28493 * @param next_btn The button to go to the next item. Or It could be just an
28494 * extra function button. The name of the next_btn part is
28495 * "elm.swallow.next_btn"
28496 * @param content The main content object. The name of content part is
28497 * "elm.swallow.content"
28498 * @param item_style The current item style name. @c NULL would be default.
28499 * @return The created item or @c NULL upon failure.
28501 * The item is inserted into the naviframe straight away without any
28502 * transition operations. This item will be deleted when it is popped.
28504 * @see also elm_naviframe_item_style_set()
28505 * @see also elm_naviframe_item_push()
28506 * @see also elm_naviframe_item_insert_after()
28508 * The following styles are available for this item:
28511 * @ingroup Naviframe
28513 EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28515 * @brief Insert a new item into the naviframe after item @p after.
28517 * @param after The naviframe item to insert after.
28518 * @param title_label The label in the title area. The name of the title
28519 * label part is "elm.text.title"
28520 * @param prev_btn The button to go to the previous item. If it is NULL,
28521 * then naviframe will create a back button automatically. The name of
28522 * the prev_btn part is "elm.swallow.prev_btn"
28523 * @param next_btn The button to go to the next item. Or It could be just an
28524 * extra function button. The name of the next_btn part is
28525 * "elm.swallow.next_btn"
28526 * @param content The main content object. The name of content part is
28527 * "elm.swallow.content"
28528 * @param item_style The current item style name. @c NULL would be default.
28529 * @return The created item or @c NULL upon failure.
28531 * The item is inserted into the naviframe straight away without any
28532 * transition operations. This item will be deleted when it is popped.
28534 * @see also elm_naviframe_item_style_set()
28535 * @see also elm_naviframe_item_push()
28536 * @see also elm_naviframe_item_insert_before()
28538 * The following styles are available for this item:
28541 * @ingroup Naviframe
28543 EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28545 * @brief Pop an item that is on top of the stack
28547 * @param obj The naviframe object
28548 * @return @c NULL or the content object(if the
28549 * elm_naviframe_content_preserve_on_pop_get is true).
28551 * This pops an item that is on the top(visible) of the naviframe, makes it
28552 * disappear, then deletes the item. The item that was underneath it on the
28553 * stack will become visible.
28555 * @see also elm_naviframe_content_preserve_on_pop_get()
28557 * @ingroup Naviframe
28559 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28561 * @brief Pop the items between the top and the above one on the given item.
28563 * @param it The naviframe item
28565 * @ingroup Naviframe
28567 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28569 * Promote an item already in the naviframe stack to the top of the stack
28571 * @param it The naviframe item
28573 * This will take the indicated item and promote it to the top of the stack
28574 * as if it had been pushed there. The item must already be inside the
28575 * naviframe stack to work.
28578 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28580 * @brief Delete the given item instantly.
28582 * @param it The naviframe item
28584 * This just deletes the given item from the naviframe item list instantly.
28585 * So this would not emit any signals for view transitions but just change
28586 * the current view if the given item is a top one.
28588 * @ingroup Naviframe
28590 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28592 * @brief preserve the content objects when items are popped.
28594 * @param obj The naviframe object
28595 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28597 * @see also elm_naviframe_content_preserve_on_pop_get()
28599 * @ingroup Naviframe
28601 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28603 * @brief Get a value whether preserve mode is enabled or not.
28605 * @param obj The naviframe object
28606 * @return If @c EINA_TRUE, preserve mode is enabled
28608 * @see also elm_naviframe_content_preserve_on_pop_set()
28610 * @ingroup Naviframe
28612 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28614 * @brief Get a top item on the naviframe stack
28616 * @param obj The naviframe object
28617 * @return The top item on the naviframe stack or @c NULL, if the stack is
28620 * @ingroup Naviframe
28622 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28624 * @brief Get a bottom item on the naviframe stack
28626 * @param obj The naviframe object
28627 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28630 * @ingroup Naviframe
28632 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28634 * @brief Set an item style
28636 * @param obj The naviframe item
28637 * @param item_style The current item style name. @c NULL would be default
28639 * The following styles are available for this item:
28642 * @see also elm_naviframe_item_style_get()
28644 * @ingroup Naviframe
28646 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28648 * @brief Get an item style
28650 * @param obj The naviframe item
28651 * @return The current item style name
28653 * @see also elm_naviframe_item_style_set()
28655 * @ingroup Naviframe
28657 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28659 * @brief Show/Hide the title area
28661 * @param it The naviframe item
28662 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28665 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28667 * @see also elm_naviframe_item_title_visible_get()
28669 * @ingroup Naviframe
28671 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28673 * @brief Get a value whether title area is visible or not.
28675 * @param it The naviframe item
28676 * @return If @c EINA_TRUE, title area is visible
28678 * @see also elm_naviframe_item_title_visible_set()
28680 * @ingroup Naviframe
28682 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28685 * @brief Set creating prev button automatically or not
28687 * @param obj The naviframe object
28688 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28689 * be created internally when you pass the @c NULL to the prev_btn
28690 * parameter in elm_naviframe_item_push
28692 * @see also elm_naviframe_item_push()
28694 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28696 * @brief Get a value whether prev button(back button) will be auto pushed or
28699 * @param obj The naviframe object
28700 * @return If @c EINA_TRUE, prev button will be auto pushed.
28702 * @see also elm_naviframe_item_push()
28703 * elm_naviframe_prev_btn_auto_pushed_set()
28705 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28707 * @brief Get a list of all the naviframe items.
28709 * @param obj The naviframe object
28710 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28711 * or @c NULL on failure.
28713 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);